【本篇博客,有配套视频,视频地址:《Spring Boot定时任务升级篇(动态添加修改删除定时任务)(高清)》,公众号中点击下面的阅读原文,视频中讲解的更详细】
需求缘起:在发布了《Spring Boot定时任务升级篇》之后得到不少反馈,其中有一个反馈就是如何动态添加修改删除定时任务?那么我们一起看看具体怎么实现,先看下本节大纲:
(1)思路说明;
(2)代码解析;
(3)修改定时任务执行周期特别说明;
接下来看看本节的大纲:
(1)思路说明;
(a)首先这里我们需要重新认识一个类ThreadPoolTaskScheduler:线程池任务调度类,能够开启线程池进行任务调度。
(b)ThreadPoolTaskScheduler.schedule()方法会创建一个定时计划ScheduledFuture,在这个方法需要添加两个参数,Runnable(线程接口类)和CronTrigger(定时任务触发器)
(c)在ScheduledFuture中有一个cancel可以停止定时任务。
(2)代码解析;
根据以上的思路分析,我们很容易就知道如何进行编码了,先提供代码如下:
packagecom.kfit.task;
importjava.util.Date;
importjava.util.concurrent.ScheduledFuture;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.context.annotation.Bean;
importorg.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
importorg.springframework.scheduling.support.CronTrigger;
importorg.springframework.stereotype.Component;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;
/**
*@authorAngel--守护天使
*@versionv.0.1
*@date2017年4月6日
*/
@RestController
@Component
publicclassDynamicTask {
@Autowired
privateThreadPoolTaskSchedulerthreadPoolTaskScheduler;
privateScheduledFuture>future;
@Bean
publicThreadPoolTaskSchedulerthreadPoolTaskScheduler() {
returnnewThreadPoolTaskScheduler();
}
@RequestMapping("/startCron")
publicString startCron() {
future=threadPoolTaskScheduler.schedule(newMyRunnable(),newCronTrigger("0/5 * * * * *"));
System.out.println("DynamicTask.startCron()");
return"startCron";
}
@RequestMapping("/stopCron")
publicString stopCron() {
if(future!=null) {
future.cancel(true);
}
System.out.println("DynamicTask.stopCron()");
return"stopCron";
}
@RequestMapping("/changeCron10")
publicString startCron10() {
stopCron();//先停止,在开启.
future=threadPoolTaskScheduler.schedule(newMyRunnable(),newCronTrigger("*/10 * * * * *"));
System.out.println("DynamicTask.startCron10()");
return"changeCron10";
}
privateclassMyRunnableimplementsRunnable {
@Override
publicvoidrun() {
System.out.println("DynamicTask.MyRunnable.run(),"+newDate());
}
}
}
(a)我们首先了一个类DynamicTask;
(b)定义了两个变量,threadPoolTaskScheduler和future其中future是treadPoolTaskScheduler执行方法schedule的返回值,主要用于定时任务的停止。
(c)编写启动定时器的方法startCron();
(d)编写停止方法stopCron(),这里编码的时候,需要注意下需要判断下future为null的时候,不然就很容易抛出NullPointerException;
(e)编写修改定时任务执行周期方法changeCron10(),这里的原理就是关闭之前的定时器,创新在创建一个新的定时器。
(3)修改定时任务执行周期特别说明;
在上一篇博客中,我们使用了一种方式通过全局变量的方式修改cron参数的值,那么在这里的我们也是可以这么做的,这里简单提供下思路,大家自己去实现。
注意ThreadPoolTaskScheduler中的schedule()第二个参数支持Trigger:
那么我们就可以自己定义一个Trigger,然后动态进行修改了,这里提供核心的代码如下:
privateStringcronStr="*/5 * * * * *";
@RequestMapping("/startCron1")
publicString startCron1(){
System.out.println("startCron1 >>>>");
threadPoolTaskScheduler.schedule(newMyRunnable(),newTrigger(){
@Override
publicDatenextExecutionTime(TriggerContexttriggerContext){
returnnewCronTrigger(cronStr).nextExecutionTime(triggerContext);
}
});
System.out.println("startCron1 <<<
return"startCron1";
}