Spring Boot2 系列教程(十六)定時任務的兩種實現方式
- 2019 年 10 月 25 日
- 筆記
在 Spring + SpringMVC 環境中，一般來說，要實現定時任務，我們有兩中方案，一種是使用 Spring 自帶的定時任務處理器 @Scheduled 註解，另一種就是使用第三方框架 Quartz ，Spring Boot 源自 Spring+SpringMVC ，因此天然具備這兩個 Spring 中的定時任務實現策略，當然也支援 Quartz，本文我們就來看下 Spring Boot 中兩種定時任務的實現方式。
@Scheduled
使用 @Scheduled 非常容易，直接創建一個 Spring Boot 項目，並且添加 web 依賴 spring-boot-starter-web，項目創建成功後，添加 @EnableScheduling 註解，開啟定時任務：
@SpringBootApplication @EnableScheduling public class ScheduledApplication { public static void main(String[] args) { SpringApplication.run(ScheduledApplication.class, args); } }接下來配置定時任務：
@Scheduled(fixedRate = 2000) public void fixedRate() { System.out.println("fixedRate>>>"+new Date()); } @Scheduled(fixedDelay = 2000) public void fixedDelay() { System.out.println("fixedDelay>>>"+new Date()); } @Scheduled(initialDelay = 2000,fixedDelay = 2000) public void initialDelay() { System.out.println("initialDelay>>>"+new Date()); }- 首先使用 @Scheduled 註解開啟一個定時任務。
- fixedRate 表示任務執行之間的時間間隔，具體是指兩次任務的開始時間間隔，即第二次任務開始時，第一次任務可能還沒結束。
- fixedDelay 表示任務執行之間的時間間隔，具體是指本次任務結束到下次任務開始之間的時間間隔。
- initialDelay 表示首次任務啟動的延遲時間。
- 所有時間的單位都是毫秒。
上面這是一個基本用法，除了這幾個基本屬性之外，@Scheduled 註解也支援 cron 表達式，使用 cron 表達式，可以非常豐富的描述定時任務的時間。cron 表達式格式如下：
[秒] [分] [小時] [日] [月] [周] [年]
具體取值如下：
| 序號 | 說明 | 是否必填 | 允許填寫的值 | 允許的通配符 |
|---|---|---|---|---|
| 1 | 秒 | 是 | 0-59 | – * / |
| 2 | 分 | 是 | 0-59 | – * / |
| 3 | 時 | 是 | 0-23 | – * / |
| 4 | 日 | 是 | 1-31 | – * ? / L W |
| 5 | 月 | 是 | 1-12 or JAN-DEC | – * / |
| 6 | 周 | 是 | 1-7 or SUN-SAT | – * ? / L ## |
| 7 | 年 | 否 | 1970-2099 | – * / |
這一塊需要大家注意的是，月份中的日期和星期可能會起衝突，因此在配置時這兩個得有一個是 ?
通配符含義：
?表示不指定值，即不關心某個欄位的取值時使用。需要注意的是，月份中的日期和星期可能會起衝突，因此在配置時這兩個得有一個是?*表示所有值，例如:在秒的欄位上設置*,表示每一秒都會觸發,用來分開多個值，例如在周欄位上設置 "MON,WED,FRI" 表示周一，周三和周五觸發-表示區間，例如在秒上設置 "10-12",表示 10,11,12秒都會觸發/用於遞增觸發，如在秒上面設置"5/15" 表示從5秒開始，每增15秒觸發(5,20,35,50)##序號(表示每月的第幾個周幾)，例如在周欄位上設置"6##3"表示在每月的第三個周六，(用 在母親節和父親節再合適不過了)- 周欄位的設置，若使用英文字母是不區分大小寫的 ，即 MON 與mon相同
L表示最後的意思。在日欄位設置上，表示當月的最後一天(依據當前月份，如果是二月還會自動判斷是否是潤年), 在周欄位上表示星期六，相當於"7"或"SAT"（注意周日算是第一天）。如果在"L"前加上數字，則表示該數據的最後一個。例如在周欄位上設置"6L"這樣的格式,則表示"本月最後一個星期五"W表示離指定日期的最近工作日(周一至周五)，例如在日欄位上設置"15W"，表示離每月15號最近的那個工作日觸發。如果15號正好是周六，則找最近的周五(14號)觸發, 如果15號是周未，則找最近的下周一(16號)觸發，如果15號正好在工作日(周一至周五)，則就在該天觸發。如果指定格式為 "1W",它則表示每月1號往後最近的工作日觸發。如果1號正是周六，則將在3號下周一觸發。(注，"W"前只能設置具體的數字,不允許區間"-")L和W可以一組合使用。如果在日欄位上設置"LW",則表示在本月的最後一個工作日觸發(一般指發工資 )
例如，在 @Scheduled 註解中來一個簡單的 cron 表達式，每隔5秒觸發一次，如下：
@Scheduled(cron = "0/5 * * * * *") public void cron() { System.out.println(new Date()); }上面介紹的是使用 @Scheduled 註解的方式來實現定時任務，接下來我們再來看看如何使用 Quartz 實現定時任務。
Quartz
一般在項目中，除非定時任務涉及到的業務實在是太簡單，使用 @Scheduled 註解來解決定時任務，否則大部分情況可能都是使用 Quartz 來做定時任務。在 Spring Boot 中使用 Quartz ，只需要在創建項目時，添加 Quartz 依賴即可：
項目創建完成後，也需要添加開啟定時任務的註解：
@SpringBootApplication @EnableScheduling public class QuartzApplication { public static void main(String[] args) { SpringApplication.run(QuartzApplication.class, args); } }Quartz 在使用過程中，有兩個關鍵概念，一個是JobDetail（要做的事情），另一個是觸發器（什麼時候做），要定義 JobDetail，需要先定義 Job，Job 的定義有兩種方式：
第一種方式，直接定義一個Bean：
@Component public class MyJob1 { public void sayHello() { System.out.println("MyJob1>>>"+new Date()); } }關於這種定義方式說兩點：
- 首先將這個 Job 註冊到 Spring 容器中。
- 這種定義方式有一個缺陷，就是無法傳參。
第二種定義方式，則是繼承 QuartzJobBean 並實現默認的方法：
public class MyJob2 extends QuartzJobBean { HelloService helloService; public HelloService getHelloService() { return helloService; } public void setHelloService(HelloService helloService) { this.helloService = helloService; } @Override protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException { helloService.sayHello(); } } public class HelloService { public void sayHello() { System.out.println("hello service >>>"+new Date()); } }和第1種方式相比，這種方式支援傳參，任務啟動時，executeInternal 方法將會被執行。
Job 有了之後，接下來創建類，配置 JobDetail 和 Trigger 觸發器，如下：
@Configuration public class QuartzConfig { @Bean MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean() { MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean(); bean.setTargetBeanName("myJob1"); bean.setTargetMethod("sayHello"); return bean; } @Bean JobDetailFactoryBean jobDetailFactoryBean() { JobDetailFactoryBean bean = new JobDetailFactoryBean(); bean.setJobClass(MyJob2.class); JobDataMap map = new JobDataMap(); map.put("helloService", helloService()); bean.setJobDataMap(map); return bean; } @Bean SimpleTriggerFactoryBean simpleTriggerFactoryBean() { SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean(); bean.setStartTime(new Date()); bean.setRepeatCount(5); bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject()); bean.setRepeatInterval(3000); return bean; } @Bean CronTriggerFactoryBean cronTrigger() { CronTriggerFactoryBean bean = new CronTriggerFactoryBean(); bean.setCronExpression("0/10 * * * * ?"); bean.setJobDetail(jobDetailFactoryBean().getObject()); return bean; } @Bean SchedulerFactoryBean schedulerFactoryBean() { SchedulerFactoryBean bean = new SchedulerFactoryBean(); bean.setTriggers(cronTrigger().getObject(), simpleTriggerFactoryBean().getObject()); return bean; } @Bean HelloService helloService() { return new HelloService(); } }關於這個配置說如下幾點：
- JobDetail 的配置有兩種方式：MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。
- 使用 MethodInvokingJobDetailFactoryBean 可以配置目標 Bean 的名字和目標方法的名字，這種方式不支援傳參。
- 使用 JobDetailFactoryBean 可以配置 JobDetail ，任務類繼承自 QuartzJobBean ，這種方式支援傳參，將參數封裝在 JobDataMap 中進行傳遞。
- Trigger 是指觸發器，Quartz 中定義了多個觸發器，這裡向大家展示其中兩種的用法，SimpleTrigger 和 CronTrigger 。
- SimpleTrigger 有點類似於前面說的 @Scheduled 的基本用法。
- CronTrigger 則有點類似於 @Scheduled 中 cron 表達式的用法。
全部定義完成後，啟動 Spring Boot 項目就可以看到定時任務的執行了。
總結
這裡主要向大家展示了 Spring Boot 中整合兩種定時任務的方法，整合成功之後，剩下的用法基本上就和在 SSM 中使用一致了，不再贅述。本文案例我已經上傳到 GitHub ，歡迎大家 star：https://github.com/lenve/javaboy-code-samples
關注公眾號【江南一點雨】，專註於 Spring Boot+微服務以及前後端分離等全棧技術，定期影片教程分享，關注後回復 Java ，領取松哥為你精心準備的 Java 乾貨！
