ShedLock的4种使用方式(分布式定时任务锁)

素颜马尾好姑娘i 2023-09-29 14:48 34阅读 0赞

### 文章目录 ###

*   *  一、 简介
     *   *  1、@Scheduled定时器
     *  二、cron表达式
     *  三、静态：基于注解
     *   *  1、创建定时器
         *  2、启动测试
     *  四、动态：基于接口，从数据库获取
     *   *  1、导入依赖包：
         *  2、添加数据库记录：
         *  3、创建定时器
         *  4、启动测试
     *  五、多线程定时任务
     *   *  1、创建多线程定时任务
         *  2、启动测试
     *  六、分布式单任务启动
     *   *  1、建表语句
         *  2、pom.xml
         *  3、定时任务代码

--------------------

## 一、 简介 ##

使用SpringBoot创建定时任务非常简单，目前主要有以下三种创建方式：

*  基于注解(@Scheduled)
 *  基于接口（SchedulingConfigurer） 前者相信大家都很熟悉，但是实际使用中我们往往想从数据库中读取指定时间来动态执行定时任务，这时候基于接口的定时任务就派上用场了。原理就是每次都从数据库中查询出执行的时间间隔，把间隔加入到下次的执行中。**（更换执行的间隔，只需要更改数据库就行，不需要再启动服务；）**
 *  基于注解设定多线程定时任务
 *  分布式任务锁

### 1、@Scheduled定时器 ###

*  `cron`

//cron表达式
    //每天早上9点-晚上21点间执行，每次执行间隔一分钟
    @Scheduled(cron = "0 0/1 9-21 * * ?")

*  `fixedRate`

//上一次开始执行时间点之后5秒再执行
    @Scheduled(fixedRate = 5000)

*  `fixedDelay`

//上一次执行完毕时间点之后5秒再执行
    @Scheduled(fixedDelay = 5000)

## 二、cron表达式 ##

Cron表达式参数分别表示：

*  秒（0~59） 例如0/5表示每5秒
 *  分（0~59）
 *  时（0~23）
 *  日（0~31）的某天，需计算
 *  月（0~11）
 *  周几（ 可填1-7 或 SUN/MON/TUE/WED/THU/FRI/SAT）

## 三、静态：基于注解 ##

基于注解@Scheduled默认为单线程，开启多个任务时，任务的执行时机会受上一个任务执行时间的影响，上一个线程不执行完成，下一个不会执行。

*  执行完上一个，才会执行下一个。
 *  只会开启单个线程执行。
 *  会造成任务积压。

### 1、创建定时器 ###

使用SpringBoot基于注解来创建定时任务非常简单，只需几行代码便可完成。 代码如下：

@Configuration      //1.主要用于标记配置类，兼备Component的效果。
    @EnableScheduling   // 2.开启定时任务
    public class SaticScheduleTask {
        
        //3.添加定时任务
        @Scheduled(cron = "0/5 * * * * ?")
        //或直接指定时间间隔，例如：5秒
        //@Scheduled(fixedRate=5000)
        private void configureTasks() {
        
            System.err.println("执行静态定时任务时间: " + LocalDateTime.now());
        }
    }

@Scheduled：除了支持灵活的参数表达式cron之外，还支持简单的延时操作，例如 fixedDelay ，fixedRate 填写相应的毫秒数即可。

### 2、启动测试 ###

启动应用，可以看到控制台打印出如下信息：  
![在这里插入图片描述][20200106145459684.png]  
显然，使用@Scheduled 注解很方便，但缺点是当我们调整了执行周期的时候，需要重启应用才能生效，这多少有些不方便。为了达到实时生效的效果，可以使用接口来完成定时任务。

## 四、动态：基于接口，从数据库获取 ##

基于接口（SchedulingConfigurer）

### 1、导入依赖包： ###

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.0.4.RELEASE</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                 <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.1</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.4.5</version>
                <scope>compile</scope>
            </dependency>
        </dependencies>

### 2、添加数据库记录： ###

开启本地数据库mysql，随便打开查询窗口，然后执行脚本内容，如下：

DROP DATABASE IF EXISTS `socks`;
    CREATE DATABASE `socks`;
    USE `SOCKS`;
    DROP TABLE IF EXISTS `cron`;
    CREATE TABLE `cron`  (
      `cron_id` varchar(30) NOT NULL PRIMARY KEY,
      `cron` varchar(30) NOT NULL  
    );
    INSERT INTO `cron` VALUES ('1', '0/5 * * * * ?');

![在这里插入图片描述][20200106145516697.png]

然后在项目中的application.yml 添加数据源：

spring:
      datasource:
        url: jdbc:mysql://localhost:3306/socks
        username: root
        password: 123456

### 3、创建定时器 ###

数据库准备好数据之后，我们编写定时任务，注意这里添加的是TriggerTask，目的是循环读取我们在数据库设置好的执行周期，以及执行相关定时任务的内容。  
具体代码如下：

@Configuration      //1.主要用于标记配置类，兼备Component的效果。
    @EnableScheduling   // 2.开启定时任务
    public class DynamicScheduleTask implements SchedulingConfigurer {
        
    
        @Mapper
        public interface CronMapper {
        
            @Select("select cron from cron limit 1")
            public String getCron();
        }
    
        @Autowired      //注入mapper
        @SuppressWarnings("all")
        CronMapper cronMapper;
    
        /**
         * 执行定时任务.
         */
        @Override
        public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        
    
            taskRegistrar.addTriggerTask(
                    //1.添加任务内容(Runnable)
                    () -> System.out.println("执行动态定时任务: " + LocalDateTime.now().toLocalTime()),
                    //2.设置执行周期(Trigger)
                    triggerContext -> {
        
                        //2.1 从数据库获取执行周期
                        //String cron = "0/5 * * * * ?";
                        String cron = cronMapper.getCron();
                        //2.2 合法性校验.
                        if (StringUtils.isEmpty(cron)) {
        
                            // Omitted Code ..
                        }
                        //2.3 返回执行周期(Date)
                        return new CronTrigger(cron).nextExecutionTime(triggerContext);
                    }
            );
        }
    
    }

