SpringBoot 定時任務 || cron表達式


 

 

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

  • Timer:這是java自帶的java.util.Timer類,這個類允許你調度一個java.util.TimerTask任務。使用這種方式可以讓你的程序按照某一個頻度執行,但不能在指定時間運行。一般用的較少。
  • ScheduledExecutorService:也jdk自帶的一個類;是基於線程池設計的定時任務類,每個調度任務都會分配到線程池中的一個線程去執行,也就是說,任務是並發執行,互不影響。
  • Spring Task:Spring3.0以后自帶的task,可以將它看成一個輕量級的Quartz,而且使用起來比Quartz簡單許多。
  • Quartz:這是一個功能比較強大的的調度器,可以讓你的程序在指定時間執行,也可以按照某一個頻度執行,配置起來稍顯復雜。

Timer與ScheduledExecutorService有篇已經介紹到了,這里不在做介紹。

使用Spring Task

##簡單的定時任務

在SpringBoot項目中,我們可以很優雅的使用注解來實現定時任務,首先創建項目,導入依賴:

復制代碼
 1 <dependencies>
 2 <dependency>
 3 <groupId>org.springframework.boot</groupId>
 4 <artifactId>spring-boot-starter-web</artifactId>
 5 </dependency>
 6 <dependency>
 7 <groupId>org.springframework.boot</groupId>
 8 <artifactId>spring-boot-starter</artifactId>
 9 </dependency>
10 <dependency>
11 <groupId>org.projectlombok</groupId>
12 <artifactId>lombok</artifactId>
13 <optional>true</optional>
14 </dependency>
15 <dependency>
16 <groupId>org.springframework.boot</groupId>
17 <artifactId>spring-boot-starter-test</artifactId>
18 <scope>test</scope>
19 </dependency>
20 </dependencies>
復制代碼

創建任務類:

復制代碼
 1 @Slf4j
 2 @Component
 3 public class ScheduledService {
 4     @Scheduled(cron = "0/5 * * * * *")
 5     public void scheduled(){
 6         log.info("=====>>>>>使用cron  {}",System.currentTimeMillis());
 7     }
 8     @Scheduled(fixedRate = 5000)
 9     public void scheduled1() {
10         log.info("=====>>>>>使用fixedRate{}", System.currentTimeMillis());
11     }
12     @Scheduled(fixedDelay = 5000)
13     public void scheduled2() {
14         log.info("=====>>>>>fixedDelay{}",System.currentTimeMillis());
15     }
16 }
復制代碼

在主類上使用@EnableScheduling注解開啟對定時任務的支持,然后啟動項目創建任務類:

按 Ctrl+C 復制代碼
按 Ctrl+C 復制代碼

運行結果:

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

多線程執行

在傳統的Spring項目中,我們可以在xml配置文件添加task的配置,而在SpringBoot項目中一般使用config配置類的方式添加配置,所以新建一個AsyncConfig類

復制代碼
 1 @Configuration
 2 @EnableAsync
 3 public class AsyncConfig {
 4 /*
 5 此處成員變量應該使用@Value從配置中讀取
 6 */
 7 private int corePoolSize = 10;
 8 private int maxPoolSize = 200;
 9 private int queueCapacity = 10;
10 @Bean
11 public Executor taskExecutor() {
12 ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
13 executor.setCorePoolSize(corePoolSize);
14 executor.setMaxPoolSize(maxPoolSize);
15 executor.setQueueCapacity(queueCapacity);
16 executor.initialize();
17 return executor;
18 }
19 }
復制代碼

@Configuration:表明該類是一個配置類 

@EnableAsync:開啟異步事件的支持

然后在定時任務的類或者方法上添加@Async 。最后重啟項目,每一個任務都是在不同的線程中

執行時間的配置

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

  1. fixedRate:定義一個按一定頻率執行的定時任務
  2. fixedDelay:定義一個按一定頻率執行的定時任務,與上面不同的是,改屬性可以配合initialDelay, 定義該任務延遲執行時間。
  3. cron:通過表達式來配置任務執行時間

cron表達式詳解

