SpringBoot定時(shí)任務(wù)及Cron表達(dá)式是怎樣的

這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)碛嘘P(guān)SpringBoot定時(shí)任務(wù)及Cron表達(dá)式是怎樣的，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

如何使用SpringBoot定時(shí)任務(wù)，并通過源碼說明如何使用多線程處理各定時(shí)任務(wù)。 詳細(xì)說明cron表達(dá)式用法。

一、定時(shí)任務(wù)概述

后臺(tái)項(xiàng)目開發(fā)中經(jīng)常會(huì)用到定時(shí)任務(wù)，現(xiàn)在實(shí)現(xiàn)定時(shí)任務(wù)都方式也是多種多樣。下面列舉幾種常見的定時(shí)任務(wù)實(shí)現(xiàn)方式：

1. Quartz：Quartz的使用相當(dāng)廣泛，它是一個(gè)功能強(qiáng)大的調(diào)度器，當(dāng)然使用起來也相對(duì)麻煩;

2. java.util包里的Timer，它也可以實(shí)現(xiàn)定時(shí)任務(wù)但是功能過于單一所有使用很少。

3.  就是我們今天要介紹的Spring自帶的定時(shí)任務(wù)Schedule，其實(shí)可以把它看作是一個(gè)簡(jiǎn)化版的，輕量級(jí)的Quartz，使用起來也相對(duì)方便很多。

二、實(shí)現(xiàn)定時(shí)任務(wù)

1. 創(chuàng)建定時(shí)任務(wù)

import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component;  /**  * Description: 構(gòu)建執(zhí)行定時(shí)任務(wù)  * Designer: jack  * Date: 2017/8/10  * Version: 1.0.0  */ @Component public class ScheduledTasks {      private Logger logger = LoggerFactory.getLogger(ScheduledTasks.class);      private int fixedDelayCount = 1;     private int fixedRateCount = 1;     private int initialDelayCount = 1;     private int cronCount = 1;      @Scheduled(fixedDelay = 5000)        //fixedDelay = 5000表示當(dāng)前方法執(zhí)行完畢5000ms后，Spring scheduling會(huì)再次調(diào)用該方法     public void testFixDelay() {         logger.info("===fixedDelay: 第{}次執(zhí)行方法", fixedDelayCount++);     }      @Scheduled(fixedRate = 5000)        //fixedRate = 5000表示當(dāng)前方法開始執(zhí)行5000ms后，Spring scheduling會(huì)再次調(diào)用該方法     public void testFixedRate() {         logger.info("===fixedRate: 第{}次執(zhí)行方法", fixedRateCount++);     }      @Scheduled(initialDelay = 1000, fixedRate = 5000)   //initialDelay = 1000表示延遲1000ms執(zhí)行***次任務(wù)     public void testInitialDelay() {         logger.info("===initialDelay: 第{}次執(zhí)行方法", initialDelayCount++);     }      @Scheduled(cron = "0 0/1 * * * ?")  //cron接受cron表達(dá)式，根據(jù)cron表達(dá)式確定定時(shí)規(guī)則     public void testCron() {         logger.info("===initialDelay: 第{}次執(zhí)行方法", cronCount++);     }  }

我們使用@Scheduled來創(chuàng)建定時(shí)任務(wù) 這個(gè)注解用來標(biāo)注一個(gè)定時(shí)任務(wù)方法。通過看@Scheduled源碼可以看出它支持多種參數(shù)：

(1)cron：cron表達(dá)式，指定任務(wù)在特定時(shí)間執(zhí)行;

(2)fixedDelay：表示上一次任務(wù)執(zhí)行完成后多久再次執(zhí)行，參數(shù)類型為long，單位ms;

(3)fixedDelayString：與fixedDelay含義一樣，只是參數(shù)類型變?yōu)镾tring;

(4)fixedRate：表示按一定的頻率執(zhí)行任務(wù)，參數(shù)類型為long，單位ms;

(5)fixedRateString: 與fixedRate的含義一樣，只是將參數(shù)類型變?yōu)镾tring;

(6)initialDelay：表示延遲多久再***次執(zhí)行任務(wù)，參數(shù)類型為long，單位ms;

(7)initialDelayString：與initialDelay的含義一樣，只是將參數(shù)類型變?yōu)镾tring;

