背景簡介:
最近項目中經常需要設置一些定時器,定時執行某個任務,項目基本架構:SpringCloud+SpringBoot+Mybatis
主要涉及的注解:
@EnableScheduling //開啟定時任務
@Scheduled //執行任務間隔設置
開啟定時任務的注解:@EnableScheduling 為了方便,可以用在啟動類上
執行任務間隔設置的這個注解:@Scheduled
查看其源碼,可以發現有這么幾個參數:cron、zone、fixedDelay、fixedDelayString、fixedRate、fixedRateString、initialDelay、initialDelayString 用法分別如下:
1.cron:該參數接收一個cron表達式
,cron表達式
是一個字符串,字符串以5或6個空格隔開,分開共6或7個域,每一個域代表一個含義。
按順序依次為:
[秒] [分] [小時] [日] [月] [周] [年]
秒(0~59)|分鍾(0~59)|小時(0~23)|天(月)(0~31,但是你需要考慮你月的天數)|月(0~11)|天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)|年份(1970-2099)
序號 | 說明 | 必填 | 允許填寫的值 | 允許的通配符 |
---|---|---|---|---|
1 | 秒 | 是 | 0-59 | , - * / |
2 | 分 | 是 | 0-59 | , - * / |
3 | 時 | 是 | 0-23 | , - * / |
4 | 日 | 是 | 1-31 | , - * ? / L W |
5 | 月 | 是 | 1-12 / 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 * * ?
cron表達式使用占位符
另外,cron
屬性接收的cron表達式
支持占位符。eg:
配置文件:
time: cron: */5 * * * * * interval: 5
@Scheduled(cron="${time.cron}")
@Scheduled(cron="*/${time.interval} * * * * *")
2.zone:時區,接收一個java.util.TimeZone#ID
。cron表達式
會基於該時區解析。默認是一個空字符串,即取服務器所在地的時區。比如我們一般使用的時區Asia/Shanghai
。該字段我們一般留空。
3.fixedDelay、fixedDelayString:這兩個參數意思是相同的,都是表示:上一次執行完畢時間點之后多長時間再執行,區別是:后者支持占位符。
用法如下:
@Scheduled(fixedDelay = 1000) //上一次執行完畢時間點之后1秒再執行 @Scheduled(fixedDelayString = "1000") //上一次執行完畢時間點之后1秒再執行 配置文件: time.fixedDelay=1000 @Scheduled(fixedDelayString = "${time.fixedDelay}")
4.fixedRate、fixedRateString:這兩個參數意思是相同的,都是表示:上一次開始執行時間點之后多長時間再執行,區別是:后者支持占位符。
用法如下:
@Scheduled(fixedRate = 1000) //上一次開始執行時間點之后1秒再執行 @Scheduled(fixedRateString = "1000") //上一次開始執行時間點之后1秒再執行 配置文件: time.fixedDelay=1000 @Scheduled(fixedRateString = "${time.fixedDelay}")
5.initialDelay、initialDelayString:這兩個參數意思是相同的,都是表示:第一次延遲多長時間后再執行,區別是:后者支持占位符。
用法如下:
@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延遲1秒后執行,之后按fixedRate的規則每5秒執行一次