Spring Boot 創建定時任務（配合數據庫動態執行）

本文轉載自查看原文 2020-11-24 15:45 1297 工作中遇到的問題

序言：創建定時任務非常簡單，主要有兩種創建方式：一、基於注解(@Scheduled) 二、基於接口（SchedulingConfigurer）. 前者相信大家都很熟悉，但是實際使用中我們往往想從數據庫中讀取指定時間來動態執行定時任務，這時候基於接口的定時任務就大派用場了。

一、靜態定時任務（基於注解）

基於注解來創建定時任務非常簡單，只需幾行代碼便可完成。

@Scheduled 除了支持靈活的參數表達式cron之外，還支持簡單的延時操作，例如 fixedDelay ，fixedRate 填寫相應的毫秒數即可。

@Configuration //1.主要用於標記配置類，兼備Component的效果。
@EnableScheduling // 2.開啟定時任務
public class SimpleScheduleConfig {
    //3.添加定時任務
    @Scheduled(cron = "0/5 * * * * ?")
    private void configureTasks() {
        System.err.println("執行定時任務1: " + LocalDateTime.now());
    }
}

Cron表達式參數分別表示：
秒（0~59） 例如0/5表示每5秒
分（0~59）
時（0~23）
月的某天（0~31） 需計算
月（0~11）
周幾（ 可填1-7 或 SUN/MON/TUE/WED/THU/FRI/SAT）

　　啟動應用，可以看到控制台的信息如下：

誠然，使用Scheduled 確實很方便，但缺點是當我們調整了執行周期的時候，需要重啟應用才能生效，這多少有些不方便。為了達到實時生效的效果，可以使用接口來完成定時任務。

二、動態定時任務（基於接口）

為了演示效果，這里選用 Mysql數據庫和 Mybatis 來查詢和調整定時任務的執行周期，然后觀察定時任務的執行情況。

1.引入依賴

<!--依賴管理 -->
    <dependencies>
        <dependency><!--添加Web依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency><!--添加Mybatis依賴 -->
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency><!--添加MySql依賴 -->
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency><!--添加Test依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

2.添加數據庫記錄

在Navicat 連接本地數據庫，隨便打開查詢窗口，然后執行腳本內容，如下：

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

然后在項目中的application.yml 添加數據源：

#application.yml 配置如下：
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/socks?useSSL=false
    username: root
    password: root

3.創建定時器

數據庫准備好數據之后，我們編寫定時任務，注意這里添加的是TriggerTask，目的是循環讀取我們在數據庫設置好的執行周期，以及執行相關定時任務的內容。具體代碼如下：

@Configuration
@EnableScheduling
public class CompleteScheduleConfig implements SchedulingConfigurer {

    @Mapper
    public interface CronMapper {
        @Select("select cron from cron limit 1")
        String getCron();
    }

    @Autowired
    @SuppressWarnings("all")
    CronMapper cronMapper;

    /**
     * 執行定時任務.
     */
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.addTriggerTask(
                //1.添加任務內容(Runnable)
                () -> System.out.println("執行定時任務2: " + LocalDateTime.now().toLocalTime()),
                //2.設置執行周期(Trigger)
                triggerContext -> {
                    //2.1 從數據庫獲取執行周期
                    String cron = cronMapper.getCron();
                    //2.2 合法性校驗.
                    if (StringUtils.isEmpty(cron)) {
                        // Omitted Code ..
                    }
                    //2.3 返回執行周期(Date)
                    return new CronTrigger(cron).nextExecutionTime(triggerContext);
                }
        );
    }

}