分布式定时任务调度框架Quartz学习与实战记录完整篇

Posted 2021-08-18 Tang.Mr

1.Quartz的概念

Quartz就是一个基于Java实现的任务调度框架，用于执行你想要执行的任何任务。
Quartz是OpenSymphony开源组织在Job scheduling（定时调度）领域的开源项目，它可以与J2EE和J2SE应用程序相结合也可以单独使用。

Quartz是开源且具有丰富特性的任务调度库，能够集成任何的Java应用。它能创建简单的或者复杂的调度任务，以执行上十，上百，上千，上万的任务。任务job被定义为标准的Java组件。能工执行任何你想要实现的功能。Quartz调度框架包含许多企业级的特性，如JTA事务，集群的支持。

官网：http://www.quartz-scheduler.org/

2.Quartz运行环境

• Quartz可以运行嵌入在另一个独立的应用程序中
• Quartz可以在应用程序服务器（或servlet容器）内被实例化，bin参与事务
• Quartz可以作为一个独立的程序运行（其自己的java虚拟机内），可以通过RMI使用
• Quartz可以被实例化，作为独立的项目集群（负载平衡和故障转移功能），用于作业执行

3.Quartz使用的设计模式

• Builder模式
• Factory模式
• 组件模式
• 链式编程

4.Quartz学习的核心概念

• 任务Job

job就是你想实现的任务类，每一个job必须实现org.quartz.job接口，且只需实现接口定义的execute()方法

• 触发器Trigger

Trigger为你执行任务的触发器（定时）
Trigger主要包含两个SimpleTrigger和CronTrigger两种

• 调度器Scheduler

Scheduler为定时任务调度，它会将任务Job及触发器Trigger整合起来，负责基于Trigger设定的时间来执行Job

5.Quartz的体系结构

6.Quartz的几个常用API

• Scheduler：用于定时调度程序交互的主程序接口。Scheduler调度程序：任务执行计划表，只有安排进执行计划的任务Job【通过scheduler.scheduleJob方法安排进执行任务】，当它预先定义的执行时间到了的时候（任务出发trigger）该任务才会被执行

• Job：预先定义的，希望在未来某个使劲能被调度程序执行的任务类，可自定义

• JobDetail：使用JobDetail来定义定时任务的实例，JobDetail实例是通过JobBuilder类创建的

• JobDataMap：可以包含不限量（序列化的）的数对象，在Job实例执行的时候，可以使用其中的数据；JobDataMap是Java Map接口的一个实现，额外增加了一些便于存取基本类型数据的方法

• Trigger：触发器，Trigger对象是用来触发执行Job的。当调度一个Job时，我们实例一个触发器然后调整他的属性来满足Job执行的条件。表明任务在什么时候会执行。【定义了一个已经被安排的任务将会在什么时候执行的时间条件】

• JobBuilder：用于声明一个任务实例，也可以定义关于该任务的详情比如任务名，组名等。通过JobBuilder声明的实例将会作为一个实际执行的任务。

• TriggerBuilder：触发器创建器，用于创建触发器trigger实例

• JobListener、TriggerListener、SchedulerListener监听器，用于对组件的监听

7.入门案例

构建一个任务类实现Job接口，重写execute（执行方法）方法，在执行方法中编写定时调度需要实现的逻辑。
创建一个main方法，在main方法中构建任务实例和处方实例有调度器实例进行绑定并开启任务。

7.1.pom.xml

<dependency>
  <groupId>org.quartz-scheduler</groupId>
  <artifactId>quartz</artifactId>
  <version>2.3.0</version>
</dependency>

<dependency>
  <groupId>org.quartz-scheduler</groupId>
  <artifactId>quartz-jobs</artifactId>
  <version>2.3.0</version>
</dependency>

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
</dependency>

7.2.任务类

/**
 * @Author ScholarTang
 * @Date 2021/7/13 10:45
 * @Desc 任务类
 */
