在 Spring + SpringMVC 環(huán)境中,一般來說,要實(shí)現(xiàn)定時(shí)任務(wù),我們有兩中方案,一種是使用 Spring 自帶的定時(shí)任務(wù)處理器 @Scheduled 注解,另一種就是使用第三方框架 Quartz ,Spring Boot 源自 Spring+SpringMVC ,因此天然具備這兩個(gè) Spring 中的定時(shí)任務(wù)實(shí)現(xiàn)策略,當(dāng)然也支持 Quartz,本文我們就來看下 Spring Boot 中兩種定時(shí)任務(wù)的實(shí)現(xiàn)方式。
@Scheduled
使用 @Scheduled 非常容易,直接創(chuàng)建一個(gè) Spring Boot 項(xiàng)目,并且添加 web 依賴 spring-boot-starter-web
,項(xiàng)目創(chuàng)建成功后,添加 @EnableScheduling
注解,開啟定時(shí)任務(wù):
@SpringBootApplication
@EnableScheduling
publicclassScheduledApplication{
publicstaticvoid main(String[] args){
SpringApplication.run(ScheduledApplication.class, args);
}
}
接下來配置定時(shí)任務(wù):
@Scheduled(fixedRate =2000)
publicvoid fixedRate(){
System.out.println("fixedRate>>>"+newDate());
}
@Scheduled(fixedDelay =2000)
publicvoid fixedDelay(){
System.out.println("fixedDelay>>>"+newDate());
}
@Scheduled(initialDelay =2000,fixedDelay =2000)
publicvoid initialDelay(){
System.out.println("initialDelay>>>"+newDate());
}
- 首先使用 @Scheduled 注解開啟一個(gè)定時(shí)任務(wù)。
- fixedRate 表示任務(wù)執(zhí)行之間的時(shí)間間隔,具體是指兩次任務(wù)的開始時(shí)間間隔,即第二次任務(wù)開始時(shí),第一次任務(wù)可能還沒結(jié)束。
- fixedDelay 表示任務(wù)執(zhí)行之間的時(shí)間間隔,具體是指本次任務(wù)結(jié)束到下次任務(wù)開始之間的時(shí)間間隔。
- initialDelay 表示首次任務(wù)啟動(dòng)的延遲時(shí)間。
- 所有時(shí)間的單位都是毫秒。
上面這是一個(gè)基本用法,除了這幾個(gè)基本屬性之外,@Scheduled 注解也支持 cron 表達(dá)式,使用 cron 表達(dá)式,可以非常豐富的描述定時(shí)任務(wù)的時(shí)間。cron 表達(dá)式格式如下:
[秒] [分] [小時(shí)] [日] [月] [周] [年]
具體取值如下:
序號(hào) | 說明 | 是否必填 | 允許填寫的值 | 允許的通配符 |
---|---|---|---|---|
1 | 秒 | 是 | 0-59 | - * / |
2 | 分 | 是 | 0-59 | - * / |
3 | 時(shí) | 是 | 0-23 | - * / |
4 | 日 | 是 | 1-31 | - * ? / L W |
5 | 月 | 是 | 1-12 or JAN-DEC | - * / |
6 | 周 | 是 | 1-7 or SUN-SAT | - * ? / L # |
7 | 年 | 否 | 1970-2099 | - * / |
這一塊需要大家注意的是,月份中的日期和星期可能會(huì)起沖突,因此在配置時(shí)這兩個(gè)得有一個(gè)是 ?
通配符含義:
?
表示不指定值,即不關(guān)心某個(gè)字段的取值時(shí)使用。需要注意的是,月份中的日期和星期可能會(huì)起沖突,因此在配置時(shí)這兩個(gè)得有一個(gè)是?
*
表示所有值,例如:在秒的字段上設(shè)置*
,表示每一秒都會(huì)觸發(fā),
用來分開多個(gè)值,例如在周字段上設(shè)置 "MON,WED,FRI" 表示周一,周三和周五觸發(fā)-
表示區(qū)間,例如在秒上設(shè)置 "10-12",表示 10,11,12秒都會(huì)觸發(fā)/
用于遞增觸發(fā),如在秒上面設(shè)置"5/15" 表示從5秒開始,每增15秒觸發(fā)(5,20,35,50)#
序號(hào)(表示每月的第幾個(gè)周幾),例如在周字段上設(shè)置"6#3"表示在每月的第三個(gè)周六,(用 在母親節(jié)和父親節(jié)再合適不過了)- 周字段的設(shè)置,若使用英文字母是不區(qū)分大小寫的 ,即 MON 與mon相同
L
表示最后的意思。在日字段設(shè)置上,表示當(dāng)月的最后一天(依據(jù)當(dāng)前月份,如果是二月還會(huì)自動(dòng)判斷是否是潤(rùn)年), 在周字段上表示星期六,相當(dāng)于"7"或"SAT"(注意周日算是第一天)。如果在"L"前加上數(shù)字,則表示該數(shù)據(jù)的最后一個(gè)。例如在周字段上設(shè)置"6L"這樣的格式,則表示"本月最后一個(gè)星期五"W
表示離指定日期的最近工作日(周一至周五),例如在日字段上設(shè)置"15W",表示離每月15號(hào)最近的那個(gè)工作日觸發(fā)。如果15號(hào)正好是周六,則找最近的周五(14號(hào))觸發(fā), 如果15號(hào)是周未,則找最近的下周一(16號(hào))觸發(fā),如果15號(hào)正好在工作日(周一至周五),則就在該天觸發(fā)。如果指定格式為 "1W",它則表示每月1號(hào)往后最近的工作日觸發(fā)。如果1號(hào)正是周六,則將在3號(hào)下周一觸發(fā)。(注,"W"前只能設(shè)置具體的數(shù)字,不允許區(qū)間"-")L
和W
可以一組合使用。如果在日字段上設(shè)置"LW",則表示在本月的最后一個(gè)工作日觸發(fā)(一般指發(fā)工資 )
例如,在 @Scheduled 注解中來一個(gè)簡(jiǎn)單的 cron 表達(dá)式,每隔5秒觸發(fā)一次,如下:
@Scheduled(cron ="0/5 * * * * *")
publicvoid cron(){
System.out.println(newDate());
}
上面介紹的是使用 @Scheduled 注解的方式來實(shí)現(xiàn)定時(shí)任務(wù),接下來我們?cè)賮砜纯慈绾问褂?Quartz 實(shí)現(xiàn)定時(shí)任務(wù)。
Quartz
一般在項(xiàng)目中,除非定時(shí)任務(wù)涉及到的業(yè)務(wù)實(shí)在是太簡(jiǎn)單,使用 @Scheduled 注解來解決定時(shí)任務(wù),否則大部分情況可能都是使用 Quartz 來做定時(shí)任務(wù)。在 Spring Boot 中使用 Quartz ,只需要在創(chuàng)建項(xiàng)目時(shí),添加 Quartz 依賴即可:
項(xiàng)目創(chuàng)建完成后,也需要添加開啟定時(shí)任務(wù)的注解:
@SpringBootApplication
@EnableScheduling
publicclassQuartzApplication{
publicstaticvoid main(String[] args){
SpringApplication.run(QuartzApplication.class, args);
}
}
Quartz 在使用過程中,有兩個(gè)關(guān)鍵概念,一個(gè)是JobDetail(要做的事情),另一個(gè)是觸發(fā)器(什么時(shí)候做),要定義 JobDetail,需要先定義 Job,Job 的定義有兩種方式:
第一種方式,直接定義一個(gè)Bean:
@Component
publicclassMyJob1{
publicvoid sayHello(){
System.out.println("MyJob1>>>"+newDate());
}
}
關(guān)于這種定義方式說兩點(diǎn):
- 首先將這個(gè) Job 注冊(cè)到 Spring 容器中。
- 這種定義方式有一個(gè)缺陷,就是無法傳參。
第二種定義方式,則是繼承 QuartzJobBean 并實(shí)現(xiàn)默認(rèn)的方法:
publicclassMyJob2extendsQuartzJobBean{
HelloService helloService;
publicHelloService getHelloService(){
return helloService;
}
publicvoid setHelloService(HelloService helloService){
this.helloService = helloService;
}
@Override
protectedvoid executeInternal(JobExecutionContext jobExecutionContext)throwsJobExecutionException{
helloService.sayHello();
}
}
publicclassHelloService{
publicvoid sayHello(){
System.out.println("hello service >>>"+newDate());
}
}
和第1種方式相比,這種方式支持傳參,任務(wù)啟動(dòng)時(shí),executeInternal 方法將會(huì)被執(zhí)行。
Job 有了之后,接下來創(chuàng)建類,配置 JobDetail 和 Trigger 觸發(fā)器,如下:
@Configuration
publicclassQuartzConfig{
@Bean
MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean(){
MethodInvokingJobDetailFactoryBean bean =newMethodInvokingJobDetailFactoryBean();
bean.setTargetBeanName("myJob1");
bean.setTargetMethod("sayHello");
return bean;
}
@Bean
JobDetailFactoryBean jobDetailFactoryBean(){
JobDetailFactoryBean bean =newJobDetailFactoryBean();
bean.setJobClass(MyJob2.class);
JobDataMap map =newJobDataMap();
map.put("helloService", helloService());
bean.setJobDataMap(map);
return bean;
}
@Bean
SimpleTriggerFactoryBean bean =newSimpleTriggerFactoryBean();
bean.setStartTime(newDate());
bean.setRepeatCount(5);
bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
bean.setRepeatInterval(3000);
return bean;
}
@Bean
CronTriggerFactoryBean cronTrigger(){
CronTriggerFactoryBean bean =newCronTriggerFactoryBean();
bean.setCronExpression("0/10 * * * * ?");
bean.setJobDetail(jobDetailFactoryBean().getObject());
return bean;
}
@Bean
SchedulerFactoryBean schedulerFactoryBean(){
SchedulerFactoryBean bean =newSchedulerFactoryBean();
bean.setTriggers(cronTrigger().getObject(), simpleTriggerFactoryBean().getObject());
return bean;
}
@Bean
HelloService helloService(){
returnnewHelloService();
}
}
關(guān)于這個(gè)配置說如下幾點(diǎn):
- JobDetail 的配置有兩種方式:MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。
- 使用 MethodInvokingJobDetailFactoryBean 可以配置目標(biāo) Bean 的名字和目標(biāo)方法的名字,這種方式不支持傳參。
- 使用 JobDetailFactoryBean 可以配置 JobDetail ,任務(wù)類繼承自 QuartzJobBean ,這種方式支持傳參,將參數(shù)封裝在 JobDataMap 中進(jìn)行傳遞。
- Trigger 是指觸發(fā)器,Quartz 中定義了多個(gè)觸發(fā)器,這里向大家展示其中兩種的用法,SimpleTrigger 和 CronTrigger 。
- SimpleTrigger 有點(diǎn)類似于前面說的 @Scheduled 的基本用法。
- CronTrigger 則有點(diǎn)類似于 @Scheduled 中 cron 表達(dá)式的用法。
全部定義完成后,啟動(dòng) Spring Boot 項(xiàng)目就可以看到定時(shí)任務(wù)的執(zhí)行了。
總結(jié)
這里主要向大家展示了 Spring Boot 中整合兩種定時(shí)任務(wù)的方法,整合成功之后,剩下的用法基本上就和在 SSM 中使用一致了,不再贅述。
-
框架
+關(guān)注
關(guān)注
0文章
404瀏覽量
17897 -
spring
+關(guān)注
關(guān)注
0文章
340瀏覽量
15081 -
SpringMVC
+關(guān)注
關(guān)注
0文章
18瀏覽量
5974
發(fā)布評(píng)論請(qǐng)先 登錄
Spring Boot如何實(shí)現(xiàn)異步任務(wù)
Linux系統(tǒng)定時(shí)任務(wù)Crond
啟動(dòng)Spring Boot項(xiàng)目應(yīng)用的三種方法
busybox用crontab/crond在嵌入式系統(tǒng)中添加定時(shí)任務(wù)的方法
Spring Boot定時(shí)任務(wù)的重寫方法
SpringBoot如何實(shí)現(xiàn)動(dòng)態(tài)增刪啟停定時(shí)任務(wù)

Python定時(shí)任務(wù)的實(shí)現(xiàn)方式
說說Spring定時(shí)任務(wù)如何大規(guī)模企業(yè)級(jí)運(yùn)用
求一種SpringBoot定時(shí)任務(wù)動(dòng)態(tài)管理通用解決方案
SpringBoot如何實(shí)現(xiàn)定時(shí)任務(wù)(下)

SpringBoot如何實(shí)現(xiàn)定時(shí)任務(wù)(上)

在Spring Boot中如何使用定時(shí)任務(wù)
python定時(shí)任務(wù)實(shí)踐

如何在Spring Boot應(yīng)用程序中整合ZXing庫
linux定時(shí)任務(wù)的用法總結(jié)

評(píng)論