Spring動態(tài)添加定時任務的實現(xiàn)思路

更新時間：2021年07月10日 10:37:12 作者：huan_1993

這篇文章主要介紹了Spring動態(tài)添加定時任務的實現(xiàn)思路，本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

一、背景

在工作中，有些時候我們有些定時任務的執(zhí)行可能是需要動態(tài)修改的，比如： 生成報表，有些項目配置每天的8點生成，有些項目配置每天的10點生成，像這種動態(tài)的任務執(zhí)行時間，在不考慮分布式執(zhí)行的情況下，我們可以
使用 Spring Task來簡單的實現(xiàn)。

二、需求和實現(xiàn)思路

1、能夠動態(tài)的添加一個定時任務。

在Spring中存在一個類ThreadPoolTaskScheduler,它可以實現(xiàn)根據(jù)一個cron表達式來調(diào)度一個任務，并返回一個ScheduledFuture對象。

可以看到返回值是ScheduledFuture對象

2、能夠取消定時任務的執(zhí)行。

通過調(diào)用上一步的ScheduledFuture的cancel方法，就可以將這個任務取消。

3、動態(tài)的修改任務執(zhí)行的時間。

先取消任務。然后在重新注冊一個任務。

4、獲取定時任務執(zhí)行的異常

ThreadPoolTaskScheduler類中有一個設置ErrorHandler的方法，給自己實現(xiàn)的ErrorHandler即可。

定時任務錯誤處理

提示：

在Spring中我們通過@Scheduled注解來實現(xiàn)的定時任務，底層也是通過ThreadPoolTaskScheduler來實現(xiàn)的?？梢酝ㄟ^ScheduledAnnotationBeanPostProcessor類來查看。
ThreadPoolTaskScheduler的默認線程數(shù)是1，這個需要根據(jù)實際的情況進行修改。

三、代碼實現(xiàn)

此處只給出動態(tài)注冊定時任務和取消的定時任務的代碼。

package com.huan.study.task.jobs.tasks;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.support.CronExpression;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;

/**
 * @author huan.fu 2021/7/8 - 下午2:46
 */
@Component
@Slf4j
public class DynamicCronTask implements InitializingBean {

    @Autowired
    private ThreadPoolTaskScheduler taskScheduler;


    private ScheduledFuture<?> scheduledFuture;

    @Override
    public void afterPropertiesSet() throws Exception {
        // 動態(tài)啟動一個定時任務
        log.info("注冊一個定時任務:每隔1秒執(zhí)行一次");
        scheduledFuture = register("* * * * * ?");

        // 取消一個調(diào)度
        new Thread(() -> {
            try {
                TimeUnit.SECONDS.sleep(5);
                log.info("取消調(diào)度");
                scheduledFuture.cancel(false);
                log.info("取消結(jié)果:" + scheduledFuture.isCancelled());
                log.info("重新注冊一個定時任務:每隔2秒執(zhí)行一次");
                register("*/2 * * * * ?");
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }).start();
    }

    private ScheduledFuture<?> register(String cron) {

        // 高版本使用 CronExpression，低版本使用 CronSequenceGenerator
        boolean validExpression = CronExpression.isValidExpression(cron);
        log.info("cron:[{}]是合法的嗎:[{}]", cron, validExpression);

        CronExpression expression = CronExpression.parse(cron);
        LocalDateTime nextExecTime = expression.next(LocalDateTime.now());
        if (null != nextExecTime) {
            log.info("定時任務下次執(zhí)行的時間為:[{}]", nextExecTime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        }

        return taskScheduler.schedule(new Runnable() {
            @Override
            public void run() {
                log.info("我執(zhí)行了");
            }
        }, new CronTrigger(cron));
    }
}