@Slf4j
public class HelloJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) + " | 任务被执行了");
    }
}

7.3.调度器

/**
 * @Author ScholarTang
 * @Date 2021/7/13 10:53
 * @Desc 调度器
 */
public class HelloSchedulerDemo {
    public static void main(String[] args) throws SchedulerException {
        //从调度工厂中获取调度器实例
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
        //通过JobBuilder构建一个任务实例
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class)
                //设置任务的唯一实例名称和任务组名称组名
                .withIdentity("job1", "group1")
                //构建实例
                .build();
        //通过TriggerBuilder构建触发器实例
        SimpleTrigger trigger = TriggerBuilder.newTrigger()
                //设置触发器唯一实例名称和触发器的组名
                .withIdentity("trigger1", "group1")
                //执行计划，每五秒执行一次
                .withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(5))
                //立即执行
                .startNow()
                //构建实例
                .build();
        //调度器绑定任务实例和触发器
        scheduler.scheduleJob(jobDetail,trigger);
        //开启定时任务
        scheduler.start();
    }
}

7.4.执行结果

8.Job和JobDetail的关系介绍

• Job：工作任务调度接口，任务类需要实现的接口。该接口中定义了execute方法，类似JDK提供的TimeTask类的run方法。在这里面编写任务执行的业务逻辑
• Job实例在Quartz中的生命周期：每次调度器执行Job时，它在调用execute方法前会创建一个新的Job实例，当调度完成后，管理的Job对象实例将会被释放，释放的实例会被垃圾回收机制回收

@Slf4j
public class HelloJob implements Job {

    public HelloJob(){
        log.info("实例被创建了");
    }

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) + " | 任务被执行了");
    }
}

• JobDetail：JobDetail为Job实例提供了许多设置属性，已经JobDetaMap成员变量属性，它用来存储特定Job实例的状态信息，调度器需要借助于JobDetail对象来添加Job实例【JobDetail中重要的属性：name[任务实例的唯一标识名称]、group[任务调度实例的组名]、jobClass[任务类信息]、jobDataMap】

@Slf4j
public class HelloSchedulerDemo {
    public static void main(String[] args) throws SchedulerException {
        //从调度工厂中获取调度器实例
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
        //通过JobBuilder构建一个任务实例
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class)
                //设置任务的唯一实例名称和任务组名称组名
                .withIdentity("job1", "group1")
                //构建实例
                .build();
        //jobDataMap
        JobDataMap jobDataMap = jobDetail.getJobDataMap();
        //任务实例的唯一标识名称
        String name = jobDetail.getKey().getName();
        //任务调度实例的组名
        String group = jobDetail.getKey().getGroup();
        //任务类信息
        String clazzName = jobDetail.getKey().getClass().getName();
        log.info("jobDataMap:{}", jobDataMap);
        log.info("任务实例的唯一标识名称："+name);
        log.info("任务调度实例的组名："+group);
        log.info("任务类信息："+clazzName);
        //通过TriggerBuilder构建触发器实例
        SimpleTrigger trigger = TriggerBuilder.newTrigger()
                //设置触发器唯一实例名称和触发器的组名
                .withIdentity("trigger1", "group1")
                //执行计划，每五秒执行一次
                .withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(5))
                //立即执行
                .startNow()
                //构建实例
                .build();
        //调度器绑定任务实例和触发器
        scheduler.scheduleJob(jobDetail,trigger);
        //开启定时任务
        scheduler.start();
    }
}

9.JobExecutionContext的介绍

• 当Scheduler调用一个Job，就会将JobExecutionContext传递给Job的execute()方法