(8)zone：時(shí)區(qū)，默認(rèn)為當(dāng)前時(shí)區(qū)，一般沒有用到。

2.開啟定時(shí)任務(wù)

import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.scheduling.annotation.EnableScheduling;  /**  * Description: 啟動(dòng)類  * Designer: jack  * Date: 2017/8/10  * Version: 1.0.0  */ @SpringBootApplication @EnableScheduling public class Application {     public static void main(String[] args) {         SpringApplication.run(Application.class, args);     } }

注意這里的 @EnableScheduling 注解，它的作用是發(fā)現(xiàn)注解@Scheduled的任務(wù)并由后臺(tái)執(zhí)行。沒有它的話將無法執(zhí)行定時(shí)任務(wù)。

引用官方文檔原文：

@EnableScheduling ensures that a background task executor is created. Without  it, nothing gets scheduled.

3. 執(zhí)行結(jié)果 (單線程)

到此我們就完成了一個(gè)簡(jiǎn)單的定時(shí)任務(wù)模型，下面執(zhí)行springBoot觀察執(zhí)行結(jié)果。

2017-08-11 12:06:19.738  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第1次執(zhí)行方法 2017-08-11 12:06:23.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedRate: 第2次執(zhí)行方法 2017-08-11 12:06:23.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第2次執(zhí)行方法 2017-08-11 12:06:24.738  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第2次執(zhí)行方法 2017-08-11 12:06:28.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedRate: 第3次執(zhí)行方法 2017-08-11 12:06:28.740  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第3次執(zhí)行方法 2017-08-11 12:06:29.739  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第3次執(zhí)行方法 2017-08-11 12:06:33.735  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedRate: 第4次執(zhí)行方法 2017-08-11 12:06:33.741  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第4次執(zhí)行方法 2017-08-11 12:06:34.738  INFO 52252 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===initialDelay: 第4次執(zhí)行方法

從控制臺(tái)輸入的結(jié)果中我們可以看出所有的定時(shí)任務(wù)都是在同一個(gè)線程池用同一個(gè)線程來處理的，那么我們?nèi)绾蝸聿l(fā)的處理各定時(shí)任務(wù)呢，請(qǐng)繼續(xù)向下看。

4. 多線程處理定時(shí)任務(wù)

看到控制臺(tái)輸出的結(jié)果，所有的定時(shí)任務(wù)都是通過一個(gè)線程來處理的，我估計(jì)是在定時(shí)任務(wù)的配置中設(shè)定了一個(gè)SingleThreadScheduledExecutor，于是我看了源碼，從ScheduledAnnotationBeanPostProcessor類開始一路找下去。果然，在ScheduledTaskRegistrar(定時(shí)任務(wù)注冊(cè)類)中的ScheduleTasks中又這樣一段判斷：

if (this.taskScheduler == null) {             this.localExecutor = Executors.newSingleThreadScheduledExecutor();             this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);         }

這就說明如果taskScheduler為空，那么就給定時(shí)任務(wù)做了一個(gè)單線程的線程池，正好在這個(gè)類中還有一個(gè)設(shè)置taskScheduler的方法：

public void setScheduler(Object scheduler) {         Assert.notNull(scheduler, "Scheduler object must not be null");         if (scheduler instanceof TaskScheduler) {             this.taskScheduler = (TaskScheduler) scheduler;         }         else if (scheduler instanceof ScheduledExecutorService) {             this.taskScheduler = new ConcurrentTaskScheduler(((ScheduledExecutorService) scheduler));         }         else {             throw new IllegalArgumentException("Unsupported scheduler type: " + scheduler.getClass());         }     }

這樣問題就很簡(jiǎn)單了，我們只需用調(diào)用這個(gè)方法顯式的設(shè)置一個(gè)ScheduledExecutorService就可以達(dá)到并發(fā)的效果了。我們要做的僅僅是實(shí)現(xiàn)SchedulingConfigurer接口，重寫configureTasks方法就OK了;

