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
