簡介

定時任務是後端開發中常見的需求，主要應用場景有定期資料報表、定時訊息通知、非同步的後臺業務邏輯處理、日誌分析處理、垃圾資料清理、定時更新快取等等。

Spring Boot 集成了一整套的定時任務工具，讓我們專注於完成邏輯，剩下的基礎排程工作將自動完成。

通用實現方式

靜態定時任務

@Component
@EnableScheduling
public class StaticScheduleJob {
    
    /**
     * 上次開始執行時間點後5秒再次執行
     */
    @Scheduled(fixedRate = 5000)
    public void job3() {
        System.out.println("執行任務job3："+DateUtil.formatDateTime(new Date()));
    }
    
    /**
     * 上次執行完畢時間點後3秒再次執行
     */
    @Scheduled(fixedDelay = 3000)
    public void job2() {
        System.out.println("執行任務job2："+DateUtil.formatDateTime(new Date()));
    }
    
    /**
     * 每隔10秒執行一次（按照 corn 表示式規則執行）
     */
    @Scheduled(cron = "0/10 * * * * ?")
    public void job1() {
        System.out.println("執行任務job1："+DateUtil.formatDateTime(new Date()));
    }

    
}
 

@EnableScheduling 註解啟用定時調動功能

@Scheduled 引數說明：

• @Scheduled(fixedRate = 5000)：上次開始執行時間點後5秒再次執行
• @Scheduled(fixedDelay = 3000)：上次執行完畢時間點後3秒再次執行
• @Scheduled(cron = "0/10 * * * * ?")：每隔10秒執行一次（按照 corn 表示式規則執行）

Cron 表示式

1.Cron表示式格式

{秒} {分} {時} {日} {月} {周} {年(可選)}

2.Cron 表示式欄位取值範圍及說明

3.Cron 表示式中特殊字元的意義

4.Cron 線上生成工具

http://www.bejson.com/othertools/cron/

動態定時任務

1.實現 SchedulingConfigurer 介面

@Configuration
public class CustomScheduleConfig implements SchedulingConfigurer {

    @Autowired
    private CronTriggerDao cronTriggerDao;

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        // 上次開始執行時間點後5秒再執行
        taskRegistrar.addFixedRateTask(() -> System.out.println("CustomScheduleConfig執行任務job1=>"
                + DateUtil.formatDateTime(new Date()) + ",執行緒：" + Thread.currentThread().getName()), 5000);
        // 上次執行完畢時間點後3秒再執行
        taskRegistrar.addFixedDelayTask(() -> System.out.println("CustomScheduleConfig執行任務job2=>"
                + DateUtil.formatDateTime(new Date()) + ",執行緒：" + Thread.currentThread().getName()), 3000);
        // 新增一個配合資料庫動態執行的定時任務
        TriggerTask triggerTask = new TriggerTask(
                // 任務內容.拉姆達表示式
                () -> {
                    // 1）新增任務 Runnable
                    System.out.println("CustomScheduleConfig執行動態任務job3=>" + DateUtil.formatDateTime(new Date()) + ",執行緒："
                            + Thread.currentThread().getName());
                    // 2）設定執行週期
                }, triggerContext -> {
                    // 3）從資料庫獲取執行週期
                    String cron = cronTriggerDao.getCronTriggerById(1L);
                    if (cron != null) {
                        // 4）返回執行週期（Date）
                        return new CronTrigger(cron).nextExecutionTime(triggerContext);
                    } else {
                        return null;
                    }

                });
        taskRegistrar.addTriggerTask(triggerTask);

    }

}

2.資料庫中初始化資料

