02 Quartz-初识Quartz-组件解释

2019-05-20 本文已影响0人花神子

02 Quartz-初识Quartz-组件

quartz

01 Quartz-初识Quartz-样例入手 实现了一个简单运行demo. 正常情况下也能运行起来，进行日志输出！

本篇根据这个demo 对其一些组件进行一个解释析！

Quartz 名词定义

1. Job

Quartz中的Job是什么？

Job - 由希望由调度程序执行的组件实现的接口。
所以实在开发中我们需要实现Job 接口，重写 void execute(JobExecutionContext context) 方法。

package org.quartz;

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

Job使用逻辑：我们只需创建一个job类，然后创建多个与该job关联的JobDetail实例，每一个实例都有自己的属性集和JobDataMap，最后，将所有的实例都加到scheduler中。当一个trigger被触发时，与之关联的JobDetail实例会被加载，JobDetail引用的job类通过配置在Scheduler上的JobFactory进行初始化。默认的JobFactory实现，仅仅是调用job类的newInstance()方法，然后尝试调用JobDataMap中的key的setter方法。你也可以创建自己的JobFactory实现，比如让你的IOC或DI容器可以创建/初始化job实例。
Job的并发说明：@DisallowConcurrentExecution：将该注解加到job类上，告诉Quartz不要并发地执行同一个job定义（这里指特定的job类）的多个实例。所以该限制是针对JobDetail的，而不是job类的。但是我们认为（在设计Quartz的时候）应该将该注解放在job类上，因为job类的改变经常会导致其行为发生变化。
Job状态： @PersistJobDataAfterExecution：将该注解加在job类上，告诉Quartz在成功执行了job类的execute方法后（没有发生任何异常），更新JobDetail中JobDataMap的数据，使得该job（即JobDetail）在下一次执行的时候，JobDataMap中是更新后的数据，而不是更新前的旧数据。和 @DisallowConcurrentExecution注解一样，尽管注解是加在job类上的，但其限制作用是针对job实例的，而不是job类的。由job类来承载注解，是因为job类的内容经常会影响其行为状态（比如，job类的execute方法需要显式地“理解”其”状态“）。

...其他特性参考：

2. JobDetail

Quartz中的JobDetail是什么？
通过对Job的理解，我们知道非常容易实现，只需要实现Job 接口，重写execute方法。这样我们就实现了一个Job接口的类，但是呢这个类的功能其实我们也知道它仅仅是完成某个功能/任务，除此之外：Quartz还需要知道该Job实例所包含的属性；这将由JobDetail类来完成。

JobDetail - 用于定义作业的实例，JobDetail实例是通过JobBuilder类创建的。它包含job的各种属性设置，以及用于存储job实例状态信息的JobDataMap。
JobDetail对象是在将job加入scheduler时，由客户端程序（你的程序）显示创建的。看下面代码片段：

JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(jobName, jobGroup).build();
...
scheduler.scheduleJob(jobDetail, trigger);

我们传给scheduler一个JobDetail实例，因为我们在创建JobDetail时，将要执行的job的类名传给了JobDetail，所以scheduler就知道了要执行何种类型的job；每次当scheduler执行job时，在调用其execute(…)方法之前会创建该类的一个新的实例；执行完毕，对该实例的引用就被丢弃了，实例会被垃圾回收；这种执行策略带来的一个后果是，job必须有一个无参的构造函数（当使用默认的JobFactory时）；另一个后果是，在job类中，不应该定义有状态的数据属性，因为在job的多次执行中，这些属性的值不会保留。
JobDataMap (demo中并没有使用该组件)JobDataMap中可以包含不限量的（序列化的）数据对象，在job实例执行的时候，可以使用其中的数据；JobDataMap是Java Map接口的一个实现，额外增加了一些便于存取基本类型的数据的方法。使用方式如下：

// add data to JobDataMap
JobDetail job = newJob(DumbJob.class)
    .withIdentity("myJob", "group1") // name "myJob", group "group1"
    .usingJobData("data1", "aaa")
    .usingJobData("data2", "bbb")
    .build();

//get data from JobDataMap
public class MybJob implements Job { 
    public void execute(JobExecutionContext context) throws JobExecutionException { 
        JobKey key = context.getJobDetail().getKey(); 
        JobDataMap dataMap = context.getJobDetail().getJobDataMap(); 
        String data1 = dataMap.getString("jobSays"); 
        String data2 = dataMap.getFloat("myFloatValue"); 
        System.err.println("data1 " + data1 + ", and data2 is: " + data2); 
    } 
}

3. Trigger

Trigger（即触发器） - 定义执行给定作业的计划的组件。
Trigger用于触发Job的执行。当你准备调度一个job时，你创建一个Trigger的实例，然后设置调度相关的属性。Trigger也有一个相关联的JobDataMap，用于给Job传递一些触发相关的参数。Quartz自带了各种不同类型的Trigger，最常用的主要是SimpleTrigger和CronTrigger。
- SimpleTrigger主要用于一次性执行的Job（只在某个特定的时间点执行一次），或者Job在特定的时间点执行，重复执行N次，每次执行间隔T个时间单位。
- CronTrigger在基于日历的调度上非常有用，如“每个星期五的正午”，或者“每月的第十天的上午10:15”等。

TriggerBuilder<Trigger> triggerBuilder  = TriggerBuilder
        .newTrigger()
        .withIdentity(jobName, jobGroup); 
Trigger trigger = triggerBuilder
        .startAt(triggerDate)
        .withSchedule(schedBuilder)
        .build(); // 将job trigger放入scheduler scheduler.scheduleJob(jobDetail, trigger);

4. Scheduler

Scheduler - 与调度程序交互的主要API。
Scheduler的生命期，从SchedulerFactory创建它时开始，到Scheduler调用shutdown()方法时结束；Scheduler被创建后，可以增加、删除和列举Job和Trigger，以及执行其它与调度相关的操作（如暂停Trigger）。但是，Scheduler只有在调用start()方法后，才会真正地触发trigger（即执行job),使用Scheduler之前，需要实例化。

public class QuartzScheduler {

    /**
     * 定义 全局 Scheduler 方便以下方法使用
     */
    private static Scheduler scheduler;

    /**Scheduler
     * 初始化
     */
    static {
        try {
            scheduler = getSechduler();
        } catch (SchedulerException e) {
            e.printStackTrace();
        }
    }

    /**
     * 获取Scheduler instance
     * 实际生产中不建议这么做：最好采用资源隔离的方式；避免任务过多进行资源抢占导致任务misfire
     * @return
     * @throws SchedulerException
     */
    public static Scheduler getSechduler() throws SchedulerException {
        SchedulerFactory schedulerFactory = new StdSchedulerFactory();
        if (scheduler == null) {
            synchronized (QuartzScheduler.class) {
                if (scheduler == null) {
                    scheduler = schedulerFactory.getScheduler();
                }
            }
        }
        return scheduler;
    }
}

scheduler实例化后，可以启动(start)、暂停(stand-by)、停止(shutdown)。
注意：scheduler被停止后，除非重新实例化，否则不能重新启动；只有当scheduler启动后，即使处于暂停状态也不行，trigger才会被触发（job才会被执行）。