• Job能通过JobExecuteContext对象访问到Quartz运行时的环境以及Job本身的明细数据

  • 获取JobDetail相关信息、获取Trigger相关信息、获取Job类本身的信息

  /**
   * @Author ScholarTang
   * @Date 2021/7/13 10:45
   * @Desc 任务类
   */
  @Slf4j
  public class HelloJob implements Job {
      @Override
      public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
          //通过JobExecutionContext获取JobDetail
          JobDetail jobDetail = jobExecutionContext.getJobDetail();
          JobKey jobKey = jobDetail.getKey();
          String jobDetailName = jobKey.getName();
          String jobDetailGroup = jobKey.getGroup();
          String jobClazzNameJobDetail = jobKey.getClass().getName();
          log.info("任务实例的唯一标识名称：" + jobDetailName);
          log.info("任务实例的组名：" + jobDetailGroup);
          log.info("任务实例绑定的任务类信息：" + jobClazzNameJobDetail);
          log.info("-----------------------------------------");
          //通过JobExecutionContext获取Trigger
          Trigger trigger = jobExecutionContext.getTrigger();
          TriggerKey triggerKey = trigger.getKey();
          String triggerKeyName = triggerKey.getName();
          String triggerKeyGroup = triggerKey.getGroup();
          String triggerClazzName = triggerKey.getClass().getName();
          log.info("触发器的唯一标识名称：" + triggerKeyName);
          log.info("触发器的组名：" + triggerKeyGroup);
          log.info("触发器绑定的任务类信息：" + triggerClazzName);
          log.info("-----------------------------------------");
          //通过JobExecutionContext
          String jobClazzName = jobExecutionContext.getClass().getName();
          log.info("job类相关的信息："+jobClazzName);
          log.info("-----------------------------------------");
          log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) + " | 任务被执行了");
      }
  }
  

10.JobDataMap介绍

10.1.使用Map获取

• 在进行任务调度时，JobDataMap存储在JobExecutionContent中，非常方便获取
• JobDataMap可以用来存储任何可序列化的数据对象，当Job实例对象被执行时这些参数都会传递给它
• JobDataMap实现了JDK的Map接口，并且添加了非常方便的方法来存储基本数据类型

/**
 * @Author ScholarTang
 * @Date 2021/7/13 10:53
 * @Desc 调度器
 */
@Slf4j
public class HelloSchedulerDemo {
    public static void main(String[] args) throws SchedulerException {
        //从调度工厂中获取调度器实例
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
        //通过JobBuilder构建一个任务实例
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class)
                //设置任务的唯一实例名称和任务组名称组名
                .withIdentity("job1", "group1")
                //设置jobDataMap数据  <<===============
                .usingJobData("message","勇敢牛牛、不怕困难")
                //构建实例
                .build();
        //通过TriggerBuilder构建触发器实例
        SimpleTrigger trigger = TriggerBuilder.newTrigger()
                //设置触发器唯一实例名称和触发器的组名
                .withIdentity("trigger1", "group1")
                //设置jobDataMap数据   <<===============
                .usingJobData("username","张三")
                //执行计划，每五秒执行一次
                .withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(5))
                //立即执行
                .startNow()
                //构建实例
                .build();
        //调度器绑定任务实例和触发器
        scheduler.scheduleJob(jobDetail,trigger);
        //开启定时任务
        scheduler.start();
    }
}

/**
 * @Author ScholarTang
 * @Date 2021/7/13 10:45
 * @Desc 任务类
 */
