SpringBoot系列:Spring Boot定時任務Spring Schedule
Spring Schedule是Spring提供的定時任務框架,相較於Quartz,Schedule更加簡單易用,在中小型應用中,對於大部分需求,Schedule都可以勝任。
一、Spring Schedule使用演示
在SpringBoot使用Spring Schedule非常簡單,因為SpringBoot自身的starter中已經集成了Schedule,而不需要我們做更多的處理。
使用@EnableScheduling註解開啟定時功能,該註解可以使用在啟動類上,也可以註解於定時任務的類上。然後使用@Scheduled註解配合其引數完成定時任務。
例如我們需要每一秒執行一次的任務, 寫成@Scheduled(fixedRate = 1000)即可。
@EnableScheduling
@Component
public class Task {
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
@Scheduled(fixedRate = 1000)
public void taskOne(){
System.out.println("現在時間:" + dateFormat.format(new Date()));
}
}
啟動程式,該定時就可以間隔一秒持續執行了。
使用Spring Schedule就是這麼簡單,如果有更多其他的需求,配合@Scheduled的其他引數,基本也可以實現。
一、@Scheduled引數詳解
cron
支援傳入cron表示式:[秒] [分] [小時] [日] [月] [周] [年],[年]不是必須的域,可以省略[年],則一共6個域。
位置 | 說明 | 必填 | 允許填寫的值 | 允許的萬用字元 |
---|---|---|---|---|
1 | 秒 | 是 | 0-59 | - * / |
2 | 分 | 是 | 0-59 | - * / |
3 | 時 | 是 | 0-23 | - * / |
4 | 日 | 是 | 1-31 | - * ? / L W |
5 | 月 | 是 | 1-12 or JAN-DEC | - * / |
6 | 周 | 是 | 1-7 or SUN-SAT | - * ? / L # |
7 | 年 | 否 | 1970-2099 | - * / |
- * 表示所有值。 例如:在分的欄位上設定 *,表示每一分鐘都會觸發。
- ? 表示不指定值。使用的場景為不需要關心當前設定這個欄位的值。例如:要在每月的10號觸發一個操作,但不關心是周幾,所以需要周位置的那個欄位設定為”?” 具體設定為 0 0 0 10 * ?
- - 表示區間。例如 在小時上設定 “10-12”,表示 10,11,12點都會觸發。
- , 表示指定多個值,例如在周欄位上設定 “MON,WED,FRI” 表示週一,週三和週五觸發/ 用於遞增觸發。如在秒上面設定”5/15” 表示從5秒開始,每增15秒觸發(5,20,35,50)。 在月欄位上設定’1/3’所示每月1號開始,每隔三天觸發一次。
- L 表示最後的意思。在日欄位設定上,表示當月的最後一天(依據當前月份,如果是二月還會依據是否是潤年[leap]), 在周欄位上表示星期六,相當於”7”或”SAT”。如果在”L”前加上數字,則表示該資料的最後一個。例如在周欄位上設定”6L”這樣的格式,則表示“本月最後一個星期五”
- W 表示離指定日期的最近那個工作日(週一至週五). 例如在日欄位上置”15W”,表示離每月15號最近的那個工作日觸發。如果15號正好是週六,則找最近的週五(14號)觸發, 如果15號是周未,則找最近的下週一(16號)觸發.如果15號正好在工作日(週一至週五),則就在該天觸發。如果指定格式為 “1W”,它則表示每月1號往後最近的工作日觸發。如果1號正是週六,則將在3號下週一觸發。(注,”W”前只能設定具體的數字,不允許區間”-“)。
- # 序號(表示每月的第幾個周幾),例如在周欄位上設定”6#3”表示在每月的第三個週六.注意如果指定”#5”,正好第五週沒有周六,則不會觸發該配置(用在母親節和父親節再合適不過了) ;小提示:’L’和 ‘W’可以一組合使用。如果在日欄位上設定”LW”,則表示在本月的最後一個工作日觸發;周欄位的設定,若使用英文字母是不區分大小寫的,即MON與mon相同。
示例
- 每隔5秒執行一次:/5 * * * ?
- 每隔1分鐘執行一次:0 /1 * * ?
- 每天23點執行一次:0 0 23 * * ?
- 每天凌晨1點執行一次:0 0 1 * * ?
- 每月1號凌晨1點執行一次:0 0 1 1 * ?
- 每月最後一天23點執行一次:0 0 23 L * ?
- 每週星期天凌晨1點實行一次:0 0 1 ? * L
- 在26分、29分、33分執行一次:0 26,29,33 * * * ?
- 每天的0點、13點、18點、21點都執行一次:0 0 0,13,18,21 * * ?
zone
表示時區,接收一個java.util.TimeZone#ID。cron表示式會基於該時區解析。預設是一個空字串,即取伺服器所在地的時區。
fixedDelay
上一次執行完畢時間點之後多長時間再執行。
fixedDelayString
與fixedDelay類似,傳入字串,也可支援傳入${}佔位符讀取配置檔案。
@Scheduled(fixedDelayString = "${task.two.fixedDelay}")
void taskTwo() {
System.out.println("現在時間:" + dateFormat.format(new Date()));
}
fixedRate
上一次開始執行時間點之後多長時間再執行。
fixedRate與fixedDelay的區別就是:fixedDelay是在上一個任務結束後才開始進行間隔計時,也就是說兩次任務之間的時間差等於間隔+任務執行耗時,而fixedRate是在上一個任務一開始就已經開始進行間隔計時了,可以視為固定等於設定的間隔時間。
fixedRateString
與fixedRate一樣,傳入字串,支援佔位符讀取配置檔案。
initialDelay
第一次任務延遲時間。
initialDelayString
同initialDelay,支援佔位符讀取配置資訊