### 4、启动测试 ###

启动应用后，查看控制台，打印时间是我们预期的每10秒一次：  
![在这里插入图片描述][20200106145531706.png]

然后打开Navicat ，将执行周期修改为每6秒执行一次，如图：  
![在这里插入图片描述][20200106145540745.png]

查看控制台，发现执行周期已经改变，并且不需要我们重启应用，十分方便。如图：  
![在这里插入图片描述][20200106145549672.png]

注意： 如果在数据库修改时格式出现错误，则定时任务会停止，即使重新修改正确；此时只能重新启动项目才能恢复。

## 五、多线程定时任务 ##

基于注解设定多线程定时任务

### 1、创建多线程定时任务 ###

package com.lydms.shedlockdmo.job;
    
    import org.springframework.scheduling.annotation.Async;
    import org.springframework.scheduling.annotation.EnableAsync;
    import org.springframework.scheduling.annotation.EnableScheduling;
    import org.springframework.scheduling.annotation.Scheduled;
    import org.springframework.stereotype.Component;
    
    import java.time.LocalDateTime;
    
    //@Component注解用于对那些比较中立的类进行注释；
    //相对与在持久层、业务层和控制层分别采用 @Repository、@Service 和 @Controller 对分层中的类进行注释
    @Component
    @EnableScheduling   // 1.开启定时任务
    @EnableAsync        // 2.开启多线程
    public class MultithreadScheduleTask {
        
    
        @Async
        @Scheduled(fixedDelay = 1000)  //间隔1秒
        public void first() throws InterruptedException {
        
            System.out.println("第一个定时任务开始 : " + LocalDateTime.now().toLocalTime() + "\r\n线程 : " + Thread.currentThread().getName());
            System.out.println();
            Thread.sleep(1000 * 10);
        }
    
        @Async
        @Scheduled(fixedDelay = 2000)
        public void second() {
        
            System.out.println("第二个定时任务开始 : " + LocalDateTime.now().toLocalTime() + "\r\n线程 : " + Thread.currentThread().getName());
            System.out.println();
        }
    }

**注：** 这里的 **@Async**注解很关键

### 2、启动测试 ###

启动应用后，查看控制台：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDYyNDExNw_size_16_color_FFFFFF_t_70]

从控制台可以看出，第一个定时任务和第二个定时任务互不影响；

并且，由于开启了多线程，第一个任务的执行时间也不受其本身执行时间的限制，所以需要注意可能会出现重复操作导致数据异常。

## 六、分布式单任务启动 ##

会根据字段中`@SchedulerLock(name = "personalJob")`，`personalJob`数据库中，存储的这个字段，以这个字段为key，进行是否多个依赖的判断。

![在这里插入图片描述][0f88ba61b6394aab8afd367ce903e97b.png]

### 1、建表语句 ###

CREATE TABLE `shedlock` (
      `name` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
      `lock_until` timestamp(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3) ON UPDATE CURRENT_TIMESTAMP(3),
      `locked_at` timestamp(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
      `locked_by` varchar(255) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
      PRIMARY KEY (`name`) USING BTREE
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='定时任务同步锁';

### 2、pom.xml ###

<dependency>
        <groupId>net.javacrumbs.shedlock</groupId>
        <artifactId>shedlock-spring</artifactId>
        <version>4.20.0</version>
    </dependency>
    <dependency>
        <groupId>net.javacrumbs.shedlock</groupId>
        <artifactId>shedlock-provider-jdbc-template</artifactId>
        <version>4.20.0</version>
    </dependency>

### 3、定时任务代码 ###

package com.lydms.shedlockdmo.job;
    
    import net.javacrumbs.shedlock.spring.annotation.SchedulerLock;
    import org.springframework.scheduling.annotation.EnableScheduling;
    import org.springframework.scheduling.annotation.Scheduled;
    import org.springframework.stereotype.Component;
    
    import java.time.LocalDateTime;
    
    @Component
    @EnableScheduling
    public class OneJob {
        
    
        @Scheduled(cron = "* * * * * ?")
        @SchedulerLock(name = "personalCustomerJob")
        public void personalCustomerJob() throws InterruptedException {
        
    
            String name = Thread.currentThread().getName();
            System.out.println("==="+name+"======"+ LocalDateTime.now()+"======");
            Thread.sleep(2000);
        }
    }

[20200106145459684.png]: https://img-blog.csdnimg.cn/20200106145459684.png
[20200106145516697.png]: https://img-blog.csdnimg.cn/20200106145516697.png
[20200106145531706.png]: https://img-blog.csdnimg.cn/20200106145531706.png
[20200106145540745.png]: https://img-blog.csdnimg.cn/20200106145540745.png
[20200106145549672.png]: https://img-blog.csdnimg.cn/20200106145549672.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDYyNDExNw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200106145600220.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDYyNDExNw==,size_16,color_FFFFFF,t_70
[0f88ba61b6394aab8afd367ce903e97b.png]: https://img-blog.csdnimg.cn/0f88ba61b6394aab8afd367ce903e97b.png