一篇文章教你使用SpringBoot如何實現定時任務
前言
在 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); } }
接下來配置定時任務:
@Service public class HelloService { //前面任務的結束時間和後面任務的開始時間之間間隔2s @Scheduled(fixedDelay = 2000) public void fixedDelay() { System.out.println("fixedDelay>>"+new Date()); } //兩次定時任務開始的間隔時間為2s @Scheduled(fixedRate = 2000) public void fixedRate() { System.out.println("fixedRate>>"+new Date()); } @Scheduled(initialDelay = 2000,fixedDelay = 2000) public void initialDelay() { System.out.println("initialDelay>>>"+new Date()); } }
(1)首先使用 @Scheduled 註解開啟一個定時任務。
(2)fixedDelay 表示任務執行之間的時間間隔,具體是指本次任務結束到下次任務開始之間的時間間隔。
(3)fixedRate 表示任務執行之間的時間間隔,具體是指兩次任務的開始時間間隔,即第二次任務開始時,第一次任務可能還沒結束。
(4)initialDelay 表示首次任務啟動的延遲時間。
(5)所有時間的單位都是毫秒。
上面這是一個基本用法,除了這幾個基本屬性之外,@Scheduled 註解也支援 cron 表示式,使用 cron 表示式,可以非常豐富的描述定時任務的時間。cron 表示式格式如下:
[秒] [分] [小時] [日] [月] [周] [年]
這一塊需要大家注意的是,月份中的日期和星期可能會起衝突,因此在配置時這兩個得有一個是 ?
萬用字元含義:
(1)
?
表示不指定值,即不關心某個欄位的取值時使用。需要注意的是,月份中的日期和星期可能會起衝突,因此在配置時這兩個得有一個是 ?
(2)*
表示所有值,例如:在秒的欄位上設定*
,表示每一秒都會觸發
(3),
用來分開多個值,例如在周欄位上設定 “MON,WED,FRI” 表示週一,週三和週五觸發
(4)-
表示區間,例如在秒上設定 “10-12”,表示 10,11,12秒都會觸發
(5)/
用於遞增觸發,如在秒上面設定”5/15” 表示從5秒開始,每增15秒觸發(5,20,35,50)
(6)#
序號(表示每月的第幾個周幾),例如在周欄位上設定”6#3”表示在每月的第三個週六,(用 在母親節和父親節再合適不過了)
(7)周欄位的設定,若使用英文字母是不區分大小寫的 ,即 MON 與mon相同
(8)L
表示最後的意思。在日欄位設定上,表示當月的最後一天(依據當前月份,如果是二月還會自動判斷是否是潤年),在周欄位上表示星期六,相當於”7”或”SAT”(注意週日算是第一天)。如果在”L”前加上數字,則表示該資料的最後一個。例如在周欄位上設定”6L”這樣的格式,則表示”本月最後一個星期五”
(9)W
表示離指定日期的最近工作日(週一至週五),例如在日欄位上設定”15W”,表示離每月15號最近的那個工作日觸發。如果15號正好是週六,則找最近的週五(14號)觸發,如果15號是周未,則找最近的下週一(16號)觸發,如果15號正好在工作日(週一至週五),則就在該天觸發。如果指定格式為 “1W”,它則表示每月1號往後最近的工作日觸發。如果1號正是週六,則將在3號下週一觸發。(注,”W”前只能設定具體的數字,不允許區間”-“)
(10)L
和W
可以一組合使用。如果在日欄位上設定”LW”,則表示在本月的最後一個工作日觸發(一般指發工資 )
在 @Scheduled 註解中來一個簡單的 cron 表示式,每隔5秒觸發一次
@Scheduled(cron = "0/5 * * * * ?") public void cron() { System.out.println("cron>>"+new Date()); }
二、第二種方式: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 MyFirstJob { public void sayHello() { System.out.println("first job say hello:" + new Date()); } }
關於這種定義方式說兩點:
(1)首先將這個 Job 註冊到 Spring 容器中。
(2)這種定義方式有一個缺陷,就是無法傳參。
第二種定義方式,則是繼承 QuartzJobBean 並實現預設的方法:
public class MySecondJob extends QuartzJobBean { private String name; public void setName(String name) { this.name = name; } @Override protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException { System.out.println("second job say hello:" + name + ":" + new Date()); } }
和第1種方式相比,這種方式支援傳參,任務啟動時,executeInternal 方法將會被執行。
Job 有了之後,接下來建立類,配置 JobDetail 和 Trigger 觸發器,如下:
@Configuration public class QuartzConfig { @Bean MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean() { MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean(); bean.setTargetBeanName("myFirstJob"); bean.setTargetMethod("sayHello"); return bean; } @Bean JobDetailFactoryBean jobDetailFactoryBean() { JobDetailFactoryBean bean = new JobDetailFactoryBean(); JobDataMap map = new JobDataMap(); map.put("name","Yolo"); bean.setJobDataMap(map); bean.setJobClass(MySecondJob.class); return bean; } @Bean SimpleTriggerFactoryBean simpleTriggerFactoryBean() { SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean(); bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject()); bean.setStartTime(new Date()); bean.setRepeatInterval(2000); bean.setRepeatCount(3); return bean; } @Bean CronTriggerFactoryBean cronTriggerFactoryBean() { CronTriggerFactoryBean bean = new CronTriggerFactoryBean(); bean.setJobDetail(jobDetailFactoryBean().getObject()); bean.setCronExpression("* * * * * ?"); return bean; } @Bean SchedulerFactoryBean schedulerFactoryBean() { SchedulerFactoryBean bean = new SchedulerFactoryBean(); bean.setTriggers(simpleTriggerFactoryBean().getObject(),cronTriggerFactoryBean().getObject()); return bean; } @Bean HelloService helloService() { return new HelloService(); } }
配置說明:
(1)JobDetail 的配置有兩種方式:
MethodInvokingJobDetailFactoryBean
和JobDetailFactoryBean
。
(2)使用MethodInvokingJobDetailFactoryBean
可以配置目標 Bean 的名字和目標方法的名字,這種方式不支援傳參。
(3)使用JobDetailFactoryBean
可以配置JobDetail
,任務類繼承自QuartzJobBean
,這種方式支援傳參,將引數封裝在JobDataMap
中進行傳遞。
(4)Trigger
是指觸發器,Quartz
中定義了多個觸發器,這裡向大家展示其中兩種的用法,SimpleTrigger
和CronTrigger
。
(5)SimpleTrigger
有點類似於前面說的@Scheduled
的基本用法。
(6)CronTrigger
則有點類似於@Scheduled
中cron
表示式的用法。
可以看到 SimpleTriggerFactoryBean 控制 first job,間隔兩秒列印,列印 3 次
CronTriggerFactoryBean 控制 second job,每隔一秒列印一次
總結
到此這篇關於一篇文章教你使用SpringBoot如何實現定時任務的文章就介紹到這了,更多相關SpringBoot實現定時任務內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!