Spring Boot之使用Scheduled註解實現定時任務

java閘瓦發表於2019-04-12

在程式開發的過程中,經常會使用到定時任務來實現一些功能,比如:

  • 系統依賴於外部系統的非核心資料,可以定時同步(每天同步一次)
  • 系統內部一些非核心資料的統計計算,可以定時計算(每天計算一次) 在Spring Boot中,我們可以使用@Scheduled註解來快速的實現定時任務。

@Scheduled註解主要支援以下3種方式:

  1. fixedRate 固定頻率
  2. fixedDelay 固定延遲
  3. cron 自定義cron表示式 那麼接下來,我們講解下具體的實現方式。

fixedRate

首先,需要在啟動類上新增@EnableScheduling註解:

package com.zwwhnly.springbootdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class SpringbootdemoApplication {
    
    /*其他程式碼*/
    
    public static void main(String[] args) {
        SpringApplication.run(SpringbootdemoApplication.class, args);
    }
}
複製程式碼

然後,新建一個定時任務測試類TestSchedule,該類需要新增註解@Component,

最後,新增一個測試方法,該方法新增註解@Scheduled,為了能看到效果,我們每隔5秒輸出下系統的當前時間,如下所示:

package com.zwwhnly.springbootdemo;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.text.SimpleDateFormat;
import java.util.Date;

@Component
public class TestSchedule {
    private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    // 每5秒執行一次
    @Scheduled(fixedRate = 5000)
    public void testFixedRate() {
        System.out.println("當前時間:" + simpleDateFormat.format(new Date()));
    }
}
複製程式碼

但是在實際專案中,不可能這麼規律,比如方法的執行時間超過了5秒呢(這個應該很常見),那麼彼時程式又是如何執行的呢?

我們先來修改下程式,讓方法的執行時間超過5秒:

// 每5秒執行一次
@Scheduled(fixedRate = 5000)
public void testFixedRate() {
    System.out.println("當前時間:" + simpleDateFormat.format(new Date()));
    try {
        Thread.sleep(6000);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
}
複製程式碼

我們可以看出,現在是每6秒輸出一次時間,由此我們可以得出結論:

  • 如果方法的執行時間超過了定義的固定頻率(比如5秒),那麼上一次任務執行完成後,會立即執行下一次任務。

fixedDelay

新增一個新方法testFixedDelay,這裡我們使用fixedDelay:

// 上次任務執行結束時間與下次任務執行開始的間隔時間為5s
@Scheduled(fixedDelay = 5000)
public void testFixedDelay()
{
   System.out.println("當前時間:" + simpleDateFormat.format(new Date()));
}
複製程式碼

也許你會很疑惑,這不是和fixedRate的執行結果一樣嘛,也是每隔5秒執行一次。

其實不然,否則Spring Boot怎麼會同時支援fixedRate和fixedDelay呢,功能一樣,還容易混淆。

fixedRate與fixedDelay的區別

為了讓你更清晰的看到fixedRate與fixedDelay的區別,我們修改下fixedDelay方法,仍然是讓它的執行時間超過5秒:

// 上次任務執行結束時間與下次任務執行開始的間隔時間為5s
@Scheduled(fixedDelay = 5000)
public void testFixedDelay() {
    System.out.println("當前時間:" + simpleDateFormat.format(new Date()));
    try {
        Thread.sleep(6000);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
}
複製程式碼

現在兩次輸出時間的間隔為11秒,由此我們可以得出結論:

使用fixedDelay,上一次任務執行完成後,會延遲5秒再執行下一次任務。 看到這裡,是不是明白了fixedRate與fixedDelay的區別呢,通俗講就是:

  • fixedRate是固定頻率執行,fixedDelay是延遲固定時間執行。

cron

相比於上面講的兩種方式,cron表示式顯得更加靈活,因為它基本滿足各種場景的配置需求,比如固定頻率執行,固定某個時間點執行等。

首先,我們使用cron表示式實現上述例子中的每隔5秒執行一次:

@Scheduled(cron = "0/5 * * * * ?")
public void testCron() {
    System.out.println("當前時間:" + simpleDateFormat.format(new Date()));
}
複製程式碼

手動設定方法的執行時間超過5秒:

@Scheduled(cron = "0/5 * * * * ?")
public void testCron() {
    System.out.println("當前時間:" + simpleDateFormat.format(new Date()));
    try {
        Thread.sleep(6000);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
}
複製程式碼

相關文章