前言
在做SpringBoot專案的過程中，有時客戶會提出按照指定時間執行一次業務的需求。
如果客戶需要改動業務的執行時間，即動態地調整定時任務的執行時間，那麼可以採用SpringBoot自帶的ScheduledTaskRegistrar類作為解決方案來實現。
在單一使用ScheduledTaskRegistrar類解決定時任務問題的時候，可能會達不到預期的動態調整定時任務的效果。
如果靈活配合使用對應的工具類（ThreadPoolTaskScheduler類），則可以方便地對動態調整定時任務進行管理。
本文會從問題出發，詳細介紹ScheduledTaskRegistrar類是如何解決動態調整定時任務的思路，並給出關鍵的程式碼示例，幫助大家快速地上手學習。
目錄
一、問題背景
-
在指定的某一時刻執行業務；
-
可以手動地更改執行時間。
在實際專案中，很少會有傻瓜式地去指定某一時間就觸發某個業務的場景，執行業務的時間不是一成不變的，而是動態地隨著客戶所指定的時間進行調整的。
二、痛點所在
如果單一地使用SpringBoot自帶的ScheduledTaskRegistrar去實現，那麼可能會有以下問題：
- 只能按照指定的時間去執行，更改執行時間需要重啟服務；
- 無法刪除該定時任務，或者刪除後無法再啟動新的定時任務。
- 業務邏輯與觸發器的程式碼耦合度太高，無法將業務程式碼從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 = () -> {
//需要執行的業務邏輯，一般會在這裡封裝好
logger.info("----------業務執行結束----------");
};
//任務的觸發時間，一般使用 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("---------->定時任務執行中<---------");
CronTrigger cronTrigger = new CronTrigger(cron);
nextExecTime = cronTrigger.nextExecutionTime(triggerContext);
} catch (Exception e) {
e.printStackTrace();
log.info(e.getMessage());
}
return nextExecTime;
};
taskRegistrar.addTriggerTask(taskOne, triggerOne);
}
}
上述程式碼只能實現在指定的時間去觸發定時任務，無法對 cron 表示式進行更改，如果更改則需要重新啟動服務，非常地“傻瓜”。
而在實際的編碼過程中，業務邏輯程式碼需要單獨地剝離開（解耦），如何做到業務邏輯程式碼和觸發器程式碼都能訪問到外部業務資料，是設計過程中需要考慮到的關鍵。
三、解決思路
//TODO:如果要在此處將業務邏輯和時間觸發器進行捆綁，那麼在這個實現類中無法獲取到來自該類外部的業務資料；
//TODO:要解決這樣的問題，就要找到一個辦法：既能將兩者抽離，又能實現靈活觸發定時任務。
在這裡介紹一個名為ThreadPoolTaskScheduler類，透過原始碼得知，該類實現了SchedulingTaskExecutor和TaskScheduler介面。
該類中schedule(Runnable task, Trigger trigger)方法，透過分別傳入執行緒任務（業務邏輯）和Trigger觸發器物件作為引數，支援動態建立指定 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物件作為引數傳入該靜態方法
* @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);
}
}
第二部分是關於結合實際業務，引入實際業務資料的程式碼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());
// 引入外部的業務資料物件
public void putHiredTask(CCCEntity cccEntity){
//TODO: 將業務執行緒和定時觸發器交由執行緒池工具管理：建立業務執行緒物件，並對屬性賦初始化值（有參構造）
TaskSchedulerUtil.put(new TaskThreadDemo(cccEntity,aaaMapper,bbbService), new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
//獲取定時觸發器，這裡可以獲取頁面的更新記錄，實現定時間隔的動態調整
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("-------定時任務執行中：" + cron + "--------");
CronTrigger cronTrigger = new CronTrigger(cron);
nextExecTime = cronTrigger.nextExecutionTime(triggerContext);
} catch (Exception e) {
e.printStackTrace();
log.info(e.getMessage());
}
return nextExecTime;
}
},"該定時任務的id");
}
}
五、文章小結
動態定時任務的總結如下：
- 單一使用ScheduledTaskRegistrar類，無法達到預期動態調整定時任務的效果；
- 實際的開發場景中，需要業務邏輯程式碼和觸發器程式碼都能訪問到外部業務資料；
- 配合ThreadPoolTaskScheduler類和該類中的schedule()方法可以達到動態調整定時任務的效果。
如果大家有遇到這樣類似的問題，並且為此感到困惑時，希望以上文章的介紹可以幫助到大家。
最後，歡迎大家的指正和交流！