@Slf4j
public class HelloJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //通过JobExecutionContext获取JobDetail
        JobDetail jobDetail = jobExecutionContext.getJobDetail();
        JobKey jobKey = jobDetail.getKey();
        String jobDetailName = jobKey.getName();
        String jobDetailGroup = jobKey.getGroup();
        String jobClazzNameJobDetail = jobKey.getClass().getName();
        log.info("任务实例的唯一标识名称：" + jobDetailName);
        log.info("任务实例的组名：" + jobDetailGroup);
        log.info("任务实例绑定的任务类信息：" + jobClazzNameJobDetail);
        log.info("-----------------------------------------");
        //通过JobExecutionContext获取Trigger
        Trigger trigger = jobExecutionContext.getTrigger();
        TriggerKey triggerKey = trigger.getKey();
        String triggerKeyName = triggerKey.getName();
        String triggerKeyGroup = triggerKey.getGroup();
        String triggerClazzName = triggerKey.getClass().getName();
        log.info("触发器的唯一标识名称：" + triggerKeyName);
        log.info("触发器的组名：" + triggerKeyGroup);
        log.info("触发器绑定的任务类信息：" + triggerClazzName);
        log.info("-----------------------------------------");
        //通过JobExecutionContext
        String jobClazzName = jobExecutionContext.getClass().getName();
        log.info("job类相关的信息："+jobClazzName);
        log.info("-----------------------------------------");
        //获取JobDetail中JobDataMap中的message内容  <<===============
        JobDataMap jobDataMap = jobDetail.getJobDataMap();
        String message = jobDataMap.getString("message");
        log.info("从JobDetail-JobDataMap中或到的message内容为：" + message);
        //获取Trigger中JobDataMap中的username内容   <<===============
        JobDataMap triggerJobDataMap = trigger.getJobDataMap();
        String username = triggerJobDataMap.getString("username");
        log.info("从Trigger-JobDataMap中获取到的username内容为：" + username);
        log.info("-----------------------------------------");
        log.info(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()) + " | 任务被执行了");
    }
}

10.2.Job实现类中添加setter方法对应JobDataMap的键值，Quartz框架默认的JobFactory实现类在初始化Job实例对象时会自动的调用这些setter方法

调度器的内容是不变的。
注意：如果任务实例和触发器的JobDataMap中使用的是同一个key那么触发器的JobDataMap值会覆盖掉任务实例的值

/**
 * @Author ScholarTang
 * @Date 2021/7/13 10:45
 * @Desc 任务类
 */
@Slf4j
public class HelloJob implements Job {

    private String message;
    private String username;

    public void setMessage(String message) {
        this.message = message;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //通过JobExecutionContext获取JobDetail
        JobDetail jobDetail = jobExecutionContext.getJobDetail();
        JobKey jobKey = jobDetail.getKey();
        String jobDetailName = jobKey.getName();
        String jobDetailGroup = jobKey.getGroup();
        String jobClazzNameJobDetail = jobKey.getClass().getName();
        log.info("任务实例的唯一标识名称：" + jobDetailName);
        log.info("任务实例的组名：" + jobDetailGroup);
        log.info("任务实例绑定的任务类信息：" + jobClazzNameJobDetail);
        log.info("-----------------------------------------");
        //通过JobExecutionContext获取Trigger
        Trigger trigger = jobExecutionContext.getTrigger();
        TriggerKey triggerKey = trigger.getKey();
        String triggerKeyName = triggerKey.getName();
        String triggerKeyGroup = triggerKey.getGroup();
        String triggerClazzName = triggerKey.getClass().getName();
        log.info("触发器的唯一标识名称：" + triggerKeyName);
        log.info("触发器的组名：" + triggerKeyGroup);
        log.info("触发器绑定的任务类信息：" + triggerClazzName);
        log.info("-----------------------------------------");
        //通过JobExecutionContext
        String jobClazzName = jobExecutionContext.getClass().getName();
        log.info以上是关于分布式定时任务调度框架Quartz学习与实战记录完整篇的主要内容，如果未能解决你的问题，请参考以下文章
 
 分布式定时任务调度框架Quartz学习与实战记录完整篇
 分布式定时任务调度框架Quartz学习与实战记录完整篇
 分布式定时任务调度框架Quartz学习与实战记录完整篇
 分布式定时任务调度框架Quartz学习与实战记录完整篇
 SpringBoot与quartz框架实现分布式定时任务
 深入浅出Spring原理及实战「开发实战系列」手把手教你将@Schedule任务调度升级为分布式调度@DistributeSchedule