springboot整合Quartz實現動態配置定時任務
前言
在我們日常的開發中,很多時候,定時任務都不是寫死的,而是寫到資料庫中,從而實現定時任務的動態配置,下面就通過一個簡單的示例,來實現這個功能。
新建一個springboot工程,並新增依賴
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency><!-- 為了方便測試,此處使用了記憶體資料庫 --> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.2.1</version> <exclusions> <exclusion> <artifactId>slf4j-api</artifactId> <groupId>org.slf4j</groupId> </exclusion> </exclusions> </dependency> <dependency><!-- 該依賴必加,裡面有sping對schedule的支援 --> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> </dependency>
配置檔案application.properties
# 伺服器埠號 server.port=7902 # 是否生成ddl語句 spring.jpa.generate-ddl=false # 是否列印sql語句 spring.jpa.show-sql=true # 自動生成ddl,由於指定了具體的ddl,此處設定為none spring.jpa.hibernate.ddl-auto=none # 使用H2資料庫 spring.datasource.platform=h2 # 指定生成資料庫的schema檔案位置 spring.datasource.schema=classpath:schema.sql # 指定插入資料庫語句的指令碼位置 spring.datasource.data=classpath:data.sql # 配置日誌列印資訊 logging.level.root=INFO logging.level.org.hibernate=INFO logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE logging.level.org.hibernate.type.descriptor.sql.BasicExtractor=TRACE logging.level.com.itmuch=DEBUG
Entity類
package com.chhliu.springboot.quartz.entity; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; @Entity public class Config { @Id @GeneratedValue(strategy = GenerationType.AUTO) private Long id; @Column private String cron; /** * @return the id */ public Long getId() { return id; } ……此處省略getter和setter方法…… }
任務類
package com.chhliu.springboot.quartz.entity; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.EnableScheduling; import org.springframework.stereotype.Component; @Configuration @Component // 此註解必加 @EnableScheduling // 此註解必加 public class ScheduleTask { private static final Logger LOGGER =LoggerFactory.getLogger(ScheduleTask.class); public void sayHello(){ LOGGER.info("Hello world, i'm the king of the world!!!"); } }
Quartz配置類
由於springboot追求零xml配置,所以下面會以配置Bean的方式來實現
package com.chhliu.springboot.quartz.entity; import org.quartz.Trigger; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.quartz.CronTriggerFactoryBean; import org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean; import org.springframework.scheduling.quartz.SchedulerFactoryBean; @Configuration public class QuartzConfigration { /** * attention: * Details:配置定時任務 */ @Bean(name = "jobDetail") public MethodInvokingJobDetailFactoryBean detailFactoryBean(ScheduleTask task) {// ScheduleTask為需要執行的任務 MethodInvokingJobDetailFactoryBean jobDetail = new MethodInvokingJobDetailFactoryBean(); /* *是否併發執行 *例如每5s執行一次任務,但是當前任務還沒有執行完,就已經過了5s了, *如果此處為true,則下一個任務會執行,如果此處為false,則下一個任務會等待上一個任務執行完後,再開始執行 */ jobDetail.setConcurrent(false); jobDetail.setName("srd-chhliu");// 設定任務的名字 jobDetail.setGroup("srd");// 設定任務的分組,這些屬性都可以儲存在資料庫中,在多工的時候使用 /* * 為需要執行的實體類對應的物件 */ jobDetail.setTargetObject(task); /* * sayHello為需要執行的方法 * 通過這幾個配置,告訴JobDetailFactoryBean我們需要執行定時執行ScheduleTask類中的sayHello方法 */ jobDetail.setTargetMethod("sayHello"); return jobDetail; } /** * attention: * Details:配置定時任務的觸發器,也就是什麼時候觸發執行定時任務 */ @Bean(name = "jobTrigger") public CronTriggerFactoryBean cronJobTrigger(MethodInvokingJobDetailFactoryBean jobDetail) { CronTriggerFactoryBean tigger = new CronTriggerFactoryBean(); tigger.setJobDetail(jobDetail.getObject()); tigger.setCronExpression("0 30 20 * * ?");// 初始時的cron表示式 tigger.setName("srd-chhliu");// trigger的name return tigger; } /** * attention: * Details:定義quartz排程工廠 */ @Bean(name = "scheduler") public SchedulerFactoryBean schedulerFactory(Trigger cronJobTrigger) { SchedulerFactoryBean bean = new SchedulerFactoryBean(); // 用於quartz叢集,QuartzScheduler 啟動時更新己存在的Job bean.setOverwriteExistingJobs(true); // 延時啟動,應用啟動1秒後 bean.setStartupDelay(1); // 註冊觸發器 bean.setTriggers(cronJobTrigger); return bean; } }
定時查庫,並更新任務
package com.chhliu.springboot.quartz.entity; import javax.annotation.Resource; import org.quartz.CronScheduleBuilder; import org.quartz.CronTrigger; import org.quartz.JobDetail; import org.quartz.Scheduler; import org.quartz.SchedulerException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.EnableScheduling; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; import com.chhliu.springboot.quartz.repository.ConfigRepository; @Configuration @EnableScheduling @Component public class ScheduleRefreshDatabase { @Autowired private ConfigRepository repository; @Resource(name = "jobDetail") private JobDetail jobDetail; @Resource(name = "jobTrigger") private CronTrigger cronTrigger; @Resource(name = "scheduler") private Scheduler scheduler; @Scheduled(fixedRate = 5000) // 每隔5s查庫,並根據查詢結果決定是否重新設定定時任務 public void scheduleUpdateCronTrigger() throws SchedulerException { CronTrigger trigger = (CronTrigger) scheduler.getTrigger(cronTrigger.getKey()); String currentCron = trigger.getCronExpression();// 當前Trigger使用的 String searchCron = repository.findOne(1L).getCron();// 從資料庫查詢出來的 System.out.println(currentCron); System.out.println(searchCron); if (currentCron.equals(searchCron)) { // 如果當前使用的cron表示式和從資料庫中查詢出來的cron表示式一致,則不重新整理任務 } else { // 表示式排程構建器 CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(searchCron); // 按新的cronExpression表示式重新構建trigger trigger = (CronTrigger) scheduler.getTrigger(cronTrigger.getKey()); trigger = trigger.getTriggerBuilder().withIdentity(cronTrigger.getKey()) .withSchedule(scheduleBuilder).build(); // 按新的trigger重新設定job執行 scheduler.rescheduleJob(cronTrigger.getKey(), trigger); currentCron = searchCron; } } }
相關指令碼
1、data.sql
insert into config(id,cron) values(1,'0 0/2 * * * ?'); # 每2分鐘執行一次定時任務
2、schema.sql
drop table config if exists; create table config( id bigint generated by default as identity, cron varchar(40), primary key(id) );
執行測試
測試結果如下:(Quartz預設的執行緒池大小為10)
0 30 20 * * ? 0 0/2 * * * ? 2017-03-08 18:02:00.025INFO 5328 --- [eduler_Worker-1] c.c.s.quartz.entity.ScheduleTask: Hello world, i'm the king of the world!!! 2017-03-08 18:04:00.003INFO 5328 --- [eduler_Worker-2] c.c.s.quartz.entity.ScheduleTask: Hello world, i'm the king of the world!!! 2017-03-08 18:06:00.002INFO 5328 --- [eduler_Worker-3] c.c.s.quartz.entity.ScheduleTask: Hello world, i'm the king of the world!!! 2017-03-08 18:08:00.002INFO 5328 --- [eduler_Worker-4] c.c.s.quartz.entity.ScheduleTask: Hello world,
從上面的日誌列印時間來看,我們實現了動態配置,最初的時候,任務是每天20:30執行,後面通過動態重新整理變成了每隔2分鐘執行一次。
雖然上面的解決方案沒有使用Quartz推薦的方式完美,但基本上可以滿足我們的需求,當然也可以採用觸發事件的方式來實現,例如當前端修改定時任務的觸發時間時,非同步的向後臺傳送通知,後臺收到通知後,然後再更新程式,也可以實現動態的定時任務重新整理