springboot整合Quartz實現動態配置定時任務

  • 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的方式來實現


    1. package com.chhliu.springboot.quartz.entity;
    2. import org.quartz.Trigger;
    3. import org.springframework.context.annotation.Bean;
    4. import org.springframework.context.annotation.Configuration;
    5. import org.springframework.scheduling.quartz.CronTriggerFactoryBean;
    6. import org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean;
    7. import org.springframework.scheduling.quartz.SchedulerFactoryBean;
    8. @Configuration
    9. public class QuartzConfigration {
    10. /**
    11. * attention:
    12. * Details:配置定時任務
    13. */
    14. @Bean(name = "jobDetail")
    15. public MethodInvokingJobDetailFactoryBean detailFactoryBean(ScheduleTask task) {// ScheduleTask為需要執行的任務
    16. MethodInvokingJobDetailFactoryBean jobDetail = new MethodInvokingJobDetailFactoryBean();
    17. /*
    18. * 是否併發執行
    19. * 例如每5s執行一次任務,但是當前任務還沒有執行完,就已經過了5s了,
    20. * 如果此處為true,則下一個任務會執行,如果此處為false,則下一個任務會等待上一個任務執行完後,再開始執行
    21. */
    22. jobDetail.setConcurrent(false);
    23. jobDetail.setName("srd-chhliu");// 設置任務的名字
    24. jobDetail.setGroup("srd");// 設置任務的分組,這些屬性都可以存儲在數據庫中,在多任務的時候使用
    25. /*
    26. * 為需要執行的實體類對應的對象
    27. */
    28. jobDetail.setTargetObject(task);
    29. /*
    30. * sayHello為需要執行的方法
    31. * 通過這幾個配置,告訴JobDetailFactoryBean我們需要執行定時執行ScheduleTask類中的sayHello方法
    32. */
    33. jobDetail.setTargetMethod("sayHello");
    34. return jobDetail;
    35. }
    36. /**
    37. * attention:
    38. * Details:配置定時任務的觸發器,也就是什麼時候觸發執行定時任務
    39. */
    40. @Bean(name = "jobTrigger")
    41. public CronTriggerFactoryBean cronJobTrigger(MethodInvokingJobDetailFactoryBean jobDetail) {
    42. CronTriggerFactoryBean tigger = new CronTriggerFactoryBean();
    43. tigger.setJobDetail(jobDetail.getObject());
    44. tigger.setCronExpression("0 30 20 * * ?");// 初始時的cron表達式
    45. tigger.setName("srd-chhliu");// trigger的name
    46. return tigger;
    47. }
    48. /**
    49. * attention:
    50. * Details:定義quartz調度工廠
    51. */
    52. @Bean(name = "scheduler")
    53. public SchedulerFactoryBean schedulerFactory(Trigger cronJobTrigger) {
    54. SchedulerFactoryBean bean = new SchedulerFactoryBean();
    55. // 用於quartz集群,QuartzScheduler 啟動時更新己存在的Job
    56. bean.setOverwriteExistingJobs(true);
    57. // 延時啟動,應用啟動1秒後
    58. bean.setStartupDelay(1);
    59. // 註冊觸發器
    60. bean.setTriggers(cronJobTrigger);
    61. return bean;
    62. }
    63. }
    64. 六、定時查庫,並更新任務
    65. package com.chhliu.springboot.quartz.entity;
    66. import javax.annotation.Resource;
    67. import org.quartz.CronScheduleBuilder;
    68. import org.quartz.CronTrigger;
    69. import org.quartz.JobDetail;
    70. import org.quartz.Scheduler;
    71. import org.quartz.SchedulerException;
    72. import org.springframework.beans.factory.annotation.Autowired;
    73. import org.springframework.context.annotation.Configuration;
    74. import org.springframework.scheduling.annotation.EnableScheduling;
    75. import org.springframework.scheduling.annotation.Scheduled;
    76. import org.springframework.stereotype.Component;
    77. import com.chhliu.springboot.quartz.repository.ConfigRepository;
    78. @Configuration
    79. @EnableScheduling
    80. @Component
    81. public class ScheduleRefreshDatabase {
    82. @Autowired
    83. private ConfigRepository repository;
    84. @Resource(name = "jobDetail")
    85. private JobDetail jobDetail;
    86. @Resource(name = "jobTrigger")
    87. private CronTrigger cronTrigger;
    88. @Resource(name = "scheduler")
    89. private Scheduler scheduler;
    90. @Scheduled(fixedRate = 5000) // 每隔5s查庫,並根據查詢結果決定是否重新設置定時任務
    91. public void scheduleUpdateCronTrigger() throws SchedulerException {
    92. CronTrigger trigger = (CronTrigger) scheduler.getTrigger(cronTrigger.getKey());
    93. String currentCron = trigger.getCronExpression();// 當前Trigger使用的
    94. String searchCron = repository.findOne(1L).getCron();// 從數據庫查詢出來的
    95. System.out.println(currentCron);
    96. System.out.println(searchCron);
    97. if (currentCron.equals(searchCron)) {
    98. // 如果當前使用的cron表達式和從數據庫中查詢出來的cron表達式一致,則不刷新任務
    99. } else {
    100. // 表達式調度構建器
    101. CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(searchCron);
    102. // 按新的cronExpression表達式重新構建trigger
    103. trigger = (CronTrigger) scheduler.getTrigger(cronTrigger.getKey());
    104. trigger = trigger.getTriggerBuilder().withIdentity(cronTrigger.getKey())
    105. .withSchedule(scheduleBuilder).build();
    106. // 按新的trigger重新設置job執行
    107. scheduler.rescheduleJob(cronTrigger.getKey(), trigger);
    108. currentCron = searchCron;
    109. }
    110. }
    111. }

    六、相關腳本1、data.sql

    insert into config(id,cron) values(1,'0 0/2 * * * ?'); # 每2分鐘執行一次定時任務

    1. 2、schema.sql
    2. drop table config if exists;
    3. create table config(
    4. id bigint generated by default as identity,
    5. cron varchar(40),
    6. primary key(id)
    7. );

    六、運行測試測試結果如下:(Quartz默認的線程池大小為10)


    1. 0 30 20 * * ?
    2. 0 0/2 * * * ?
    3. 2017-03-08 18:02:00.025 INFO 5328 --- [eduler_Worker-1] c.c.s.quartz.entity.ScheduleTask : Hello world, i'm the king of the world!!!
    4. 2017-03-08 18:04:00.003 INFO 5328 --- [eduler_Worker-2] c.c.s.quartz.entity.ScheduleTask : Hello world, i'm the king of the world!!!
    5. 2017-03-08 18:06:00.002 INFO 5328 --- [eduler_Worker-3] c.c.s.quartz.entity.ScheduleTask : Hello world, i'm the king of the world!!!
    6. 2017-03-08 18:08:00.002 INFO 5328 --- [eduler_Worker-4] c.c.s.quartz.entity.ScheduleTask : Hello world, i'm the king of the world!!!

    從上面的日誌打印時間來看,我們實現了動態配置,最初的時候,任務是每天20:30執行,後面通過動態刷新變成了每隔2分鐘執行一次。雖然上面的解決方案沒有使用Quartz推薦的方式完美,但基本上可以滿足我們的需求,當然也可以採用觸發事件的方式來實現,例如當前端修改定時任務的觸發時間時,異步的向後臺發送通知,後臺收到通知後,然後再更新程序,也可以實現動態的定時任務刷新


    分享到:


    相關文章: