Springboot自带定时任务实现动态配置Cron参数
同学们，我今天分享一下SpringBoot动态配置Cron参数。场景是这样子的：后台管理界面对定时任务进行管理，可动态修改执行时间，然后保存入库，每次任务执行前从库里查询时间，以达到动态修改Cron参数的效果。好，咱们一起来看看是怎么回事。
SpringBoot定时任务的四种实现方式(主要)
-
Timer：这是java自带的java.util.Timer类，这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行，但不能在指定时间运行。一般用的较少。 -
ScheduledExecutorService：也jdk自带的一个类；是基于线程池设计的定时任务类,每个调度任务都会分配到线程池中的一个线程去执行,也就是说,任务是并发执行,互不影响。 -
Spring Task：Spring3.0以后自带的task，可以将它看成一个轻量级的Quartz，而且使用起来比Quartz简单许多。 -
Quartz：这是一个功能比较强大的的调度器，可以让你的程序在指定时间执行，也可以按照某一个频度执行，配置起来稍显复杂。
1.1使用Timer
这是让你按照固定的频率去执行一个任务，不能指定时间。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
public class TestTimer { public static void main(String[] args) { TimerTask timerTask = new TimerTask() { @Override public void run() { System.out.println("task run:"+ new Date()); } }; Timer timer = new Timer(); //安排指定的任务在指定的时间开始进行重复的固定延迟执行。这里是每3秒执行一次 timer.schedule(timerTask,10,3000); }} |
1.2使用ScheduledExecutorService和timer类似
|
1
2
3
4
5
6
7
8
|
public class TestScheduledExecutorService { public static void main(String[] args) { ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor(); // 参数：1、任务体 2、首次执行的延时时间 // 3、任务执行间隔 4、间隔时间单位 service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService "+new Date()), 0, 3, TimeUnit.SECONDS); }} |
1.3使用Spring Task
我们主要讲解它的动态配置使用方法。
在刚开始使用的时候，我们更改一个任务的执行时间，一般是这样的：修改定时任务的执行周期，把服务停下来，改下任务的cron参数，再重启服务就搞搞定了。这种方式很简单，没有可说的，但是有没有一种可能，在不停服务的情况下，就可以动态的修改任务的cron参数呢？那是必须有！
刚刚提到的方法里，我们在主类上面加@EnableScheduling注解，在任务方法前面加上@Scheduled(cron =“0/5 * * * * *”)注解定义执行时间，但是动态配置的步骤就有点不一样：
1. 在定时任务类上增加@EnabledScheduling注解，并实现SchedulingConfigurer接口。
2. 设置一个静态的cron，用于存放任务执行周期参数。
3. 从数据库获取Cron参数，用于模拟实际业务中外部原因修改了任务执行周期。
4. 设置任务触发器，触发任务执行。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
import java.util.Date;import org.springframework.scheduling.Trigger;import org.springframework.scheduling.TriggerContext;import org.springframework.scheduling.annotation.EnableScheduling;import org.springframework.scheduling.annotation.SchedulingConfigurer;import org.springframework.scheduling.config.ScheduledTaskRegistrar;import org.springframework.scheduling.support.CronTrigger;import org.springframework.stereotype.Component;import java.time.LocalDateTime;@Component@EnableSchedulingpublic class TaskCronChange implements SchedulingConfigurer{ public static String cron; @Override public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { //项目部署时，会在这里执行一次，从数据库拿到cron表达式 cron = timerQueryMapper.getCronTime(); Runnable task = new Runnable() { @Override public void run() { //任务逻辑代码部分. System.out.println("I am going:" + LocalDateTime.now()); } }; Trigger trigger = new Trigger() { @Override public Date nextExecutionTime(TriggerContext triggerContext) { //任务触发，可修改任务的执行周期. //每一次任务触发，都会执行这里的方法一次，重新获取下一次的执行时间 cron = timerQueryMapper.getCronTime(); CronTrigger trigger = new CronTrigger(cron); Date nextExec = trigger.nextExecutionTime(triggerContext); return nextExec; } }; taskRegistrar.addTriggerTask(task, trigger); }} |
因为是要任务执行一次的时候才会去修改时间的cron表达式，所以改了cron后，要在下下次任务执行时才会生效。
这里核心的主要是使用到了ScheduledTaskRegistrar这个类有一个方法addTriggerTask（Runnable,Trigger） 两个参数，一个Runnable,一个是Trigger，在Runnable中执行业务逻辑代码，在Trigger修改定时任务的执行周期。
1.4整合Quartz
在SpringBoot版本是2.0.0以后的，则在spring-boot-starter中已经包含了quart的依赖，则可以直接使用spring-boot-starter-quartz依赖，如果是低于2.0.0版本的，需要额外添加quartz的依赖。
spring动态配置cron表达式，不需要停服
spring做定时任务调度时有常用的两种方式，分别是基于配置文件的quartz和基于注解的@Scheduler。
quartz需要较多的配置文件，个人感觉比较麻烦，@Scheduler注解只需要简单的配置即可，但是这两种发方法不能动态加载cron表达式，每次更改调度规则都需要重启服务。
本文介绍一种不需要重启服务的动态加载cron表达式的方法。
SchedulingConfigurer接口实现动态加载cron表达式
代码示例如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
@Component@EnableSchedulingpublic class Test implements SchedulingConfigurer { @Override public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) { //创建一个线程池调度器，默认是单线程执行 ScheduledExecutorService executorService = Executors.newScheduledThreadPool(100); scheduledTaskRegistrar.setScheduler(executorService); //增加任务 scheduledTaskRegistrar.addTriggerTask(new Task("test1"),new Trig("cronExpess1")); scheduledTaskRegistrar.addTriggerTask(new Task("test2"),new Trig("cronExpess2")); scheduledTaskRegistrar.addTriggerTask(new Task("test3"),new Trig("cronExpess2")); }} /** * 业务类 */class Task implements Runnable{ String task; public Task(String task){ this.task = task; } //具体业务 @Override public void run() { System.out.println(task+":"+LocalDateTime.now()+","+Thread.currentThread().getName()); }} /** * 调度类 */class Trig implements Trigger{ private String cronExpress; public Trig(String cronExpress){ this.cronExpress = cronExpress; } @Override public Date nextExecutionTime(TriggerContext triggerContext) { String cron = null; try { //每次调度时加载cron表达式 cron = new Config().getCrons().get(cronExpress); } catch (IOException e) { e.printStackTrace(); } CronTrigger cronTrigger = new CronTrigger(cron); return cronTrigger.nextExecutionTime(triggerContext); }} /** * 加载cron表达式 */class Config{ private static Map<String,String> cronMap; private static long preModifyTime; private String cronFile = "config/application.properties"; public Map<String,String> getCrons() throws IOException { File file = new File(cronFile); long nowModifyTime = file.lastModified(); if (cronMap != null && nowModifyTime == preModifyTime){ return cronMap; }else { cronMap = new HashMap<>(); BufferedReader br = new BufferedReader(new FileReader(file)); String line = null; while ((line = br.readLine()) != null){ String[] s = line.split("="); cronMap.put(s[0].trim(),s[1].trim()); } preModifyTime = nowModifyTime; return cronMap; } }} |
配置文件：
|
1
2
|
cronExpess1 = 0/5 * * * * *cronExpess2 = 0/10 * * * * * |
运行结果（为了查看方便，只运行一个任务）：
以上为个人经验，希望能给大家一个参考，也希望大家多多支持服务器之家。
原文链接：https://blog.csdn.net/qq_35992900/article/details/80429245