import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.SchedulingConfigurer; import org.springframework.scheduling.config.ScheduledTaskRegistrar;  import java.util.concurrent.Executors;  /**  * Description: 多線程執(zhí)行定時(shí)任務(wù)  * Designer: jack  * Date: 2017/8/10  * Version: 1.0.0  */ @Configuration //所有的定時(shí)任務(wù)都放在一個(gè)線程池中，定時(shí)任務(wù)啟動(dòng)時(shí)使用不同都線程。 public class ScheduleConfig implements SchedulingConfigurer {     @Override     public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {         //設(shè)定一個(gè)長度10的定時(shí)任務(wù)線程池         taskRegistrar.setScheduler(Executors.newScheduledThreadPool(10));     } }

注:  最開始我試圖在ScheduledAnnotationBeanPostProcessor類中做文章，因?yàn)槔锩嬉灿幸粋€(gè)類似的方法setScheduler()，但是***失敗了，不知道是否可以通過這個(gè)類實(shí)現(xiàn)定時(shí)任務(wù)的并發(fā)，如果有實(shí)現(xiàn)了的也請(qǐng)告訴大家一下方法。

5. 執(zhí)行結(jié)果(并發(fā))

2017-08-11 12:21:16.000  INFO 52284 --- [pool-1-thread-3] com.test.ScheduledTasks                  : ===initialDelay: 第1次執(zhí)行方法 2017-08-11 12:21:19.998  INFO 52284 --- [pool-1-thread-4] com.test.ScheduledTasks                  : ===fixedRate: 第2次執(zhí)行方法 2017-08-11 12:21:19.998  INFO 52284 --- [pool-1-thread-1] com.test.ScheduledTasks                  : ===fixedDelay: 第2次執(zhí)行方法 2017-08-11 12:21:20.999  INFO 52284 --- [pool-1-thread-4] com.test.ScheduledTasks                  : ===initialDelay: 第2次執(zhí)行方法 2017-08-11 12:21:25.000  INFO 52284 --- [pool-1-thread-2] com.test.ScheduledTasks                  : ===fixedRate: 第3次執(zhí)行方法 2017-08-11 12:21:25.000  INFO 52284 --- [pool-1-thread-6] com.test.ScheduledTasks                  : ===fixedDelay: 第3次執(zhí)行方法 2017-08-11 12:21:25.997  INFO 52284 --- [pool-1-thread-3] com.test.ScheduledTasks                  : ===initialDelay: 第3次執(zhí)行方法 2017-08-11 12:21:30.000  INFO 52284 --- [pool-1-thread-7] com.test.ScheduledTasks                  : ===fixedRate: 第4次執(zhí)行方法 2017-08-11 12:21:30.000  INFO 52284 --- [pool-1-thread-8] com.test.ScheduledTasks                  : ===fixedDelay: 第4次執(zhí)行方法 2017-08-11 12:21:31.000  INFO 52284 --- [pool-1-thread-7] com.test.ScheduledTasks                  : ===initialDelay: 第4次執(zhí)行方法

通過控制臺(tái)輸出的結(jié)果看出每個(gè)定時(shí)任務(wù)都是在通過不同的線程來處理了。

三、cron詳解

1. cron表達(dá)式定義

Cron表達(dá)式是一個(gè)字符串，是由空格隔開的6或7個(gè)域組成，每一個(gè)域?qū)?yīng)一個(gè)含義(秒 分 時(shí) 每月第幾天 月 星期 年)其中年是可選字段。

但是，此處敲一下黑板，spring的schedule值支持6個(gè)域的表達(dá)式，也就是不能設(shè)定年，如果超過六個(gè)則會(huì)報(bào)錯(cuò)。源碼如下：

