一篇文章教你使用SpringBoot如何實(shí)現(xiàn)定時任務(wù)
前言
在 Spring + SpringMVC 環(huán)境中,一般來說,要實(shí)現(xiàn)定時任務(wù),我們有兩中方案,一種是使用 Spring 自帶的定時任務(wù)處理器 @Scheduled 注解,另一種就是使用第三方框架 Quartz ,Spring Boot 源自 Spring+SpringMVC ,因此天然具備這兩個 Spring 中的定時任務(wù)實(shí)現(xiàn)策略,當(dāng)然也支持 Quartz,本文我們就來看下 Spring Boot 中兩種定時任務(wù)的實(shí)現(xiàn)方式。
一、第一種方式:@Scheduled
使用 @Scheduled 非常容易,直接創(chuàng)建一個 Spring Boot 項(xiàng)目,并且添加 web 依賴 spring-boot-starter-web,項(xiàng)目創(chuàng)建成功后,添加 @EnableScheduling 注解,開啟定時任務(wù):
@SpringBootApplication @EnableScheduling public class ScheduledApplication { public static void main(String[] args) { SpringApplication.run(ScheduledApplication.class, args); } }
接下來配置定時任務(wù):
@Service public class HelloService { //前面任務(wù)的結(jié)束時間和后面任務(wù)的開始時間之間間隔2s @Scheduled(fixedDelay = 2000) public void fixedDelay() { System.out.println("fixedDelay>>"+new Date()); } //兩次定時任務(wù)開始的間隔時間為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 注解開啟一個定時任務(wù)。
(2)fixedDelay 表示任務(wù)執(zhí)行之間的時間間隔,具體是指本次任務(wù)結(jié)束到下次任務(wù)開始之間的時間間隔。
(3)fixedRate 表示任務(wù)執(zhí)行之間的時間間隔,具體是指兩次任務(wù)的開始時間間隔,即第二次任務(wù)開始時,第一次任務(wù)可能還沒結(jié)束。
(4)initialDelay 表示首次任務(wù)啟動的延遲時間。
(5)所有時間的單位都是毫秒。
上面這是一個基本用法,除了這幾個基本屬性之外,@Scheduled 注解也支持 cron 表達(dá)式,使用 cron 表達(dá)式,可以非常豐富的描述定時任務(wù)的時間。cron 表達(dá)式格式如下:
[秒] [分] [小時] [日] [月] [周] [年]
這一塊需要大家注意的是,月份中的日期和星期可能會起沖突,因此在配置時這兩個得有一個是 ?
通配符含義:
(1)
?
表示不指定值,即不關(guān)心某個字段的取值時使用。需要注意的是,月份中的日期和星期可能會起沖突,因此在配置時這兩個得有一個是 ?
(2)*
表示所有值,例如:在秒的字段上設(shè)置*
,表示每一秒都會觸發(fā)
(3),
用來分開多個值,例如在周字段上設(shè)置 “MON,WED,FRI” 表示周一,周三和周五觸發(fā)
(4)-
表示區(qū)間,例如在秒上設(shè)置 “10-12”,表示 10,11,12秒都會觸發(fā)
(5)/
用于遞增觸發(fā),如在秒上面設(shè)置”5/15” 表示從5秒開始,每增15秒觸發(fā)(5,20,35,50)
(6)#
序號(表示每月的第幾個周幾),例如在周字段上設(shè)置”6#3”表示在每月的第三個周六,(用 在母親節(jié)和父親節(jié)再合適不過了)
(7)周字段的設(shè)置,若使用英文字母是不區(qū)分大小寫的 ,即 MON 與mon相同
(8)L
表示最后的意思。在日字段設(shè)置上,表示當(dāng)月的最后一天(依據(jù)當(dāng)前月份,如果是二月還會自動判斷是否是潤年), 在周字段上表示星期六,相當(dāng)于”7”或”SAT”(注意周日算是第一天)。如果在”L”前加上數(shù)字,則表示該數(shù)據(jù)的最后一個。例如在周字段上設(shè)置”6L”這樣的格式,則表示”本月最后一個星期五”
(9)W
表示離指定日期的最近工作日(周一至周五),例如在日字段上設(shè)置”15W”,表示離每月15號最近的那個工作日觸發(fā)。如果15號正好是周六,則找最近的周五(14號)觸發(fā), 如果15號是周未,則找最近的下周一(16號)觸發(fā),如果15號正好在工作日(周一至周五),則就在該天觸發(fā)。如果指定格式為 “1W”,它則表示每月1號往后最近的工作日觸發(fā)。如果1號正是周六,則將在3號下周一觸發(fā)。(注,”W”前只能設(shè)置具體的數(shù)字,不允許區(qū)間”-“)
(10)L
和W
可以一組合使用。如果在日字段上設(shè)置”LW”,則表示在本月的最后一個工作日觸發(fā)(一般指發(fā)工資 )
在 @Scheduled 注解中來一個簡單的 cron 表達(dá)式,每隔5秒觸發(fā)一次
@Scheduled(cron = "0/5 * * * * ?") public void cron() { System.out.println("cron>>"+new Date()); }
二、第二種方式:Quartz
一般在項(xiàng)目中,除非定時任務(wù)涉及到的業(yè)務(wù)實(shí)在是太簡單,使用 @Scheduled 注解來解決定時任務(wù),否則大部分情況可能都是使用 Quartz 來做定時任務(wù)。在 Spring Boot 中使用 Quartz ,只需要在創(chuàng)建項(xiàng)目時,添加 Quartz 依賴即可:
項(xiàng)目創(chuàng)建完成后,也需要添加開啟定時任務(wù)的注解:
@SpringBootApplication @EnableScheduling public class QuartzApplication { public static void main(String[] args) { SpringApplication.run(QuartzApplication.class, args); } }
Quartz 在使用過程中,有兩個關(guān)鍵概念,一個是JobDetail(要做的事情),另一個是觸發(fā)器(什么時候做),要定義 JobDetail,需要先定義 Job,Job 的定義有兩種方式:
第一種方式,直接定義一個Bean:
@Component public class MyFirstJob { public void sayHello() { System.out.println("first job say hello:" + new Date()); } }
關(guān)于這種定義方式說兩點(diǎn):
(1)首先將這個 Job 注冊到 Spring 容器中。
(2)這種定義方式有一個缺陷,就是無法傳參。
第二種定義方式,則是繼承 QuartzJobBean 并實(shí)現(xiàn)默認(rèn)的方法:
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種方式相比,這種方式支持傳參,任務(wù)啟動時,executeInternal 方法將會被執(zhí)行。
Job 有了之后,接下來創(chuàng)建類,配置 JobDetail 和 Trigger 觸發(fā)器,如下:
@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
可以配置目標(biāo) Bean 的名字和目標(biāo)方法的名字,這種方式不支持傳參。
(3)使用JobDetailFactoryBean
可以配置JobDetail
,任務(wù)類繼承自QuartzJobBean
,這種方式支持傳參,將參數(shù)封裝在JobDataMap
中進(jìn)行傳遞。
(4)Trigger
是指觸發(fā)器,Quartz
中定義了多個觸發(fā)器,這里向大家展示其中兩種的用法,SimpleTrigger
和CronTrigger
。
(5)SimpleTrigger
有點(diǎn)類似于前面說的@Scheduled
的基本用法。
(6)CronTrigger
則有點(diǎn)類似于@Scheduled
中cron
表達(dá)式的用法。
可以看到 SimpleTriggerFactoryBean 控制 first job,間隔兩秒打印,打印 3 次
CronTriggerFactoryBean 控制 second job ,每隔一秒打印一次
總結(jié)
到此這篇關(guān)于一篇文章教你使用SpringBoot如何實(shí)現(xiàn)定時任務(wù)的文章就介紹到這了,更多相關(guān)SpringBoot實(shí)現(xiàn)定時任務(wù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- Springboot非分布式定時任務(wù)實(shí)現(xiàn)代碼
- SpringBoot與Quartz集成實(shí)現(xiàn)分布式定時任務(wù)集群的代碼實(shí)例
- SpringBoot實(shí)現(xiàn)動態(tài)多線程并發(fā)定時任務(wù)
- springboot定時任務(wù)詳解
- 如何在springboot中使用定時任務(wù)
- springboot如何配置定時任務(wù)
- Springboot定時任務(wù)Scheduled重復(fù)執(zhí)行操作
- 淺談springboot項(xiàng)目中定時任務(wù)如何優(yōu)雅退出
- springboot+quartz以持久化的方式實(shí)現(xiàn)定時任務(wù)的代碼
- SpringBoot中使用@Scheduled注解創(chuàng)建定時任務(wù)的實(shí)現(xiàn)
- Spring Boot集成ShedLock分布式定時任務(wù)的實(shí)現(xiàn)示例
相關(guān)文章
Spring?Boot的幾種統(tǒng)一處理方式梳理小結(jié)
這篇文章主要為大家介紹了Spring?Boot的幾種統(tǒng)一處理方式梳理小結(jié),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-05-05Thread類interrupt interrupted及isInterrupted區(qū)別
這篇文章主要為大家介紹了Thread類interrupt interrupted及isInterrupted區(qū)別,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-10-10淺談SpringBoot內(nèi)嵌Tomcat的實(shí)現(xiàn)原理解析
這篇文章主要介紹了淺談SpringBoot內(nèi)嵌Tomcat的實(shí)現(xiàn)原理解析,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12SpringCloud?GateWay網(wǎng)關(guān)示例代碼詳解
這篇文章主要介紹了SpringCloud?GateWay網(wǎng)關(guān),Spring?cloud?Gateway的功能很多很強(qiáng)大,文中提到了Spring?Cloud?Gateway中幾個重要的概念,結(jié)合實(shí)例代碼給大家介紹的非常詳細(xì),需要的朋友參考下吧2022-04-04Java使用JDBC連接數(shù)據(jù)庫的實(shí)現(xiàn)方法
這篇文章主要介紹了Java使用JDBC連接數(shù)據(jù)庫的實(shí)現(xiàn)方法,包括了詳細(xì)的加載步驟以及完整實(shí)現(xiàn)示例,需要的朋友可以參考下2014-09-09詳解 Java HashMap 實(shí)現(xiàn)原理
這篇文章主要介紹了詳解 Java HashMap 實(shí)現(xiàn)原理的相關(guān)資料,幫助大家更好的理解和學(xué)習(xí)使用Java,感興趣的朋友可以了解下2021-03-03關(guān)于Elasticsearch封裝公共索引增刪改查
索引是Elasticsearch中存儲數(shù)據(jù)的邏輯單元,類似于關(guān)系數(shù)據(jù)庫中的表,它包含多個文檔,每個文檔都是一個結(jié)構(gòu)化的JSON數(shù)據(jù)格式,在實(shí)際應(yīng)用中,索引的使用與配置可以依據(jù)不同的方案進(jìn)行,例如在Spring Boot項(xiàng)目中,可以選擇自動配置或者手動編寫配置類2024-10-10Java通過XPath獲取XML文件中符合特定條件的節(jié)點(diǎn)
今天小編就為大家分享一篇關(guān)于Java通過XPath獲取XML文件中符合特定條件的節(jié)點(diǎn),小編覺得內(nèi)容挺不錯的,現(xiàn)在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧2019-01-01