1. 背景

因为需求需要，用到了定时任务，但是之前使用的定时任务是基于Spring的xml形式，但是在微服务的模块中这显然不太合适，因为单独的模块，做成了独立的服务，所以最终选择了基于注解的方式来完成需求。所以写了一个小demo来让大家借鉴，怎么让SpringBoot与Quartz集成使用。

2. Quartz的简介

简介

Quartz是一个开源的任务调度框架。基于定时、定期的策略来执行任务是它的核心功能，比如x年x月的每个星期五上午8点到9点，每隔10分钟执行1次。

核心要素

Quartz有3个核心要素：调度器(Scheduler)、任务(Job)、触发器(Trigger)。

  1. Job（任务）：是一个接口，有一个方法void execute()，可以通过实现该接口来定义需要执行的任务（具体的逻辑代码）。
  2. JobDetail：Quartz每次执行job时，都重新创建一个Job实例，会接收一个Job实现类，以便运行的时候通过newInstance()的反射调用机制去实例化Job.JobDetail是用来描述Job实现类以及相关静态信息，比如任务在scheduler中的组名等信息。
  3. Trigger（触发器）：描述触发Job执行的时间触发规则实现类SimpleTrigger和CronTrigger可以通过cron表达式定义出各种复杂的调度方案。
  4. Calendar：是一些日历特定时间的集合。一个Trigger可以和多个 calendar关联,比如每周一早上10:00执行任务，法定假日不执行，则可以通过calendar进行定点排除。

  5. Scheduler（调度器）：代表一个Quartz的独立运行容器。Trigger和JobDetail可以注册到Scheduler中。Scheduler可以将Trigger绑定到某一JobDetail上，这样当Trigger被触发时，对应的Job就会执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。

    3. 代码结构图

    image.png

    4. 具体的代码分析

  6. 添加依赖。

    1. <!-- SpringBoot集成Quartz -->
    2. <dependency>
    3.  <groupId>org.springframework.boot</groupId>
    4.  <artifactId>spring-boot-starter-quartz</artifactId>
    5. </dependency>

  7. DateTimeJob.java。
    ```java public class DateTimeJob extends QuartzJobBean {

    @Override protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {

    1.  // 获取JobDetail中关联的数据
    2.  String msg = (String) jobExecutionContext.getJobDetail().getJobDataMap().get("msg");
    3.  System.out.println("current time :"+new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "---" + msg);

    }

}

  2. 3. QuartzConfig.java。<br />
  3. ```java
  4. @Configuration
  5. public class QuartzConfig {
  7.     @Bean
  8.     public JobDetail printTimeJobDetail(){
  9.         return JobBuilder.newJob(DateTimeJob.class) // PrintTimeJob我们的业务类
  10.                 .withIdentity("DateTimeJob") // 可以给该JobDetail起一个id
  11.                 // 每个JobDetail内都有一个Map，包含了关联到这个Job的数据，在Job类中可以通过context获取
  12.                 .usingJobData("msg", "Hello Quartz") // 关联键值对
  13.                 .storeDurably() // 即使没有Trigger关联时，也不需要删除该JobDetail
  14.                 .build();
  15.     }
  17.     @Bean
  18.     public Trigger printTimeJobTrigger() {
  19.         CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/1 * * * * ?");
  20.         return TriggerBuilder.newTrigger()
  21.                 .forJob(printTimeJobDetail()) // 关联上述的JobDetail
  22.                 .withIdentity("quartzTaskService") // 给Trigger起个名字
  23.                 .withSchedule(cronScheduleBuilder)
  24.                 .build();
  25.     }
  27. }

5. 结果

image.png