Quartz Learn

1. Quartz 介绍

Quartz is a richly featured, open source job scheduling library that can be integrated within virtually any Java application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may execute virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as support for JTA transactions and clustering.

2. Quart 实例

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

package cn.edu.neu.quartz;

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @author 32098
 */
public class QuartzJob implements Job {
    /**
     *
     * @param jobExecutionContext job 执行上下文对象
     * @throws JobExecutionException ""
     */
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        // 编写业务逻辑
        System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }
}

package cn.edu.neu.quartz;

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

/**
 * @author 32098
 */
public class QuartzScheduler {
    public static void main(String[] args) throws SchedulerException, InterruptedException {
        // 1. Create Scheduler
        SchedulerFactory schedulerFactory = new StdSchedulerFactory();
        Scheduler scheduler = schedulerFactory.getScheduler();
        // 2. Create JobDetail: Bind Job
        /*
         * Why?
         * JobDetail定义的是任务数据(任务名等)，而真正的执行逻辑是存在于Job；
         * 由于任务是有可能并发执行，如果 Scheduler 直接使用Job，就会存在对同一个Job实例并发访问的问题；
         * 采用 JobDetail & Job 的方式，Scheduler 的每次执行，都会根据 JobDetail 创建一个新的 Job 实例以避免并发访问的问题；
         */
        JobDetail jobDetail = JobBuilder.newJob(QuartzJob.class)
                .withIdentity("time_print_job", "default_job_group")
                .build();
        // 3. Create Trigger
        /*
         * Trigger 是 Quartz 的触发器，会去通知 Scheduler 何时去执行对应的 Job
         */
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("time_print_trigger", "default_trigger_group")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5).repeatForever())
                .build();
        // 4. 启动scheduler
        scheduler.scheduleJob(jobDetail, trigger);
        scheduler.start();
    }
}

3. Quartz 核心

3.1 Job & JobDetail & JobDataMap(JobDetail)

• Job 接口

package org.quartz;

public interface Job {
    void execute(JobExecutionContext var1) throws JobExecutionException;
}

  Job 接口只有一个 execute 方法。

• Job 实现类
    我们通过实现 Job 接口来定义实现特定业务逻辑的 Job 类，如下是一个打印时间的 Job：

package cn.edu.neu.quartz;

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @author 32098
 */
public class QuartzJob implements Job {
    /**
     *
     * @param jobExecutionContext job 执行上下文对象
     * @throws JobExecutionException ""
     */
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        // 编写业务逻辑
        System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }
}

在 Job 实现类中，不应该定义有状态的数据属性，因为在 job 的多次执行中，这些属性的值不会保留，需要使用 JobDataMap跟踪 job 的状态

• JobDetail (接口) 与 JobDetail 的 JobDataMap
  • JobDetail 由 JobBuilder 创建，包含 Job 实例的诸多属性
  • JobDataMap 是 JobDetail 的一部分
  • JobDataMap 中可以包含不限量的(序列化的)数据对象，在 Job 实例执行的时候，可以使用其中的数据

package cn.edu.neu.quartz;

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @author 32098
 */
public class QuartzJob implements Job {
    String timePrinterName;

    public void setTimePrinterName(String timePrinterName){
        this.timePrinterName = timePrinterName;
    }

    /**
     *
     * @param jobExecutionContext job 执行上下文对象
     * @throws JobExecutionException ""
     */
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        // 编写业务逻辑
        System.out.println(timePrinterName+"\t"+new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
                // if no timePrinterName and set method of timePrinterName, we need get printerName by
//        String printerName = jobExecutionContext.getJobDetail().getJobDataMap().getString("timePrinterName");
//        System.out.println(printerName+"\t"+new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }
}

package cn.edu.neu.quartz;

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

/**
 * @author 32098
 */
public class QuartzScheduler {
    public static void main(String[] args) throws SchedulerException, InterruptedException {
        // 1. Create Scheduler
        SchedulerFactory schedulerFactory = new StdSchedulerFactory();
        Scheduler scheduler = schedulerFactory.getScheduler();
        // 2. Create JobDetail: Bind Job
        JobDetail jobDetail1 = JobBuilder.newJob(QuartzJob.class)
                .withIdentity("time_print_job_1", "default_job_group")
                .usingJobData("timePrinterName", "time_printer_1")
                .build();
        JobDetail jobDetail2 = JobBuilder.newJob(QuartzJob.class)
                .withIdentity("time_print_job_2", "default_job_group")
                .usingJobData("timePrinterName", "time_printer_2")
                .build();
        // 3. Create Trigger
        Trigger trigger1 = TriggerBuilder.newTrigger()
                .withIdentity("time_print_trigger1", "default_trigger_group")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5).repeatForever())
                .build();
        Trigger trigger2 = TriggerBuilder.newTrigger()
                .withIdentity("time_print_trigger2", "default_trigger_group")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(10).repeatForever())
                .build();
        // 4. 启动scheduler
        scheduler.scheduleJob(jobDetail1, trigger1);
        scheduler.scheduleJob(jobDetail2, trigger2);
        scheduler.start();
    }
}

3.2 Trigger

3.2.1 SimpleTrigger

• SimpleTrigger 满足的调度需求：
  • 在具体的时间点执行一次，或者在具体的时间点执行，并且以指定的间隔重复执行若干次
• SimpleTrigger 的重要设置项
  • 开始时间
  • 结束时间
  • 重复次数
  • 重复间隔
• SimpleScheduleBuilder

使用见上例

3.2.2 CronTrigger

• CronTrigger 与 Simple Trigger 不同，其调度是基于日历的而不是按照SimpleTrigger的精确指定间隔进行作业调度
• 但是，CronTrigger 和 SimpleTrigger 都有一个 startTime(指定何时生效)，以及一个可选的 endTime(指定何时停止计划)
• Cron Expressions 表达式
  • Cron Expressions是由七个子表达式组成的字符串，用于描述日程表的各个细节(子表达式用空格分隔)
  • Cron Expressions 的七个子表达式：
    1. Seconds：0-59
    2. Minutes：0-59
    3. Hours：0-23
    4. Day-of-Month：日期可以是1-31的任何值，但需注意给定月份的天数
    5. Month：月份可以指定为0到11之间的值，或者使用字符串JAN，FEB，MAR，APR，MAY，JUN，JUL，AUG，SEP，OCT，NOV和DEC
    6. Day-of-Week：星期几可以指定为1到7(1 =星期日)之间的值，或者使用字符串SUN，MON，TUE，WED，THU，FRI和SAT
    7. Year：optional field
  • 其它
    • *：对应字段的所有可能值，如周(Day-of-Week)
    • /：用于指定值的增量，0/15 (分钟)——每隔15分钟，从零开始
    • L、W、# 等
• 一些调度要求太复杂，无法用单一触发表示时，可以创建两个或多个触发器，并注册它们来运行相同的作业
• CronScheduleBuilder

4. TriggerListeners & JobListeners & SchedulerListener

• Listeners 是我们创建的对象，用于根据调度程序中发生的事件执行恰当的操作
• TriggerListeners 接收到与 trigger 相关的事件(触发器触发、触发器失灵、触发器完成)，JobListeners 接收与 job 相关的事件(job即将执行的通知、job完成执行时的通知)，SchedulerListeners 接受与计划程序相关的事件(添加job/触发器、删除job/触发器、调度程序中的严重错误、关闭调度程序的通知等)
• Listeners 注册到调度程序的 ListenerManager

5. Quartz 配置：见 http://www.quartz-scheduler.org/documentation/quartz-2.3.0/configuration/