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 屬性：第一次延時執行，第一次執行完畢後延遲後再次執行

<center><img src="https://img2018.cnblogs.com/blog/1356806/201910/1356806-20191009000648748-355850292.png" /></center>

參考

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