SpringBoot?ScheduledTaskRegistrar解決動態(tài)定時任務思路詳解
前言
在做SpringBoot項目的過程中,有時客戶會提出按照指定時間執(zhí)行一次業(yè)務的需求。
如果客戶需要改動業(yè)務的執(zhí)行時間,即動態(tài)地調整定時任務的執(zhí)行時間,那么可以采用SpringBoot自帶的ScheduledTaskRegistrar類作為解決方案來實現。
在單一使用ScheduledTaskRegistrar類解決定時任務問題的時候,可能會達不到預期的動態(tài)調整定時任務的效果。
如果靈活配合使用對應的工具類(ThreadPoolTaskScheduler類),則可以方便地對動態(tài)調整定時任務進行管理。
本文會從問題出發(fā),詳細介紹ScheduledTaskRegistrar類是如何解決動態(tài)調整定時任務的思路,并給出關鍵的代碼示例,幫助大家快速地上手學習。
一、問題背景
在指定的某一時刻執(zhí)行業(yè)務;
可以手動地更改執(zhí)行時間。
在實際項目中,很少會有傻瓜式地去指定某一時間就觸發(fā)某個業(yè)務的場景,執(zhí)行業(yè)務的時間不是一成不變的,而是動態(tài)地隨著客戶所指定的時間進行調整的。
二、痛點所在
如果單一地使用SpringBoot自帶的ScheduledTaskRegistrar去實現,那么可能會有以下問題:
- 只能按照指定的時間去執(zhí)行,更改執(zhí)行時間需要重啟服務;
- 無法刪除該定時任務,或者刪除后無法再啟動新的定時任務。
- 業(yè)務邏輯與觸發(fā)器的代碼耦合度太高,無法將業(yè)務代碼從ScheduledTaskRegistrar類中抽離出去。
/** * @author Created by zhuzqc on 2023/1/30 15:28 */ @Slf4j @Component @EnableScheduling public class ScheduleTaskDemo implements SchedulingConfigurer { private Logger logger = LoggerFactory.getLogger(this.getClass()); @Override public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { //Runnable線程注冊任務 Runnable taskOne = () -> { //需要執(zhí)行的業(yè)務邏輯,一般會在這里封裝好 logger.info("----------業(yè)務執(zhí)行結束----------"); }; //任務的觸發(fā)時間,一般使用 cron 表達式 Trigger triggerOne = triggerContext -> { Date nextExecTime = null; try { // 此處指定 cron 表達式 String cron = "0 00 12 ? * *"; if (StringUtils.isBlank(cron)) { // 提示參數為空 logger.info("trigger定時器的 cron 參數為空!"); // 如果為空則賦默認值,每天中午12點 cron = "0 00 12 ? * *"; } logger.info("---------->定時任務執(zhí)行中<---------"); CronTrigger cronTrigger = new CronTrigger(cron); nextExecTime = cronTrigger.nextExecutionTime(triggerContext); } catch (Exception e) { e.printStackTrace(); log.info(e.getMessage()); } return nextExecTime; }; taskRegistrar.addTriggerTask(taskOne, triggerOne); } }
上述代碼只能實現在指定的時間去觸發(fā)定時任務,無法對 cron 表達式進行更改,如果更改則需要重新啟動服務,非常地“傻瓜”。
而在實際的編碼過程中,業(yè)務邏輯代碼需要單獨地剝離開(解耦),如何做到業(yè)務邏輯代碼和觸發(fā)器代碼都能訪問到外部業(yè)務數據,是設計過程中需要考慮到的關鍵。
三、解決思路
- TODO:如果要在此處將業(yè)務邏輯和時間觸發(fā)器進行捆綁,那么在這個實現類中無法獲取到來自該類外部的業(yè)務數據;
- TODO:要解決這樣的問題,就要找到一個辦法:既能將兩者抽離,又能實現靈活觸發(fā)定時任務。
在這里介紹一個名為ThreadPoolTaskScheduler類,通過源碼得知,該類實現了SchedulingTaskExecutor和TaskScheduler接口。
該類中schedule(Runnable task, Trigger trigger)方法,通過分別傳入線程任務(業(yè)務邏輯)和Trigger觸發(fā)器對象作為參數,支持動態(tài)創(chuàng)建指定 cron 表達式的定時任務。
該方法源碼如下:
@Override @Nullable public ScheduledFuture<?> schedule(Runnable task, Trigger trigger) { ScheduledExecutorService executor = getScheduledExecutor(); try { ErrorHandler errorHandler = this.errorHandler; if (errorHandler == null) { errorHandler = TaskUtils.getDefaultErrorHandler(true); } return new ReschedulingRunnable(task, trigger, this.clock, executor, errorHandler).schedule(); } catch (RejectedExecutionException ex) { throw new TaskRejectedException("Executor [" + executor + "] did not accept task: " + task, ex); } }
以下部分是對該方法的具體使用,核心思路如下 :
- 實例化ThreadPoolTaskScheduler類對象;
- 實例化ScheduledFuture類對象,用于初始化調用schedule()后的值。
- 將攜帶有Runnable和Trigger的ScheduledFuture類對象作為Map的value進行裝配。
- 根據Map的key對定時任務進行管理,達到添加和刪除的目的。
四、代碼示例
代碼示例分為兩部分:
第一部分是關于ThreadPoolTaskScheduler類和schedule()方法的使用;
/** * @author @author Created by zhuzqc on 2023/1/30 15:39 * 任務線程池管理工具 */ public class TaskSchedulerUtil { private static final Logger logger = LoggerFactory.getLogger(TaskSchedulerUtil.class); /** * 線程調度工具對象,作為該類的成員變量 */ private static ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler(); /** *初始化 map 對象,裝配 schedule 方法的返回對象為 value 值 */ private static Map<String, ScheduledFuture<?>> scheduledFutureMap = new HashMap<String, ScheduledFuture<?>>(); static { threadPoolTaskScheduler.initialize(); } /** * 將Runnable對象和Trigger對象作為參數傳入該靜態(tài)方法 * @param runnable * @param trigger * @param 定時任務id */ public static void put(Runnable runnable, Trigger trigger, String id) { // 將攜帶有Runnable和Trigger的ScheduledFuture類對象作為 Map 的 value 進行裝配 ScheduledFuture<?> scheduledFuture = threadPoolTaskScheduler.schedule(runnable, trigger); // 放入 Map 中作為 value scheduledFutureMap.put(id, scheduledFuture); logger.info("---添加定時任務--->" + id); } /** * 通過上述 put 方法的參數id(定時任務id)標識,將定時任務移除出 map * @param id */ public static void delete(String id) { ScheduledFuture<?> scheduledFuture = scheduledFutureMap.get(id); // 條件判斷 if (scheduledFuture != null && scheduledFuture.isCancelled()) { scheduledFuture.cancel(true); } scheduledFutureMap.remove(id); logger.info("---取消定時任務--->" + id); } }
第二部分是關于結合實際業(yè)務,引入實際業(yè)務數據的代碼demo。
/** * @author Created by zhuzqc on 2023/1/30 15:58 */ @Slf4j @Component @EnableScheduling public class TaskScheduleDemo{ @Resource private AAAMapper aaaMapper; @Resource private BBBService bbbService; private Logger logger = LoggerFactory.getLogger(this.getClass()); // 引入外部的業(yè)務數據對象 public void putHiredTask(CCCEntity cccEntity){ //TODO: 將業(yè)務線程和定時觸發(fā)器交由線程池工具管理:創(chuàng)建業(yè)務線程對象,并對屬性賦初始化值(有參構造) TaskSchedulerUtil.put(new TaskThreadDemo(cccEntity,aaaMapper,bbbService), new Trigger() { @Override public Date nextExecutionTime(TriggerContext triggerContext) { //獲取定時觸發(fā)器,這里可以獲取頁面的更新記錄,實現定時間隔的動態(tài)調整 Date nextExecTime = TaskTransUtils.StringToDateTime(cccEntity.getSendTime()); //cron 表達式轉換工具類 String cron = TaskTransUtils.getDateCronTime(nextExecTime); try { if (StringUtils.isBlank(cron)) { // 提示參數為空 logger.info("trackScheduler定時器的 cron 參數為空!"); // 如果為空則賦默認值,每天早上9:00 cron = "0 00 09 ? * *"; } logger.info("-------定時任務執(zhí)行中:" + cron + "--------"); CronTrigger cronTrigger = new CronTrigger(cron); nextExecTime = cronTrigger.nextExecutionTime(triggerContext); } catch (Exception e) { e.printStackTrace(); log.info(e.getMessage()); } return nextExecTime; } },"該定時任務的id"); } }
五、文章小結
動態(tài)定時任務的總結如下:
- 單一使用ScheduledTaskRegistrar類,無法達到預期動態(tài)調整定時任務的效果;
- 實際的開發(fā)場景中,需要業(yè)務邏輯代碼和觸發(fā)器代碼都能訪問到外部業(yè)務數據;
- 配合ThreadPoolTaskScheduler類和該類中的schedule()方法可以達到動態(tài)調整定時任務的效果。
以上就是SpringBoot ScheduledTaskRegistrar解決動態(tài)定時任務思路詳解的詳細內容,更多關于SpringBoot ScheduledTaskRegistrar的資料請關注腳本之家其它相關文章!
相關文章
Springboot解決跨域問題方案總結(包括Nginx,Gateway網關等)
跨域問題是瀏覽器為了保護用戶的信息安全,實施了同源策略(Same-Origin?Policy),即只允許頁面請求同源(相同協(xié)議、域名和端口)的資源,本文給大家總結了Springboot解決跨域問題方案包括Nginx,Gateway網關等),需要的朋友可以參考下2024-03-03JAVA 多態(tài)操作----父類與子類轉換問題實例分析
這篇文章主要介紹了JAVA 多態(tài)操作----父類與子類轉換問題,結合實例形式分析了JAVA 多態(tài)操作中父類與子類轉換問題相關原理、操作技巧與注意事項,需要的朋友可以參考下2020-05-05在Mac OS上安裝Java以及配置環(huán)境變量的基本方法
這篇文章主要介紹了在Mac OS上安裝Java以及配置環(huán)境變量的基本方法,包括查看所安裝Java版本的方法,需要的朋友可以參考下2015-10-10詳解Spring Data JPA動態(tài)條件查詢的寫法
本篇文章主要介紹了Spring Data JPA動態(tài)條件查詢的寫法 ,小編覺得挺不錯的,現在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-06-06