如何在springboot中使用定時(shí)任務(wù)
在日常的開發(fā)過程中經(jīng)常使用到定時(shí)任務(wù),在springMVC的開發(fā)中,經(jīng)常和quartz框架進(jìn)行集成使用,但在springboot中沒有這么做,而是使用了java的線程池來實(shí)現(xiàn)定時(shí)任務(wù)。
一、概述在springboot中使用定時(shí)任務(wù)非常簡單,只需要簡單的幾步即可完成。
二、詳述在springboot中要使用定時(shí)任務(wù),首先要保證環(huán)境是springboot的,這里使用的是springboot-2.1.2.release版本。在啟動類上加@EnableScheduling注解,如下,
package com.example.demo;import com.example.demo.properties.ApplicationPro;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.boot.context.properties.EnableConfigurationProperties;import org.springframework.scheduling.annotation.EnableScheduling;@SpringBootApplication@EnableConfigurationProperties({ApplicationPro.class})//引入開啟定時(shí)任務(wù)的注解@EnableSchedulingpublic class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); }}
@EnableScheduling注解的作用就是開啟對定時(shí)任務(wù)的支持,這個(gè)注解的作用是開啟定時(shí)任務(wù)的自動配置。
在使用了@EnableScheduling注解后便可以編寫具體的定時(shí)任務(wù)的job類,該job類無需繼承或?qū)崿F(xiàn)任何接口,只要是一個(gè)被spring管理的類即可。為了使spring可以管理統(tǒng)一使用@Component注解標(biāo)識。在定時(shí)任務(wù)的類中的方法上標(biāo)識@Scheduled注解便可以定時(shí)執(zhí)行該方法,@Scheduled注解上有幾種不同的屬性,看具體的該注解的定義,
@Scheduled(fixedDelay=1000)/@Scheduled(fixedDelay='1000')的意思是該方法執(zhí)行完后每隔1000ms執(zhí)行一次。看具體的代碼
package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulFixedRelayTest { //@Scheduled(fixedDelay = 5000) public void jobTest(){ try { log.info('使用fixedDelay的定時(shí)任務(wù)'); Thread.sleep(10*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}
看執(zhí)行結(jié)果,
2020-12-09 22:02:47.511 INFO 7368 --- [ main] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 940 ms2020-12-09 22:02:47.681 INFO 7368 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService ’applicationTaskExecutor’2020-12-09 22:02:47.782 INFO 7368 --- [ main] o.s.s.c.ThreadPoolTaskScheduler : Initializing ExecutorService ’taskScheduler’2020-12-09 22:02:47.802 INFO 7368 --- [ scheduling-1] c.e.demo.job.SchedulFixedRelayTest : 使用fixedDelay的定時(shí)任務(wù)2020-12-09 22:02:47.820 INFO 7368 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ’’2020-12-09 22:02:47.823 INFO 7368 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.627 seconds (JVM running for 2.51)2020-12-09 22:03:02.819 INFO 7368 --- [ scheduling-1] c.e.demo.job.SchedulFixedRelayTest : 使用fixedDelay的定時(shí)任務(wù)2020-12-09 22:03:17.834 INFO 7368 --- [ scheduling-1] c.e.demo.job.SchedulFixedRelayTest : 使用fixedDelay的定時(shí)任務(wù)
看上面打印的執(zhí)行時(shí)間,第一次在2020-12-09 22:02:47,由于程序會睡眠10秒,也就是說回在22:02:57執(zhí)行完,那么下次執(zhí)行應(yīng)該在22:03:02,看第二次打印的時(shí)間剛好和上面的一樣,那就證明了,該配置是在方法執(zhí)行完成后每隔XX秒執(zhí)行一次。
fixedRate@Scheduled(fixedRate=1000)/@Scheduled(fixedRate='1000')的意思是該方法執(zhí)行完后每隔1000ms執(zhí)行一次,但是如果任務(wù)執(zhí)行的時(shí)間超過了配置的時(shí)間,則在任務(wù)執(zhí)行完會再次執(zhí)行。
任務(wù)時(shí)間小于配置的時(shí)間package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulFixedRateTest { @Scheduled(fixedRate = 5000) public void jobTest(){ try { log.info('使用fixedRate的定時(shí)任務(wù)'); Thread.sleep(1*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}
任務(wù)會睡眠1s也就是任務(wù)耗時(shí)1s,fixedRate配置的是每隔5s,由于任務(wù)時(shí)間小于配置的時(shí)間,所以會每隔5s執(zhí)行一次,看執(zhí)行結(jié)果,
2020-12-09 22:16:16.156 INFO 2800 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時(shí)任務(wù)2020-12-09 22:16:16.188 INFO 2800 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ’’2020-12-09 22:16:16.188 INFO 2800 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.625 seconds (JVM running for 2.462)2020-12-09 22:16:21.178 INFO 2800 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時(shí)任務(wù)2020-12-09 22:16:26.180 INFO 2800 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時(shí)任務(wù)
看打印的任務(wù)時(shí)間都是每隔5s執(zhí)行一次。
任務(wù)時(shí)間大于配置的時(shí)間看任務(wù)的執(zhí)行時(shí)間打印配置的時(shí)間的情況,
package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulFixedRateTest { @Scheduled(fixedRate = 5000) public void jobTest(){ try { log.info('使用fixedRate的定時(shí)任務(wù)'); Thread.sleep(10*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}
這里任務(wù)執(zhí)行10s,配置的時(shí)間為5s。看執(zhí)行結(jié)果,
2020-12-09 22:17:44.070 INFO 12952 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時(shí)任務(wù)2020-12-09 22:17:44.102 INFO 12952 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ’’2020-12-09 22:17:44.102 INFO 12952 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.626 seconds (JVM running for 2.462)2020-12-09 22:17:54.071 INFO 12952 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時(shí)任務(wù)2020-12-09 22:18:04.085 INFO 12952 --- [ scheduling-1] c.example.demo.job.SchedulFixedRateTest : 使用fixedRate的定時(shí)任務(wù)
從上面的結(jié)果可以看到任務(wù)是每隔10s執(zhí)行一次,由于任務(wù)耗時(shí)大于了配置的時(shí)長,所以任務(wù)執(zhí)行完以后便會進(jìn)入下次的執(zhí)行。
croncron表達(dá)式共7位,分別是秒、分、小時(shí)、日、月、周、年。cron表達(dá)式可以從網(wǎng)上找,如下,
https://cron.qqe2.com/
通過cron在線生成,分別設(shè)置值,如,0/5 * * * * ? 每隔5s執(zhí)行一次,
package com.example.demo.job;import lombok.extern.slf4j.Slf4j;import org.springframework.scheduling.annotation.Scheduled;import org.springframework.stereotype.Component;@Slf4j@Componentpublic class SchedulCronTest { @Scheduled(cron = '0/5 * * * * ?') public void jobTest(){ try { log.info('使用cron的定時(shí)任務(wù)'); Thread.sleep(10*1000); } catch (InterruptedException e) { e.printStackTrace(); } }}
每隔5s執(zhí)行一次,任務(wù)耗時(shí)10s,看下執(zhí)行結(jié)果,
2020-12-09 22:41:42.718 INFO 17828 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.609 seconds (JVM running for 2.453)2020-12-09 22:41:45.015 INFO 17828 --- [ scheduling-1] com.example.demo.job.SchedulCronTest : 使用cron的定時(shí)任務(wù)2020-12-09 22:42:00.004 INFO 17828 --- [ scheduling-1] com.example.demo.job.SchedulCronTest : 使用cron的定時(shí)任務(wù)2020-12-09 22:42:15.000 INFO 17828 --- [ scheduling-1] com.example.demo.job.SchedulCronTest : 使用cron的定時(shí)任務(wù)
可以看到是每隔15s執(zhí)行一次,也就是如果配置的時(shí)間間隔小于任務(wù)耗時(shí),那么在任務(wù)執(zhí)行完后的時(shí)間間隔后再執(zhí)行,在此種情況下和fixDelay的用法一致。
三、總結(jié)本文分析了springboot中定時(shí)任務(wù)的使用,
首先,使用@EnableScheduling開啟定時(shí)任務(wù)的自動配置;
其次,任務(wù)類必須受spring管理(使用@Component、@Service等注解均可);
最后,任務(wù)方法使用@Scheduled注解標(biāo)識,該注解有3中不同的屬性配置,fixedDelay、fixedRate、cron;
以上就是如何在springboot中使用定時(shí)任務(wù)的詳細(xì)內(nèi)容,更多關(guān)于springboot中使用定時(shí)任務(wù)的資料請關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
