SpringBoot 2.x + quartz 实现分布式定时任务

一、Quartz 核心概念

   我们需要明白 Quartz 的几个核心概念，这样理解起 Quartz 的原理就会变得简单了。

1.Job:  表示一个工作，要执行的具体内容。此接口中只有一个方法，如下：
   void execute(JobExecutionContext context)

2.JobDetail:  表示一个具体的可执行的调度程序，Job 是这个可执行程调度程序所要执行的内容，另外 JobDetail 还包含了这个任务调度的方案和策略。

3.Trigger:  代表一个调度参数的配置，什么时候去调。

4.Scheduler:  代表一个调度容器，一个调度容器中可以注册多个 JobDetail 和 Trigger。当 Trigger 与 JobDetail 组合，就可以被 Scheduler 容器调度了。

二、结构介绍

1. 项目结构：

  包名解释:
    1. command: 此包中包含实现了springboot中CommandLineRunner的JobCommandLine，应用启动后会执行CommandLineRunner类中run方法中的代码，利用这个特性执行定时任务很好用！
    2. config: 此项目采用的是JavaConfig+application.properties的配置方式，此包中是所有的JavaConfig配置类。
    3. mapper: mapper层。
    4. model: 各种数据模型。
    5. quartz: 包含各种job和支持。
    6. service: service层。
    7. utils: 各种工具类。

三、代码配置

1. 多数据源配置 - DataSourceConfig：

    1.1 JavaConfig

    1.2 application.properties

  代码解释:
  配置了数据库连接池最基本的一些属性。

2. Quartz配置 - QuartzConfig：

  代码解释:
  1. schedulerFactory方法：注入schedulerFactory。
  2. jobFactory方法：注入AutowiringSpringBeanJobFactory。
  3. scheduleJobService方法：注入ScheduleJobService。
  4. threadPoolTaskExecutor方法：注入ThreadPoolTaskExecutor(线程池任务执行器)。

3. 多数据源 Mybatis配置(其一) - AccountMybatisConfig：

四、开发流程

1. JobCommandLine：

  代码解释:
  1. 此类(JobCommandLine)实现了SpringBoot中的CommandLineRunner接口，这是一个函数式接口，应用启动时会执行其中的run方法，很适合搭配定时任务使用！
  2. run方法中的findAllUserJob.startJob() 和findAllActivityJob.startJob() 分属两个微服务(两个数据源)。
  3. 进入到startJob() 方法中，进入到了SimpleAbstractJob类，见第4节。

2. Job：

  代码解释:
  1.此接口来自 package org.quartz;，这就是quartz的四大核心概念之一，这个接口里只有一个方法，就是 execute方法，方法体里的内容就是定时任务的执行程序，需要我们实现该接口来添加。(该方法很重要，下面也有讲述)
  Job接口的继承结构:

  下面将一个一个进行讲解。

3. CommonAbstractJob：

  代码解释:
   此类是一个抽象类，继承Job接口，不过并没有实现 execute方法，那它的作用是什么呢？在CommonAbstractJob里，注入了一个ScheduleJobService，在enableSchedule方法中，执行了：

scheduleJobService.enableSchedule(job, jobDataMap)

这个方法是什么意思呢？进入到ScheduleJobService中看一下便知晓了。

4. ScheduleJobService：

  代码解释:
  1.在讲解enableSchedule方法之前，我想先讲解一下Scheduler是怎么被注入的。打开QuartzConfig配置类，如下：

  代码解释:
  1. 此处会说明Quartz四大核心概念中的Scheduler。
  2. 看 scheduleFactory方法 ，被@Bean修饰，说明是一个注入的类；@ConditionalOnMissingBean(name = “schedulerFactory”)，说明是在缺失schedulerFactory的时候才生效。此方法返回类型是SchedulerFactoryBean，进入到这个类中：

  代码解释:
  此处重点在于SchedulerFactoryBean类实现了InitializingBean接口，实现了该接口的类会在应用启动时被注入Spring容器并执行其中的afterPropertiesSet方法，如下：

  代码解释:
  此方法的作用就是使用ScheduleFactory(ScheduleFactory在此类中的initSchedulerFactory方法初始化生成，是StdSchedulerFactory类型的)生成Scheduler。
  总结:
  配置SchedulerFactoryBean，就会自动为我们生成ScheduleFactory和Scheduler。


  下面回过头来继续看ScheduleJobService中的enableSchedule方法：

  代码解释:
  Quartz四大概念中的最后二位登场了，它就是JobDetail和Trigger，在这个方法中，将设置JobDetail程序和Trigger触发器并且将其放入Scheduler容器执行。

5. SimpleAbstractJob：

  代码解释:
  1. 继承CommonAbstractJob抽象类，此类的重点在于 startJob()方法，这是定时任务的启动方法！ScheduleJob类是我们自己定义的包装了jobName、jobGroup、cronExpression等信息的实体类。如下：

  2. enableSchedule方法就是执ScheduleJobService中的enableSchedule方法！

6. FindAllUserJob：

  代码解释:
  1. FindAllUserJob是我们自己的Job类，此类继承SimpleAbstractJob抽象类(继承了startJob方法)，间接实现了Job接口的execute方法(我们定时器的业务代码写在这里面)，也就是说我们的FindAllUserJob类既拥有了startJob方法也拥有了execute方法。
  2. 由上述代码可见，我们定时器任务执行了每隔1分钟查询一次所有用户的操作。

五、总结

  源码地址: gitee：https://gitee.com/wxj1994/buddy