Cron表達式是一個字符串,字符串以5或6個空格隔開,分為6或7個域,每一個域代表一個含義,Cron有如下兩種語法格式:

  (1) Seconds Minutes Hours DayofMonth Month DayofWeek Year

  (2)Seconds Minutes Hours DayofMonth Month DayofWeek

  

  一、結構

  corn從左到右(用空格隔開):秒 分 小時 月份中的日期 月份 星期中的日期 年份

  二、各字段的含義

 
字段 允許值 允許的特殊字符
秒(Seconds) 0~59的整數 , - * /    四個字符
分(Minutes 0~59的整數 , - * /    四個字符
小時(Hours 0~23的整數 , - * /    四個字符
日期(DayofMonth 1~31的整數(但是你需要考慮你月的天數) ,- * ? / L W C     八個字符
月份(Month 1~12的整數或者 JAN-DEC , - * /    四個字符
星期(DayofWeek 1~7的整數或者 SUN-SAT (1=SUN) , - * ? / L C #     八個字符
年(可選,留空)(Year 1970~2099 , - * /    四個字符

 

 

 

 

 

 

 

 

 

 

注意事項:

  每一個域都使用數字,但還可以出現如下特殊字符,它們的含義是:

  (1)*:表示匹配該域的任意值。假如在Minutes域使用*, 即表示每分鍾都會觸發事件。

  (2)?:只能用在DayofMonth和DayofWeek兩個域。它也匹配域的任意值,但實際不會。因為DayofMonth和DayofWeek會相互影響。例如想在每月的20日觸發調度,不管20日到底是星期幾,則只能使用如下寫法: 13 13 15 20 * ?, 其中最后一位只能用?,而不能使用*,如果使用*表示不管星期幾都會觸發,實際上並不是這樣。

  (3)-:表示范圍。例如在Minutes域使用5-20,表示從5分到20分鍾每分鍾觸發一次 

  (4)/:表示起始時間開始觸發,然后每隔固定時間觸發一次。例如在Minutes域使用5/20,則意味着5分鍾觸發一次,而25,45等分別觸發一次. 

  (5),:表示列出枚舉值。例如:在Minutes域使用5,20,則意味着在5和20分每分鍾觸發一次。 

  (6)L:表示最后,只能出現在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一個星期四觸發。 

  (7)W:表示有效工作日(周一到周五),只能出現在DayofMonth域,系統將在離指定日期的最近的有效工作日觸發事件。例如:在 DayofMonth使用5W,如果5日是星期六,則將在最近的工作日:星期五,即4日觸發。如果5日是星期天,則在6日(周一)觸發;如果5日在星期一到星期五中的一天,則就在5日觸發。另外一點,W的最近尋找不會跨過月份 。

  (8)LW:這兩個字符可以連用,表示在某個月最后一個工作日,即最后一個星期五。 

  (9)#:用於確定每個月第幾個星期幾,只能出現在DayofMonth域。例如在4#2,表示某月的第二個星期三。

  三、常用表達式例子

  (1)0 0 2 1 * ? *   表示在每月的1日的凌晨2點調整任務

  (2)0 15 10 ? * MON-FRI   表示周一到周五每天上午10:15執行作業

  (3)0 15 10 ? 6L 2002-2006   表示2002-2006年的每個月的最后一個星期五上午10:15執行作

  (4)0 0 10,14,16 * * ?   每天上午10點,下午2點,4點 

  (5)0 0/30 9-17 * * ?   朝九晚五工作時間內每半小時 

  (6)0 0 12 ? * WED    表示每個星期三中午12點 

  (7)0 0 12 * * ?   每天中午12點觸發 

  (8)0 15 10 ? * *    每天上午10:15觸發 

  (9)0 15 10 * * ?     每天上午10:15觸發 

  (10)0 15 10 * * ? *    每天上午10:15觸發 

  (11)0 15 10 * * ? 2005    2005年的每天上午10:15觸發 

  (12)0 * 14 * * ?     在每天下午2點到下午2:59期間的每1分鍾觸發 

  (13)0 0/5 14 * * ?    在每天下午2點到下午2:55期間的每5分鍾觸發 

  (14)0 0/5 14,18 * * ?     在每天下午2點到2:55期間和下午6點到6:55期間的每5分鍾觸發 

  (15)0 0-5 14 * * ?    在每天下午2點到下午2:05期間的每1分鍾觸發 

  (16)0 10,44 14 ? 3 WED    每年三月的星期三的下午2:10和2:44觸發 

  (17)0 15 10 ? * MON-FRI    周一至周五的上午10:15觸發 

  (18)0 15 10 15 * ?    每月15日上午10:15觸發 

  (19)0 15 10 L * ?    每月最后一日的上午10:15觸發 

  (20)0 15 10 ? * 6L    每月的最后一個星期五上午10:15觸發 

  (21)0 15 10 ? * 6L 2002-2005   2002年至2005年的每月的最后一個星期五上午10:15觸發 

  (22)0 15 10 ? * 6#3   每月的第三個星期五上午10:15觸發

 

  

  注:

  (1)有些子表達式能包含一些范圍或列表

  例如:子表達式(天(星期))可以為 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”

“*”字符代表所有可能的值

  因此,“*”在子表達式(月)里表示每個月的含義,“*”在子表達式(天(星期))表示星期的每一天


  “/”字符用來指定數值的增量 
  例如:在子表達式(分鍾)里的“0/15”表示從第0分鍾開始,每15分鍾 
在子表達式(分鍾)里的“3/20”表示從第3分鍾開始,每20分鍾(它和“3,23,43”)的含義一樣


  “?”字符僅被用於天(月)和天(星期)兩個子表達式,表示不指定值 
  當2個子表達式其中之一被指定了值以后,為了避免沖突,需要將另一個子表達式的值設為“?”

  “L” 字符僅被用於天(月)和天(星期)兩個子表達式,它是單詞“last”的縮寫 
  但是它在兩個子表達式里的含義是不同的。 
  在天(月)子表達式中,“L”表示一個月的最后一天 
  在天(星期)自表達式中,“L”表示一個星期的最后一天,也就是SAT

  如果在“L”前有具體的內容,它就具有其他的含義了

  例如:“6L”表示這個月的倒數第6天,“FRIL”表示這個月的最一個星期五 
  注意:在使用“L”參數時,不要指定列表或范圍,因為這會導致問題

整合Quartz

  • 添加依賴

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

1 <dependency>
2     <groupId>org.springframework.boot</groupId>
3     <artifactId>spring-boot-starter-quartz</artifactId>
4 </dependency>

如果是1.5.9則要使用以下添加依賴:

 

復制代碼
1 <dependency>
2   <groupId>org.quartz-scheduler</groupId>
3   <artifactId>quartz</artifactId>
4   <version>2.3.0</version>
5 </dependency>
6 <dependency>
7   <groupId>org.springframework</groupId>
8   <artifactId>spring-context-support</artifactId>
9 </dependency>
復制代碼

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

創建任務類TestQuartz,該類主要是繼承了QuartzJobBean

  • 復制代碼
     1 public class TestQuartz extends QuartzJobBean {
     2     /**
     3      * 執行定時任務
     4      * @param jobExecutionContext
     5      * @throws JobExecutionException
     6      */
     7     @Override
     8     protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
     9         System.out.println("quartz task "+new Date());
    10     }
    11 }
    復制代碼


創建配置類QuartzConfig

復制代碼
 1 @Configuration
 2 public class QuartzConfig {
 3     @Bean
 4     public JobDetail teatQuartzDetail(){
 5         return JobBuilder.newJob(TestQuartz.class).withIdentity("testQuartz").storeDurably().build();
 6     }
 7 
 8     @Bean
 9     public Trigger testQuartzTrigger(){
10         SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
11                 .withIntervalInSeconds(10)  //設置時間周期單位秒
12                 .repeatForever();
13         return TriggerBuilder.newTrigger().forJob(teatQuartzDetail())
14                 .withIdentity("testQuartz")
15                 .withSchedule(scheduleBuilder)
16                 .build();
17     }
18 }
復制代碼
  • 啟動項目

參考

 http://www.wanqhblog.top/2018/02/01/SpringBootTaskSchedule/


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM