SpringBoot 幾種定時任務的實現方式

定時任務實現的幾種方式：

• Timer：這是java自帶的java.util.Timer類，這個類允許你排程一個java.util.TimerTask任務。使用這種方式可以讓你的程式按照某一個頻度執行，但不能在指定時間執行。一般用的較少。

• ScheduledExecutorService：也jdk自帶的一個類；是基於執行緒池設計的定時任務類,每個排程任務都會分配到執行緒池中的一個執行緒去執行,也就是說,任務是併發執行,互不影響。

• Spring Task：Spring3.0以後自帶的task，可以將它看成一個輕量級的Quartz，而且使用起來比Quartz簡單許多。

• Quartz：這是一個功能比較強大的的排程器，可以讓你的程式在指定時間執行，也可以按照某一個頻度執行，配置起來稍顯複雜。

使用Timer

這個目前在專案中用的較少，直接貼demo程式碼。具體的介紹可以檢視api

public class TestTimer {

    public static void main(String[] args) {

        TimerTask timerTask = new TimerTask() {

            @Override

            public void run() {

                System.out.println("task  run:"+ new Date());

            }

        };

        Timer timer = new Timer();

        //安排指定的任務在指定的時間開始進行重複的固定延遲執行。這裡是每3秒執行一次

        timer.schedule(timerTask,10,3000);

    }

}

使用ScheduledExecutorService

該方法跟Timer類似，直接看demo：

public class TestScheduledExecutorService {

    public static void main(String[] args) {

        ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();

        // 引數：1、任務體 2、首次執行的延時時間

        //      3、任務執行間隔 4、間隔時間單位

        service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService "+new Date()), 0, 3, TimeUnit.SECONDS);

    }

}

使用Spring Task

簡單的定時任務

在SpringBoot專案中，我們可以很優雅的使用註解來實現定時任務，首先建立專案，匯入依賴：

<dependencies>

  <dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-web</artifactId>

  </dependency>

  <dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter</artifactId>

  </dependency>

  <dependency>

    <groupId>org.projectlombok</groupId>

    <artifactId>lombok</artifactId>

    <optional>true</optional>

  </dependency>

  <dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-test</artifactId>

    <scope>test</scope>

  </dependency>

</dependencies>

建立任務類：

@Slf4j

@Component

public class ScheduledService {

    @Scheduled(cron = "0/5 * * * * *")

    public void scheduled(){

        log.info("=====>>>>>使用cron  {}",System.currentTimeMillis());

    }

    @Scheduled(fixedRate = 5000)

    public void scheduled1() {

        log.info("=====>>>>>使用fixedRate{}", System.currentTimeMillis());

    }

    @Scheduled(fixedDelay = 5000)

    public void scheduled2() {

        log.info("=====>>>>>fixedDelay{}",System.currentTimeMillis());

    }

}

在主類上使用@EnableScheduling註解開啟對定時任務的支援，然後啟動專案

可以看到三個定時任務都已經執行，並且使同一個執行緒中序列執行，如果只有一個定時任務，這樣做肯定沒問題，當定時任務增多，如果一個任務卡死，會導致其他任務也無法執行。

多執行緒執行

在傳統的Spring專案中，我們可以在xml配置檔案新增task的配置，而在SpringBoot專案中一般使用config配置類的方式新增配置，所以新建一個AsyncConfig類

@Configuration

@EnableAsync

public class AsyncConfig {

     /*

    此處成員變數應該使用@Value從配置中讀取

     */

    private int corePoolSize = 10;

    private int maxPoolSize = 200;

    private int queueCapacity = 10;

    @Bean

    public Executor taskExecutor() {

        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();

        executor.setCorePoolSize(corePoolSize);

        executor.setMaxPoolSize(maxPoolSize);

        executor.setQueueCapacity(queueCapacity);

        executor.initialize();

        return executor;

    }

}

@Configuration：表明該類是一個配置類
@EnableAsync：開啟非同步事件的支援

然後在定時任務的類或者方法上新增@Async 。最後重啟專案，每一個任務都是在不同的執行緒中

執行時間的配置

在上面的定時任務中，我們在方法上使用@Scheduled註解來設定任務的執行時間，並且使用三種屬性配置方式：

fixedRate：定義一個按一定頻率執行的定時任務

fixedDelay：定義一個按一定頻率執行的定時任務，與上面不同的是，改屬性可以配合initialDelay， 定義該任務延遲執行時間。

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）

年份（1970－2099）

