假設我們已經搭建好了一個基於Spring Boot項目,首先我們要在Application中設置啟用定時任務功能@EnableScheduling。
啟動定時任務
package com.scheduling; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.scheduling.annotation.EnableScheduling; @SpringBootApplication @EnableScheduling public class Application { public static void main(String[] args) throws Exception { SpringApplication.run(Application.class); } }
其中 @EnableScheduling 注解的作用是發現注解@Scheduled的任務並后台執行。
定時任務具體實現類
接下來我們來創建一個定時任務
package com.Scheduler.utils; import java.text.SimpleDateFormat; import java.util.Date; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; @Component public class Scheduler{ private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss"); //每隔2秒執行一次 @Scheduled(fixedRate = 2000) public void testTasks() { System.out.println("定時任務執行時間:" + dateFormat.format(new Date())); } //每天3:05執行 @Scheduled(cron = "0 05 03 ? * *") public void testTasks() { System.out.println("定時任務執行時間:" + dateFormat.format(new Date())); } }
運行Spring Boot,輸出結果為如下,每2秒鍾打印出當前時間。
定時任務執行時間:23:28:00 定時任務執行時間:23:28:02 定時任務執行時間:23:28:04 定時任務執行時間:23:28:06 定時任務執行時間:23:28:08
注意: 需要在定時任務的類上加上注釋:@Component,在具體的定時任務方法上加上注釋@Scheduled即可啟動該定時任務。
@Scheduled參數描述
- @Scheduled(fixedRate=3000):上一次開始執行時間點后3秒再次執行;
- @Scheduled(fixedDelay=3000):上一次執行完畢時間點3秒再次執行;
- @Scheduled(initialDelay=1000, fixedDelay=3000):第一次延遲1秒執行,然后在上一次執行完畢時間點3秒再次執行;
- @Scheduled(cron="* * * * * ?"):按cron規則執行;
cron規則
cron表達式中各時間元素使用空格進行分割,表達式有至少6個(也可能7個)分別表示如下含義:
- 秒(0~59)
- 分鍾(0~59)
- 小時(0~23)
- 天(月)(0~31,但是你需要考慮你月的天數)
- 月(0~11)
- 天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)
- 7.年份(1970-2099)
其中每個元素可以是一個值(如6),一個連續區間(9-12),一個間隔時間(8-18/4)(/表示每隔4小時),一個列表(1,3,5),通配符。由於"月份中的日期"和"星期中的日期"這兩個元素互斥的,必須要對其中一個設置?.
- 0 0 10,14,16 * * ? 每天上午10點,下午2點,4點
- 0 0/30 9-17 * * ? 朝九晚五工作時間內每半小時
- 0 0 12 ? * WED 表示每個星期三中午12點
- "0 0 12 * * ?" 每天中午12點觸發
- "0 15 10 ? * *" 每天上午10:15觸發
- "0 15 10 * * ?" 每天上午10:15觸發
- "0 15 10 * * ? *" 每天上午10:15觸發
- "0 15 10 * * ? 2005" 2005年的每天上午10:15觸發
- "0 * 14 * * ?" 在每天下午2點到下午2:59期間的每1分鍾觸發
- "0 0/5 14 * * ?" 在每天下午2點到下午2:55期間的每5分鍾觸發
- "0 0/5 14,18 * * ?" 在每天下午2點到2:55期間和下午6點到6:55期間的每5分鍾觸發
- "0 0-5 14 * * ?" 在每天下午2點到下午2:05期間的每1分鍾觸發
- "0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44觸發
- "0 15 10 ? * MON-FRI" 周一至周五的上午10:15觸發
- "0 15 10 15 * ?" 每月15日上午10:15觸發
- "0 15 10 L * ?" 每月最后一日的上午10:15觸發
- "0 15 10 ? * 6L" 每月的最后一個星期五上午10:15觸發
- "0 15 10 ? * 6L 2002-2005" 2002年至2005年的每月的最后一個星期五上午10:15觸發
- "0 15 10 ? * 6#3" 每月的第三個星期五上午10:15觸發
有些子表達式能包含一些范圍或列表
“*”字符代表所有可能的值
因此,“*”在子表達式(月)里表示每個月的含義,“*”在子表達式(天(星期))表示星期的每一天
“/”字符用來指定數值的增量
例如:在子表達式(分鍾)里的“0/15”表示從第0分鍾開始,每15分鍾
在子表達式(分鍾)里的“3/20”表示從第3分鍾開始,每20分鍾(它和“3,23,43”)的含義一樣
“?”字符僅被用於天(月)和天(星期)兩個子表達式,表示不指定值
當2個子表達式其中之一被指定了值以后,為了避免沖突,需要將另一個子表達式的值設為“?”
“L” 字符僅被用於天(月)和天(星期)兩個子表達式,它是單詞“last”的縮寫
但是它在兩個子表達式里的含義是不同的。
- 在天(月)子表達式中,“L”表示一個月的最后一天
- 在天(星期)自表達式中,“L”表示一個星期的最后一天,也就是SAT
- 如果在“L”前有具體的內容,它就具有其他的含義了
- 例如:“6L”表示這個月的倒數第6天,“FRIL”表示這個月的最一個星期五
- 注意:在使用“L”參數時,不要指定列表或范圍,因為這會導致問題
字段 | 允許值 | 允許的特殊字符 |
秒 | 0-59 | , - * / |
分 | 0-59 | , - * / |
小時 | 0-23 | , - * / |
日期 | 1月31日 | , - * ? / L W C |
月份 | 1-12 或者 JAN-DEC | , - * / |
星期 | 1-7 或者 SUN-SAT | , - * ? / L C # |
年(可選) | 留空, 1970-2099 |