Spring Boot 定時任務 @Scheduled

項目開發(fā)中經(jīng)常需要執(zhí)行一些定時任務,比如在每天凌晨,需要從 implala 數(shù)據(jù)庫拉取產(chǎn)品功能活躍數(shù)據(jù),分析處理后存入到 MySQL 數(shù)據(jù)庫中。類似這樣的需求還有許多,那么怎么去實現(xiàn)定時任務呢,有以下幾種實現(xiàn)方式。

Java 定時任務的幾種實現(xiàn)方式

  • 基于 java.util.Timer 定時器,實現(xiàn)類似鬧鐘的定時任務
  • 使用 Quartz、elastic-job、xxl-job 等開源第三方定時任務框架,適合分布式項目應用
  • 使用 Spring 提供的一個注解: @Schedule,開發(fā)簡單,使用比較方便,也是本文介紹的一種方式

Spring 自身提供了對定時任務的支持,本文將介紹 Spring Boot 中 @Scheduled 定時器的使用。

創(chuàng)建定時任務

首先,在項目啟動類上添加 @EnableScheduling 注解,開啟對定時任務的支持

@SpringBootApplication
@EnableScheduling
public class ScheduledApplication {

    public static void main(String[] args) {
        SpringApplication.run(ScheduledApplication.class, args);
    }

}

其中 @EnableScheduling注解的作用是發(fā)現(xiàn)注解@Scheduled的任務并后臺執(zhí)行。

其次,編寫定時任務類和方法,定時任務類通過 Spring IOC 加載,使用 @Component 注解,定時方法使用 @Scheduled 注解。

@Component
public class ScheduledTask {

    @Scheduled(fixedRate = 3000)
    public void scheduledTask() {
        System.out.println("任務執(zhí)行時間:" + LocalDateTime.now());
    }

}

fixedRate 是 long 類型,表示任務執(zhí)行的間隔毫秒數(shù),以上代碼中的定時任務每 3 秒執(zhí)行一次。

運行定時工程,項目啟動和運行日志如下,可見每 3 秒打印一次日志執(zhí)行記錄。

2019-10-16 22:50:04.791  INFO 10610 --- [           main] com.wupx.ScheduledApplication                : Started ScheduledApplication in 1.513 seconds (JVM running for 1.976)
任務執(zhí)行時間:2019-10-16T22:50:04.791
任務執(zhí)行時間:2019-10-16T22:50:07.782
任務執(zhí)行時間:2019-10-16T22:50:10.779

@Scheduled詳解

在上面的入門例子中,使用了@Scheduled(fixedRate = 3000) 注解來定義每過 3 秒執(zhí)行的任務,對于 @Scheduled 的使用可以總結(jié)如下幾種方式:

  • @Scheduled(fixedRate = 3000) :上一次開始執(zhí)行時間點之后 3 秒再執(zhí)行(fixedRate 屬性:定時任務開始后再次執(zhí)行定時任務的延時(需等待上次定時任務完成),單位毫秒)
  • @Scheduled(fixedDelay = 3000) :上一次執(zhí)行完畢時間點之后 3 秒再執(zhí)行(fixedDelay 屬性:定時任務執(zhí)行完成后再次執(zhí)行定時任務的延時(需等待上次定時任務完成),單位毫秒)
  • @Scheduled(initialDelay = 1000, fixedRate = 3000) :第一次延遲1秒后執(zhí)行,之后按fixedRate的規(guī)則每 3 秒執(zhí)行一次(initialDelay 屬性:第一次執(zhí)行定時任務的延遲時間,需配合fixedDelay或者fixedRate來使用)
  • @Scheduled(cron="0 0 2 1 * ? *") :通過cron表達式定義規(guī)則

其中,常用的cron表達式有:

  • 0 0 2 1 * ? * :表示在每月 1 日的凌晨 2 點執(zhí)行
  • 0 15 10 ? * MON-FRI :表示周一到周五每天上午 10:15 執(zhí)行
  • 0 15 10 ? 6L 2019-2020 :表示 2019-2020 年的每個月的最后一個星期五上午 10:15 執(zhí)行
  • 0 0 10,14,16 * * ? :每天上午 10 點,下午 2 點,4 點執(zhí)行
  • 0 0/30 9-17 * * ? :朝九晚五工作時間內(nèi)每半小時執(zhí)行
  • 0 0 12 ? * WED :表示每個星期三中午 12 點執(zhí)行
  • 0 0 12 * * ? :每天中午 12點執(zhí)行
  • 0 15 10 ? * * :每天上午 10:15 執(zhí)行
  • 0 15 10 * * ? :每天上午 10:15 執(zhí)行
  • 0 15 10 * * ? * :每天上午 10:15 執(zhí)行
  • 0 15 10 * * ? 2019 :2019 年的每天上午 10:15 執(zhí)行

總結(jié)

本文主要介紹了基于 Spring Boot 內(nèi)置的定時任務的配置使用,主要涉及兩個注解,四個屬性的配置:

  • 主程序入口 @EnableScheduling 開啟定時任務
  • 定時方法上 @Scheduled 設(shè)置定時
  • cron屬性:按cron規(guī)則執(zhí)行
  • fixedRate 屬性:以固定速率執(zhí)行
  • fixedDelay 屬性:上次執(zhí)行完畢后延遲再執(zhí)行
  • initialDelay 屬性:第一次延時執(zhí)行,第一次執(zhí)行完畢后延遲后再次執(zhí)行

參考

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

友情鏈接更多精彩內(nèi)容