其中每個元素可以是一個值(如6),一個連續區間(9-12),一個間隔時間(8-18/4)(/表示每隔4小時),一個列表(1,3,5),萬用字元。由於”月份中的日期”和”星期中的日期”這兩個元素互斥的,必須要對其中一個設定。配置例項：

每隔5秒執行一次：/5 * ?

每隔1分鐘執行一次：0 /1 ?

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觸發

有些子表示式能包含一些範圍或列表

例如：子表示式（天（星期））可以為 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”

“*”字元代表所有可能的值
“/”字元用來指定數值的增量

例如：在子表示式（分鐘）裡的“0/15”表示從第0分鐘開始，每15分鐘
在子表示式（分鐘）裡的“3/20”表示從第3分鐘開始，每20分鐘（它和“3，23，43”）的含義一樣

“？”字元僅被用於天（月）和天（星期）兩個子表示式，表示不指定值
當2個子表示式其中之一被指定了值以後，為了避免衝突，需要將另一個子表示式的值設為“？”

“L” 字元僅被用於天（月）和天（星期）兩個子表示式，它是單詞“last”的縮寫
如果在“L”前有具體的內容，它就具有其他的含義了。

例如：“6L”表示這個月的倒數第６天
注意：在使用“L”引數時，不要指定列表或範圍，因為這會導致問題

W 字元代表著平日(Mon-Fri)，並且僅能用於日域中。它用來指定離指定日的最近的一個平日。大部分的商業處理都是基於工作周的，所以 W 字元可能是非常重要的。

例如，日域中的 15W 意味著 “離該月15號的最近一個平日。” 假如15號是星期六，那麼 trigger 會在14號(星期五)觸發，因為星期四比星期一離15號更近。

C：代表“Calendar”的意思。它的意思是計劃所關聯的日期，如果日期沒有被關聯，則相當於日曆中所有日期。

例如5C在日期欄位中就相當於日曆5日以後的第一天。1C在星期欄位中相當於星期日後的第一天。

欄位    允許值 允許的特殊字元
秒    0~59    , - * /
分    0~59    , - * /
小時    0~23    , - * /
日期    1-31    , - * ? / L W C
月份    1~12或者JAN~DEC   , - * /
星期    1~7或者SUN~SAT    , - * ? / L C #
年（可選）    留空，1970~2099    , - * /
線上cron表示式生成：http://qqe2.com/cron/index

整合Quartz

新增依賴

如果SpringBoot版本是2.0.0以後的，則在spring-boot-starter中已經包含了quart的依賴，則可以直接使用spring-boot-starter-quartz依賴：

<dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-quartz</artifactId>

</dependency>

如果是1.5.9則要使用以下新增依賴：

<dependency>

  <groupId>org.quartz-scheduler</groupId>

  <artifactId>quartz</artifactId>

  <version>2.3.0</version>

</dependency>

<dependency>

  <groupId>org.springframework</groupId>

  <artifactId>spring-context-support</artifactId>

</dependency>

這裡我使用SpringBoot版本是2.0.0.BUILD-SNAPSHOT ，該版本開始集成了Quartz，所以事實現起來很方便。其它好像比較麻煩，這裡就不介紹，以後有時間再詳細深入瞭解Quartz。

建立任務類TestQuartz，該類主要是繼承了QuartzJobBean

public class TestQuartz extends QuartzJobBean {

    /**

     * 執行定時任務

     * @param jobExecutionContext

     * @throws JobExecutionException

     */

    @Override

    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {

        System.out.println("quartz task "+new Date());

    }

}

建立配置類QuartzConfig

@Configuration

public class QuartzConfig {

    @Bean

    public JobDetail teatQuartzDetail(){

        return JobBuilder.newJob(TestQuartz.class).withIdentity("testQuartz").storeDurably().build();

    }

    @Bean

    public Trigger testQuartzTrigger(){

        SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()

                .withIntervalInSeconds(10)  //設定時間週期單位秒

                .repeatForever();

        return TriggerBuilder.newTrigger().forJob(teatQuartzDetail())

                .withIdentity("testQuartz")

                .withSchedule(scheduleBuilder)

                .build();

    }

}

啟動專案

上面都是簡單的介紹了關於SpringBoot定時任務的處理，直接使用SpringTask註解的方式應該是最方便的，而使用Quartz從2.0開始也變得很方便。對於這兩種方式，應該說各有長處吧，按需選擇。另外關於Quartz的詳細內容可以檢視官方文件

本文摘自

作者：Wan QingHua

來源：http://www.wanqhblog.top/2018/02/01/SpringBootTaskSchedule/