Spring Boot 定時任務 @Scheduled
專案開發中經常需要執行一些定時任務,比如在每天凌晨,需要從 implala 資料庫拉取產品功能活躍資料,分析處理後存入到 MySQL 資料庫中。類似這樣的需求還有許多,那麼怎麼去實現定時任務呢,有以下幾種實現方式。
Java 定時任務的幾種實現方式
- 基於 java.util.Timer 定時器,實現類似鬧鐘的定時任務
- 使用 Quartz、elastic-job、xxl-job 等開源第三方定時任務框架,適合分散式專案應用
- 使用 Spring 提供的一個註解: @Schedule,開發簡單,使用比較方便,也是本文介紹的一種方式
Spring 自身提供了對定時任務的支援,本文將介紹 Spring Boot 中 @Scheduled 定時器的使用。
建立定時任務
首先,在專案啟動類上新增 @EnableScheduling 註解,開啟對定時任務的支援
@SpringBootApplication
@EnableScheduling
public class ScheduledApplication {
public static void main(String[] args) {
SpringApplication.run(ScheduledApplication.class, args);
}
}
其中 @EnableScheduling註解的作用是發現註解@Scheduled的任務並後臺執行。
其次,編寫定時任務類和方法,定時任務類通過 Spring IOC 載入,使用 @Component 註解,定時方法使用 @Scheduled 註解。
@Component
public class ScheduledTask {
@Scheduled(fixedRate = 3000)
public void scheduledTask() {
System.out.println("任務執行時間:" + LocalDateTime.now());
}
}
fixedRate 是 long 型別,表示任務執行的間隔毫秒數,以上程式碼中的定時任務每 3 秒執行一次。
執行定時工程,專案啟動和執行日誌如下,可見每 3 秒列印一次日誌執行記錄。
2019-10-16 22:50:04.791 INFO 10610 --- [ main] com.wupx.ScheduledApplication : Started ScheduledApplication in 1.513 seconds (JVM running for 1.976) 任務執行時間:2019-10-16T22:50:04.791 任務執行時間:2019-10-16T22:50:07.782 任務執行時間:2019-10-16T22:50:10.779
@Scheduled詳解
在上面的入門例子中,使用了@Scheduled(fixedRate = 3000) 註解來定義每過 3 秒執行的任務,對於 @Scheduled 的使用可以總結如下幾種方式:
- @Scheduled(fixedRate = 3000) :上一次開始執行時間點之後 3 秒再執行(fixedRate 屬性:定時任務開始後再次執行定時任務的延時(需等待上次定時任務完成),單位毫秒)
- @Scheduled(fixedDelay = 3000) :上一次執行完畢時間點之後 3 秒再執行(fixedDelay 屬性:定時任務執行完成後再次執行定時任務的延時(需等待上次定時任務完成),單位毫秒)
- @Scheduled(initialDelay = 1000, fixedRate = 3000) :第一次延遲1秒後執行,之後按fixedRate的規則每 3 秒執行一次(initialDelay 屬性:第一次執行定時任務的延遲時間,需配合fixedDelay或者fixedRate來使用)
- @Scheduled(cron="0 0 2 1 * ? *") :通過cron表示式定義規則
其中,常用的cron表示式有:
- 0 0 2 1 * ? * :表示在每月 1 日的凌晨 2 點執行
- 0 15 10 ? * MON-FRI :表示週一到週五每天上午 10:15 執行
- 0 15 10 ? 6L 2019-2020 :表示 2019-2020 年的每個月的最後一個星期五上午 10:15 執行
- 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 * * ? 2019 :2019 年的每天上午 10:15 執行
總結
本文主要介紹了基於 Spring Boot 內建的定時任務的配置使用,主要涉及兩個註解,四個屬性的配置:
- 主程式入口 @EnableScheduling 開啟定時任務
- 定時方法上 @Scheduled 設定定時
- cron屬性:按cron規則執行
- fixedRate 屬性:以固定速率執行
- fixedDelay 屬性:上次執行完畢後延遲再執行
- initialDelay 屬性:第一次延時執行,第一次執行完畢後延遲後再次執行
參考
https://spring.io/guides/gs/scheduling-tasks/
https://www.tutorialspoint.com/spring_boot/spring_boot_scheduling.htm
https://docs.spring.io/spring/docs/2.5.x/reference/scheduling.html