spring動態(tài)控制定時任務的實現(xiàn)
在spring框架中，對于簡單的定時任務，可以使用 @Scheduled 注解實現(xiàn)，在實際項目中，經(jīng)常需要動態(tài)的控制定時任務，比如通過接口增加、啟動、停止、刪除定時任務，動態(tài)的改變定時任務的執(zhí)行時間等。
我們可以通過編碼的方式動態(tài)控制定時任務，具體的代碼參照 示例項目 https://github.com/qihaiyan/springcamp/tree/master/spring-dynamic-scheduler
一、概述
在spring框架可以通過 CronTask 和 TaskScheduler 動態(tài)控制定時任務，實現(xiàn)定時任務的動態(tài)更新，比如修改定時任務的執(zhí)行時間，這個是 @Scheduled 無法實現(xiàn)的。采用編碼控制動態(tài)任務的方式，我們還可以把動態(tài)任務執(zhí)行信息保存到數(shù)據(jù)庫中，通過數(shù)據(jù)庫里的任務配置數(shù)據(jù)來動態(tài)控制定時任務，也可以通過接口來動態(tài)控制定時任務。
二、配置定時任務
首先，同 @Scheduled 注解的方式一樣，動態(tài)控制定時任務也需要使用 @EnableScheduling 注解來開啟定時任務功能：
然后通過實現(xiàn) SchedulingConfigurer 接口來對動態(tài)任務進行配置：
@Component
public class MyScheduler implements SchedulingConfigurer {
private ScheduledTaskRegistrar taskRegistrar;
private final ConcurrentHashMap<Long, ScheduledFuture<?>> scheduledFutures = new ConcurrentHashMap<>();
@Override
public void configureTasks(@NonNull ScheduledTaskRegistrar taskRegistrar) {
ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
threadPoolTaskScheduler.setPoolSize(10);// Set the pool of threads
threadPoolTaskScheduler.setThreadNamePrefix("sys-scheduler");
threadPoolTaskScheduler.initialize();
this.taskRegistrar = taskRegistrar;
this.taskRegistrar.setTaskScheduler(threadPoolTaskScheduler);
}
@PreDestroy
public void destroy() {
this.taskRegistrar.destroy();
}
}
通過上面的代碼，我們就啟用了動態(tài)任務的基本能力，為動態(tài)任務指定了執(zhí)行線程池。
三、動態(tài)更新定時任務
更新定時任務通過 CronTask 和 TaskScheduler 來實現(xiàn)，我們新增一個注冊定時任務的方法：
public void registerTask(TaskData taskData) {
//如果配置一致，則不需要重新創(chuàng)建定時任務
if (scheduledFutures.containsKey(taskData.getId())
&& cronTasks.get(taskData.getId()).getExpression().equals(taskData.getExpression())) {
return;
}
//如果策略執(zhí)行時間發(fā)生了變化，則取消當前策略的任務
if (scheduledFutures.containsKey(taskData.getId())) {
scheduledFutures.remove(taskData.getId()).cancel(false);
cronTasks.remove(taskData.getId());
}
CronTask task = new CronTask(taskData, taskData.getExpression());
TaskScheduler scheduler = taskRegistrar.getScheduler();
if (scheduler != null) {
ScheduledFuture<?> future = scheduler.schedule(task.getRunnable(), task.getTrigger());
if (future != null) {
scheduledFutures.put(taskData.getId(), future);
}
}
}
我們新增了一個 registerTask 方法用于注冊定時任務，入?yún)⒅?TaskData 是定時任務的配置數(shù)據(jù)，為了簡單，我們把配置數(shù)據(jù)和執(zhí)行代碼放到了一起：
@Slf4j
@Data
@Entity
public class TaskData implements Runnable {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String name;
private String expression;
@Transient
@Override
public void run() {
log.info("{} is running with expression {}", this.getName(), this.getExpression());
}
}
核心代碼是創(chuàng)建一個 CronTask 對象，該對象包含兩個參數(shù)：Runnable 方法和 cron 表達式。
CronTask 對象創(chuàng)建好后，通過 ScheduledTaskRegistrar 對定時任務進行注冊，注冊完成后，定時任務就會在cron表達式指定的時間點開始執(zhí)行了。
執(zhí)行的代碼就是 Runnable 參數(shù)指定的方法。
四、動態(tài)停止定時任務
為了能夠動態(tài)停止定時任務，我們在注冊定時任務時，把注冊結(jié)果放到了一個Map中：
private final ConcurrentHashMap<Long, ScheduledFuture<?>> scheduledFutures = new ConcurrentHashMap<>();
ScheduledFuture<?> future = scheduler.schedule(task.getRunnable(), task.getTrigger());
if (future != null) {
scheduledFutures.put(taskData.getId(), future);
}
新增停止定時任務的方法：
public void stop(Long id) {
if (scheduledFutures.containsKey(id)) {
scheduledFutures.remove(id).cancel(false);
}
}
該方法需要傳入定時任務的id，由于我們把定時任務信息保存到了 scheduledFutures 這個Map中，所以可以根據(jù)任務id參數(shù)查找到對應的定時任務信息，然后調(diào)用對應的 cancel方法來停止定時任務。
五、通過接口控制定時任務
通過上面的步驟我們已經(jīng)具備了動態(tài)控制定時任務的基本能力，下面增加接口來控制定時任務：
@EnableScheduling
@SpringBootApplication
@RestController
public class DemoApplication {
@Autowired
private MyScheduler myScheduler;
@Autowired
private TaskDataRepository taskDataRepository;
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@RequestMapping("/register")
public TaskData register(
String name,
@RequestParam(name = "expression", required = false, defaultValue = "0/1 * * * * ?") String expression
) {
TaskData taskData = taskDataRepository.findOneByName(name).orElse(new TaskData());
taskData.setName(name);
taskData.setExpression(expression);
taskData = taskDataRepository.save(taskData);
myScheduler.registerTask(taskData);
return taskData;
}
@RequestMapping("/stop")
public void stop(Long id) {
taskDataRepository.findById(id).ifPresent(taskData -> {
myScheduler.stop(id);
});
}
}
我們提供了 register 和 stop 兩個接口，這兩個接口會在改變動態(tài)任務執(zhí)行數(shù)據(jù)時，先將數(shù)據(jù)保存到數(shù)據(jù)庫中，對定時任務進行持久化，避免程序重啟后定時任務都丟失。
程序啟動后，我們首先調(diào)用 register 接口新增一個定時任務：
http://localhost:8080/register?name=test
接口調(diào)用后，在日志中可以看到定時任務開始執(zhí)行了：
2024-01-07T18:02:09.003+08:00 INFO 23012 --- [ sys-scheduler5] c.s.springdynamicscheduler.TaskData : test is running with expression 0/1 * * * * ? 2024-01-07T18:02:10.005+08:00 INFO 23012 --- [ sys-scheduler3] c.s.springdynamicscheduler.TaskData : test is running with expression 0/1 * * * * ? 2024-01-07T18:02:11.012+08:00 INFO 23012 --- [ sys-scheduler3] c.s.springdynamicscheduler.TaskData : test is running with expression 0/1 * * * * ?
再調(diào)用 stop 接口，通過日志可以發(fā)現(xiàn)定時任務停止了執(zhí)行：
http://localhost:8080/stop?id=1
到此這篇關于spring動態(tài)控制定時任務的實現(xiàn)的文章就介紹到這了,更多相關spring動態(tài)控制定時任務內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
- SpringBoot定時任務的實現(xiàn)詳解
- 利用SpringBoot解決多個定時任務阻塞的問題
- spring配置定時任務的幾種方式總結(jié)
- springboot中設置定時任務的三種方法小結(jié)
- Spring定時任務@scheduled多線程使用@Async注解示例
- Spring定時任務@Scheduled注解(cron表達式fixedRate?fixedDelay)
- SpringBoot中實現(xiàn)定時任務的4種方式詳解
- Spring中的Schedule動態(tài)添加修改定時任務詳解
- SpringBoot中的定時任務和異步調(diào)用詳解
- SpringBoot實現(xiàn)設置動態(tài)定時任務的方法詳解
- Spring定時任務注解@Scheduled詳解
相關文章
這篇文章主要給大家介紹了關于java中對象的序列化與反序列化的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-09-09
spring-data-elasticsearch @Field注解無效的完美解決方案
這篇文章主要介紹了spring-data-elasticsearch @Field注解無效的完美解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
本文主要介紹了Java中null相關注解的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-04-04
SpringBoot參數(shù)校驗的一些實戰(zhàn)應用
這篇文章主要給大家介紹了關于SpringBoot參數(shù)校驗的一些實戰(zhàn)應用,包括使用內(nèi)置的參數(shù)校驗注解、嵌套對象校驗、分組校驗以及自定義校驗注解,通過這些方法,可以有效地提高系統(tǒng)的穩(wěn)定性和安全性,需要的朋友可以參考下2024-11-11
這篇文章主要為大家介紹了SpringMVC中請求參數(shù)的獲取方式，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-05-05
這篇文章主要介紹了Java基礎之教你怎么用代碼一鍵生成POJO,文中有非常詳細的代碼示例,對正在學習Java的小伙伴們有非常好的幫助,需要的朋友可以參考下2021-04-04
這篇文章主要介紹了java學習之SpringBoot框架，文章基于Java的相關資料展開詳細的內(nèi)容介紹，具有一定的參考價值，需要的小伙伴可以參考一下2022-04-04
這篇文章主要介紹了基于spring DI的三種注入方式分析，具有很好的參考價值，希望對大家有所幫助。2021-07-07
java的Object里wait()實現(xiàn)原理講解
這篇文章主要介紹了java的Object里wait()實現(xiàn)原理，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要介紹了如何關閉 IDEA 自動更新,本文通過圖文并茂的形式給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-12-12