這邊為了測試簡單初始化兩行資料：

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for t_cron_trigger
-- ----------------------------
DROP TABLE IF EXISTS `t_cron_trigger`;
CREATE TABLE `t_cron_trigger` (
  `id` int(8) NOT NULL AUTO_INCREMENT COMMENT '任務id',
  `cron` varchar(20) COLLATE utf8_bin DEFAULT NULL COMMENT 'cron表示式',
  `create_time` datetime DEFAULT NULL COMMENT '建立時間',
  `update_time` datetime DEFAULT NULL COMMENT '更新時間',
  `is_deleted` int(1) DEFAULT '0' COMMENT '作廢狀態 0-否 1-是',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8 COLLATE=utf8_bin;

-- ----------------------------
-- Records of t_cron_trigger
-- ----------------------------
BEGIN;
INSERT INTO `t_cron_trigger` VALUES (1, '0/10 * * * * ?', '2019-10-30 13:40:14', NULL, 0);
INSERT INTO `t_cron_trigger` VALUES (2, '0/7 * * * * ?', '2019-10-30 13:40:34', NULL, 0);
COMMIT;

SET FOREIGN_KEY_CHECKS = 1;

3.從資料庫中讀取 cron 表示式值

CronTrigger 實體類

public class CronTrigger implements Serializable{

    /**
     * 
     */
    private static final long serialVersionUID = 880141459783509786L;
    
    private Long id;//任務id
    private String cron;//cron表示式
    private String createTime;//建立時間
    private String updateTime;//更新時間
    private boolean isDeleted=false;//刪除狀態
    
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getCron() {
        return cron;
    }
    public void setCron(String cron) {
        this.cron = cron;
    }
    public String getCreateTime() {
        return createTime;
    }
    public void setCreateTime(String createTime) {
        this.createTime = createTime;
    }
    public String getUpdateTime() {
        return updateTime;
    }
    public void setUpdateTime(String updateTime) {
        this.updateTime = updateTime;
    }
    public boolean isDeleted() {
        return isDeleted;
    }
    public void setDeleted(boolean isDeleted) {
        this.isDeleted = isDeleted;
    }
}

CronTriggerDao

public interface CronTriggerDao {
    /**
     * 根據id獲取cron表示式
     * @param id
     * @return
     */
    String getCronTriggerById(Long id);

}

CronTriggerMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.4//EN" 
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.zwqh.springboot.dao.CronTriggerDao">
    <resultMap type="cn.zwqh.springboot.model.CronTrigger" id="cronTrigger">
        <id property="id" column="id"/>
        <result property="cron" column="cron"/>
        <result property="createTime" column="create_time"/>
        <result property="updateTime" column="update_time"/>
        <result property="isDeleted" column="is_deleted"/>
    </resultMap>
    <!-- 根據id獲取cron表示式 -->
    <select id="getCronTriggerById" resultType="String">
        select cron from t_cron_trigger where is_deleted=0 and id=#{id}
    </select>
</mapper>

4.測試

啟動前記得在啟動類上加上 @EnableScheduling

列印日誌如下：

多執行緒定時任務

通過上面的日誌我們可以看到任務執行都是單執行緒的。如果要實現多執行緒執行任務，我們可以通過在 SchedulingConfigurer 介面的 configureTasks方法中新增執行緒池即可。

1.CustomScheduleConfig

@Configuration
public class CustomScheduleConfig implements SchedulingConfigurer {

    @Autowired
    private CronTriggerDao cronTriggerDao;

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        
        //設定一個長度為10的定時任務執行緒池
        taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));
        
        // 上次開始執行時間點後5秒再執行
        taskRegistrar.addFixedRateTask(() -> System.out.println("CustomScheduleConfig執行任務job1=>"
                + DateUtil.formatDateTime(new Date()) + ",執行緒：" + Thread.currentThread().getName()), 5000);
        // 上次執行完畢時間點後3秒再執行
        taskRegistrar.addFixedDelayTask(() -> System.out.println("CustomScheduleConfig執行任務job2=>"
                + DateUtil.formatDateTime(new Date()) + ",執行緒：" + Thread.currentThread().getName()), 3000);
        // 新增第一個配合資料庫動態執行的定時任務
        TriggerTask triggerTask = new TriggerTask(
                // 任務內容.拉姆達表示式
                () -> {
                    // 1）新增任務 Runnable
                    System.out.println("CustomScheduleConfig執行動態任務job3=>" + DateUtil.formatDateTime(new Date()) + ",執行緒："
                            + Thread.currentThread().getName());
                    // 2）設定執行週期
                }, triggerContext -> {
                    // 3）從資料庫獲取執行週期
                    String cron = cronTriggerDao.getCronTriggerById(1L);
                    if (cron != null) {
                        // 4）返回執行週期（Date）
                        return new CronTrigger(cron).nextExecutionTime(triggerContext);
                    } else {
                        return null;
                    }

                });
        taskRegistrar.addTriggerTask(triggerTask);
        // 新增第二個配合資料庫動態執行的定時任務
        TriggerTask triggerTask2 = new TriggerTask(
                // 任務內容.拉姆達表示式
                () -> {
                    // 1）新增任務 Runnable
                    System.out.println("CustomScheduleConfig執行動態任務job4=>" + DateUtil.formatDateTime(new Date()) + ",執行緒："
                            + Thread.currentThread().getName());
                    // 2）設定執行週期
                }, triggerContext -> {
                    // 3）從資料庫獲取執行週期
                    String cron = cronTriggerDao.getCronTriggerById(2L);
                    if (cron != null) {
                        // 4）返回執行週期（Date）
                        return new CronTrigger(cron).nextExecutionTime(triggerContext);
                    } else {
                        return null;
                    }

                });
        taskRegistrar.addTriggerTask(triggerTask2);

    }

}

2.測試

列印日誌如下：

示例程式碼

github

碼雲

非特殊說明，本文版權歸 朝霧輕寒 所有，轉載請註明出處.

原文標題：Spring Boot 2.X(十二)：定時任務

原文地址：https://www.zwqh.top/article/info/21

如果文章對您有幫助，請掃碼關注下我的公眾號，文章持續更新中...