從零搭建開發(fā)腳手架 基于Spring Task實現(xiàn)動態(tài)管理任務(wù)
本文轉(zhuǎn)載自微信公眾號「Java大廠面試官」，作者laker。轉(zhuǎn)載本文請聯(lián)系Java大廠面試官公眾號。
什么是定時任務(wù)
定時任務(wù)是指調(diào)度程序在指定的時間或周期觸發(fā)執(zhí)行的任務(wù)，常用場景如下：
- 定時發(fā)短信
- 定時變更數(shù)據(jù)
- 定時統(tǒng)計數(shù)據(jù)
- 定時修改狀態(tài)
- 定時開始活動等
常見幾種JAVA實現(xiàn)方式
Timer
簡介：Timer 是 Jdk自帶的定時任務(wù)執(zhí)行類，無論任何項目都可以直接使用 Timer 來實現(xiàn)定時任務(wù)，所以 Timer 的優(yōu)點就是使用方便。
原理：
- 調(diào)度器：單線程。
- 任務(wù)存儲：最小堆實現(xiàn)任務(wù)存儲。
優(yōu)點：Jdk自帶類，無需引入其他Jar，簡單易用。
缺點：Timer中的多個任務(wù)只能使用一個線程去執(zhí)行，因此任務(wù)之間的執(zhí)行情況會相互影響。
- 當(dāng)一個任務(wù)的執(zhí)行時間過長時，會影響其他任務(wù)的調(diào)度任務(wù)異常影響其他任務(wù)。
- 當(dāng)一個任務(wù)拋出異常，其他任務(wù)也會終止運(yùn)行.
結(jié)論：基本無人使用。
ScheduledExecutorService
簡介：ScheduledExecutorService 是JDK里面自定義的幾種線程池中的一種，支持多線程并發(fā)的去執(zhí)行多個調(diào)度任務(wù)，彌補(bǔ)了Timer的缺陷。
原理：
- 調(diào)度器：多線程。
- 任務(wù)存儲：最小堆實現(xiàn)任務(wù)存儲。
優(yōu)點：Timer能做到的事情ScheduledExecutorService都能做到，且完美的解決上面所說的Timer存在的兩個問題。
缺點：只支持固定速率(fixed-rate)或固定延遲(fixed-delay)的調(diào)度任務(wù)，不靈活。
結(jié)論：常用于框架內(nèi)部定時任務(wù)。
Spring Task
描述：Spring Framework 自帶的定時任務(wù)。
優(yōu)點：同ScheduledExecutorService，同時增加了支持cron表達(dá)式，可以配置任意基于時鐘的調(diào)度任務(wù)。
缺點：
- 不支持動態(tài)修改任務(wù)狀態(tài)、暫停/恢復(fù)任務(wù)，以及終止運(yùn)行中任務(wù)。
- 不支持在線監(jiān)控執(zhí)行的任務(wù)。
原理：ScheduledExecutorService的擴(kuò)展。
結(jié)論：常用于中小型企業(yè)，作為單機(jī)定時任務(wù)使用。
以上都是單機(jī)版本。
其他分布式定時任務(wù)諸如：quartz、xxl-job、elastic-job等等，功能、性能都很強(qiáng)勁，這里不作為研究對象，詳情參考：
- Java定時任務(wù)框架對比
- 定時任務(wù)實現(xiàn)原理 最小堆 時間輪
上面的這些框架都不是我想選擇的，要想自由的掌控雷電，那就自己造個簡易輪子，滿足90%需求即可。
期望實現(xiàn)如下特性：
- 輕量、輕量、輕量。
- 支持在線監(jiān)控執(zhí)行的任務(wù)。
- 支持動態(tài)修改任務(wù)狀態(tài)、暫停/恢復(fù)任務(wù)，以及終止運(yùn)行中任務(wù)。
- 支持在線配置調(diào)度任務(wù)入?yún)⒑汀?/li>
- 支持集群環(huán)境擴(kuò)展(可選)。
收集了半天信息，直接使用Spring Task就可以實現(xiàn)，僅依賴Spring Boot。
Spring Task詳解
初級靜態(tài)配置任務(wù)
代碼示例：
- @Component
- @EnableScheduling // 開啟定時任務(wù)
- public class DemoApplication {
- // 添加定時任務(wù)
- @Scheduled(cron = "0/5 * * * * *") // cron 表達(dá)式，每5秒執(zhí)行
- public void doTask(){
- System.out.println("我是定時任務(wù)~");
- }
- }
無法動態(tài)修改任務(wù)狀態(tài)、暫停/恢復(fù)任務(wù)，以及終止運(yùn)行中任務(wù)。
進(jìn)階動態(tài)配置任務(wù)
實現(xiàn)設(shè)計
關(guān)鍵技術(shù)點和坑
- Spring Task的調(diào)度器默認(rèn)是線程數(shù)為1的ThreadPoolTaskScheduler，自動裝配類為TaskSchedulingAutoConfiguration，多任務(wù)之間的執(zhí)行會相互影響，一定要修改默認(rèn)值。
- 通過TaskScheduler接口，可以擴(kuò)展實現(xiàn)動態(tài)修改任務(wù)狀態(tài)、暫停/恢復(fù)任務(wù)，以及終止運(yùn)行中任務(wù)。
- TaskScheuler是在Spring 3.0中引入的，有多種方法可以在將來的某個時刻運(yùn)行，它還返回ScheduledFuture接口的對象，可用于取消計劃的任務(wù)或檢查任務(wù)是否完成。
- cron-utils一個Java庫，用于解析，驗證Cron表達(dá)式，可以去GitHub查看詳細(xì)說明。
實現(xiàn)設(shè)計
定義IJob接口，用于客戶端描述任務(wù)
- public interface IJob {
- void execute(JobContext map) throws JobException;
- }
定義注解，用于配合IJob接口定義任務(wù)
- @Target({ElementType.TYPE})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- @Component
- public @interface Job {
- @AliasFor(annotation = Component.class)
- String value() default "";
- /**
- * cron 表達(dá)式默認(rèn)不"-"代表不執(zhí)行
- */
- String cron() default "-";
- /**
- * 任務(wù)編碼 必須唯一
- */
- String taskCode();
- /**
- * 任務(wù)名稱
- */
- String taskName();
- }
定義運(yùn)行任務(wù)狀態(tài)
- public class Task{
- /**
- * 任務(wù)的編碼 必須全局唯一
- */
- private String taskCode;
- /**
- * 任務(wù)的名稱
- */
- private String taskName;
- /**
- * 任務(wù)的類名稱
- */
- private String taskClassName;
- /**
- * 任務(wù)的cron表達(dá)式
- */
- private String taskCron;
- @JsonIgnore
- private ScheduledFuture scheduledFuture;
- @JsonIgnore
- private IJob job;
- private TaskStateEnum taskState;
定義任務(wù)存儲接口，用于存儲在緩存或者DB中
- public interface ITaskStore {
- void saveTask(Task task);
- List<Task> list();
- Task updateTaskByTaskCode(String taskCron, String taskName, String taskCode);
- Task updateTaskStateByTaskCode(TaskStateEnum taskState, String taskCode);
- void deleteTaskByTaskCode(String taskCode);
- Task findByTaskCode(String taskCode);
- }
定義任務(wù)鎖接口，解決并發(fā)問題，以及擴(kuò)展支持集群環(huán)境
- public interface ILockService {
- void lock(String taskCode);
- void unlock(String taskCode);
- }
定義事件監(jiān)聽器，用于監(jiān)聽任務(wù)的狀態(tài)事件，可擴(kuò)展?fàn)顟B(tài)監(jiān)控，各種回調(diào)等
- public interface IEventListener {
- void listener(Event event);
- }
核心處理器，處理核心流程
- 初始化加載所有IJob的實現(xiàn) 從Spring容器獲取IJob實現(xiàn)類并解析Job注解
- 添加任務(wù)threadPoolTaskScheduler.schedule(task,cron)
- 更新任務(wù)詳情
- scheduledFuture.cancel(true)
- threadPoolTaskScheduler.schedule(task,cron)
- 啟動任務(wù) threadPoolTaskScheduler.schedule(task,cron)
- 暫停任務(wù) scheduledFuture.cancel(true)
- 任務(wù)監(jiān)控 TaskList
待實現(xiàn)功能
- 重試補(bǔ)償：失敗重試。
- failstore : 存儲失敗任務(wù)，供人肉補(bǔ)償。
- misfire：存儲錯過的任務(wù)，供人肉補(bǔ)償。
自己在核心處理器中加下相應(yīng)的增強(qiáng)功能邏輯即可。
使用示例
直接實現(xiàn)IJob接口并加上Job注解即可
- @Job(taskCode = "job1", taskName = "laker測試任務(wù)",cron = "0/5 * * * * *")
- @Slf4j
- public class TestJob implements IJob {
- @Override
- public void execute(Map map) throws Exception {
- log.info("laker job run");
- TimeUnit.SECONDS.sleep(10);
- }
- }
全部代碼：https://gitee.com/lakernote/lakernote
參考：https://juejin.cn/post/6844904002606350343
SpringBoot官網(wǎng)