/**      * Parse the given pattern expression.      */     private void parse(String expression) throws IllegalArgumentException {         String[] fields = StringUtils.tokenizeToStringArray(expression, " ");         if (!areValidCronFields(fields)) {             throw new IllegalArgumentException(String.format(                     "Cron expression must consist of 6 fields (found %d in \"%s\")", fields.length, expression));         }         setNumberHits(this.seconds, fields[0], 0, 60);         setNumberHits(this.minutes, fields[1], 0, 60);         setNumberHits(this.hours, fields[2], 0, 24);         setDaysOfMonth(this.daysOfMonth, fields[3]);         setMonths(this.months, fields[4]);         setDays(this.daysOfWeek, replaceOrdinals(fields[5], "SUN,MON,TUE,WED,THU,FRI,SAT"), 8);         if (this.daysOfWeek.get(7)) {             // Sunday can be represented as 0 or 7             this.daysOfWeek.set(0);             this.daysOfWeek.clear(7);         }     }      private static boolean areValidCronFields(String[] fields) {         return (fields != null && fields.length == 6);     }

2. 每個(gè)域可出現(xiàn)的字符類型和各字符的含義

(1)各域支持的字符類型

秒：可出現(xiàn)", - * /"四個(gè)字符，有效范圍為0-59的整數(shù)

分：可出現(xiàn)", - * /"四個(gè)字符，有效范圍為0-59的整數(shù)

時(shí)：可出現(xiàn)", - * /"四個(gè)字符，有效范圍為0-23的整數(shù)

每月第幾天：可出現(xiàn)", - * / ? L W C"八個(gè)字符，有效范圍為0-31的整數(shù)

月：可出現(xiàn)", - * /"四個(gè)字符，有效范圍為1-12的整數(shù)或JAN-DEc

星期：可出現(xiàn)", - * / ? L C #"四個(gè)字符，有效范圍為1-7的整數(shù)或SUN-SAT兩個(gè)范圍。1表示星期天，2表示星期一， 依次類推

(2)特殊字符含義

* : 表示匹配該域的任意值，比如在秒*, 就表示每秒都會(huì)觸發(fā)事件。;

? : 只能用在每月第幾天和星期兩個(gè)域。表示不指定值，當(dāng)2個(gè)子表達(dá)式其中之一被指定了值以后，為了避免沖突，需要將另一個(gè)子表達(dá)式的值設(shè)為“?”;

- : 表示范圍，例如在分域使用5-20，表示從5分到20分鐘每分鐘觸發(fā)一次

/ : 表示起始時(shí)間開始觸發(fā)，然后每隔固定時(shí)間觸發(fā)一次，例如在分域使用5/20,則意味著5分，25分，45分，分別觸發(fā)一次.

, : 表示列出枚舉值。例如：在分域使用5,20，則意味著在5和20分時(shí)觸發(fā)一次。

L : 表示***，只能出現(xiàn)在星期和每月第幾天域，如果在星期域使用1L,意味著在***的一個(gè)星期日觸發(fā)。

W : 表示有效工作日(周一到周五),只能出現(xiàn)在每月第幾日域，系統(tǒng)將在離指定日期的最近的有效工作日觸發(fā)事件。注意一點(diǎn)，W的最近尋找不會(huì)跨過月份

LW : 這兩個(gè)字符可以連用，表示在某個(gè)月***一個(gè)工作日，即***一個(gè)星期五。

# : 用于確定每個(gè)月第幾個(gè)星期幾，只能出現(xiàn)在每月第幾天域。例如在1#3，表示某月的第三個(gè)星期日。

(3)表達(dá)式例子

引用spring官方注釋：

* <p>Example patterns:

* <ul>

* <li>"0 0 * * * *" = the top of every hour of every  day.</li>

* <li>"*/10 * * * * *" = every ten seconds.</li>

* <li>"0 0 8-10 * * *" = 8, 9 and 10 o'clock of every  day.</li>

* <li>"0 0/30 8-10 * * *" = 8:00, 8:30, 9:00, 9:30 and 10 o'clock every  day.</li>

* <li>"0 0 9-17 * * MON-FRI" = on the hour nine-to-five  weekdays</li>

* <li>"0 0 0 25 12 ?" = every Christmas Day at midnight</li>

"0 0 * * * *" 表示每小時(shí)0分0秒執(zhí)行一次

" */10 * * * * *" 表示每10秒執(zhí)行一次

"0 0 8-10 * * *" 表示每天8，9，10點(diǎn)執(zhí)行

"0 0/30 8-10 * * *" 表示每天8點(diǎn)到10點(diǎn)，每半小時(shí)執(zhí)行

"0 0 9-17 * * MON-FRI" 表示每周一至周五，9點(diǎn)到17點(diǎn)的0分0秒執(zhí)行

"0 0 0 25 12 ?" 表示每年圣誕節(jié)(12月25日)0時(shí)0分0秒執(zhí)行

上述就是小編為大家分享的SpringBoot定時(shí)任務(wù)及Cron表達(dá)式是怎樣的了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道。