作业调度框架 Quartz 学习笔记

作业调度框架 Quartz 学习笔记

作业被安排在一个给定的触发时运行。触发器可以使用以下指令的接近任何组合来创建：

• 在一天中的某个时间（到毫秒）
• 在一周的某几天
• 在每月的某一天
• 在一年中的某些日期
• 不在注册的日历中列出的特定日期（如商业节假日除外）
• 重复特定次数
• 重复进行，直到一个特定的时间/日期
• 无限重复
• 重复的延迟时间间隔

作业(job)是由其创建者赋予的名字，也可以组织成命名组(group)。触发器(trigger)也可以给予名称和放置在组中，以方便地将它们调度内组织。作业可以被添加到所述调度器一次，而是具有多个触发器注册。在企业Java环境中，作业可以执行自己的工作作为分布式（XA）事务的一部分。

---

helloworld

导入maven依赖

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

HelloJob.java

package com.zttech.demo.quartz;

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
/**
 * Quartz中定义要执行的工作
 * @author guoqicheng
 *
 */
public class HelloJob implements Job {

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("Hello Quartz!");
    }

}

CronTriggerExample.java

package com.zttech.demo.quartz;

import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;

/**
 * Quartz触发器
 * CronTrigger例子
 * 每间隔5秒运行
 * @author guoqicheng
 *
 */
public class CronTriggerExample {
    public static void main( String[] args ) throws Exception
    {
        JobDetail job = JobBuilder.newJob(HelloJob.class)
        .withIdentity("dummyJobName", "group1").build();

        //CronTrigger – 允许UNIX cron表达式来指定日期和时间来运行作业 
        Trigger trigger = TriggerBuilder
        .newTrigger()
        .withIdentity("dummyTriggerName", "group1")
        .withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?"))
        .build();

        //调度类链接“工作”和“触发器”到一起，并执行它
        Scheduler scheduler = new StdSchedulerFactory().getScheduler();
        scheduler.start();
        scheduler.scheduleJob(job, trigger);

    }
}

运行结果：从0秒开始，每隔5秒输出一次Hello Quartz!。

---

JobListener

创建一个JobListener并且观察工作运行状态的变化。

HelloJob.java

package com.zttech.demo.jobListener;

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

public class HelloJob implements Job {

    @Override
    public void execute(JobExecutionContext arg0) throws JobExecutionException {
        System.out.println("Hello Quartz! - by guoqicheng");    

        //Throw exception for testing
        throw new JobExecutionException("Testing Exception");
    }

}

HelloJobListener.java

package com.zttech.demo.jobListener;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.JobListener;
/**
 * 创建一个JobListener，只是实现了JobListener接口，并覆盖所有的接口的方法。
 * @author guoqicheng
 *
 */
public class HelloJobListener implements JobListener {

    public static final String LISTENER_NAME = "dummyJobListenerName";

    @Override
    public String getName() {
        return LISTENER_NAME; //must return a name
    }


    @Override
    public void jobExecutionVetoed(JobExecutionContext context) {
        System.out.println("jobExecutionVetoed");

    }

    // Run this if job is about to be executed.
    @Override
    public void jobToBeExecuted(JobExecutionContext context) {
        String jobName = context.getJobDetail().getKey().toString();
        System.out.println("Job : " + jobName + " is going to start...");
        System.out.println("jobToBeExecuted");
    }

    //Run this after job has been executed
    @Override
    public void jobWasExecuted(JobExecutionContext context,
            JobExecutionException jobException) {
        System.out.println("jobWasExecuted");

        String jobName = context.getJobDetail().getKey().toString();
        System.out.println("Job : " + jobName + " is finished...");

        if (!jobException.getMessage().equals("")) {
            System.out.println("Exception thrown by: " + jobName
                + " Exception: " + jobException.getMessage());
        }

    }

}

CronTriggerExample.java

package com.zttech.demo.jobListener;

import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.quartz.impl.matchers.KeyMatcher;

public class CronTriggerExample {
    public static void main(String[] args) throws Exception {

        JobKey jobKey = new JobKey("dummyJobName", "group1");
        JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity(jobKey).build();

        Trigger trigger = TriggerBuilder.newTrigger().withIdentity("dummyTriggerName", "group1")
                .withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?")).build();

        Scheduler scheduler = new StdSchedulerFactory().getScheduler();

        // Listener attached to jobKey
        scheduler.getListenerManager().addJobListener(new HelloJobListener(), KeyMatcher.keyEquals(jobKey));

        // Listener attached to group named "group 1" only.
        // scheduler.getListenerManager().addJobListener(
        // new HelloJobListener(), GroupMatcher.jobGroupEquals("group1")
        // );

        scheduler.start();
        scheduler.scheduleJob(job, trigger);

    }
}

运行结果:
Job : group1.dummyJobName is going to start…
jobToBeExecuted
Hello Quartz! - by guoqicheng
jobWasExecuted
Job : group1.dummyJobName is finished…
Exception thrown by: group1.dummyJobName Exception: Testing Exception

---

Quartz执行多作业

在Quartz调度框架中，每个作业将被连接到一个唯一的触发，并且由调度器运行它。在 Quartz 中，一个触发器触发多个作业是不可以的。
创建3个作业JobA、JobB、JobC。

CronTriggerExample.java

package com.zttech.demo.jobListeners;

import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
/**
 * 使用QuartzAPI声明上述3个作业，分配它们到特定触发器并调度它
 * @author guoqicheng
 *
 */
public class CronTriggerExample {
    public static void main( String[] args ) throws Exception
    {

    JobKey jobKeyA = new JobKey("jobA", "group1");
        JobDetail jobA = JobBuilder.newJob(JobA.class)
        .withIdentity(jobKeyA).build();

        JobKey jobKeyB = new JobKey("jobB", "group1");
        JobDetail jobB = JobBuilder.newJob(JobB.class)
        .withIdentity(jobKeyB).build();

        JobKey jobKeyC = new JobKey("jobC", "group1");
        JobDetail jobC = JobBuilder.newJob(JobC.class)
        .withIdentity(jobKeyC).build();


        Trigger trigger1 = TriggerBuilder
        .newTrigger()
        .withIdentity("dummyTriggerName1", "group1")
        .withSchedule(
            CronScheduleBuilder.cronSchedule("0/3 * * * * ?"))
        .build();

        Trigger trigger2 = TriggerBuilder
        .newTrigger()
        .withIdentity("dummyTriggerName2", "group1")
        .withSchedule(
            CronScheduleBuilder.cronSchedule("0/5 * * * * ?"))
        .build();

        Trigger trigger3 = TriggerBuilder
        .newTrigger()
        .withIdentity("dummyTriggerName3", "group1")
        .withSchedule(
            CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
        .build();

        Scheduler scheduler = new StdSchedulerFactory().getScheduler();

        scheduler.start();
        scheduler.scheduleJob(jobA, trigger1);
        scheduler.scheduleJob(jobB, trigger2);
        scheduler.scheduleJob(jobC, trigger3);

    }
}

在调度器中A,B,C三个作业分别每隔3、5、10秒运行一次。

---

cron表达式

格式: [秒] [分] [小时] [日] [月] [周] [年]

序号	说明	是否必填	允许填写的值	允许的通配符
1	秒	是	0-59	, - * /
2	分	是	0-59	, - * /
3	小时	是	0-23	, - * /
4	日	是	1-31	, - * ? / L W
5	月	是	1-12 or JAN-DEC	, - * /
6	周	是	1-7 or SUN-SAT	, - * ? / L #
7	年	否	empty 或 1970-2099	, - * /

通配符说明:
表示所有值. 例如:在分的字段上设置 ““,表示每一分钟都会触发。
? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10* ?
- 表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
, 表示指定多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
/用于递增触发。如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始，每隔三天触发一次。
L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六，相当于”7”或”SAT”。如果在”L”前加上数字，则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”
W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上设置”15W”，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，”W”前只能设置具体的数字,不允许区间”-“).
小提示 ‘L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发
# 序号(表示每月的第几个周几)，例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了)
小提示 :周字段的设置，若使用英文字母是不区分大小写的 MON 与mon相同.

举例：

1. 1 * * * * ? 每分钟第一秒触发
2. 59 15 13 * * ? 每天13点15分59秒触发
3. 0 15 10 * * ? 2017 2017年每天10点15分触发
4. 0/3 * * * * ? 从0秒开始每隔3秒触发一次
5. 0 10,44 14 ? 3 WED 3月分每周三下午的 2点10分和2点44分触发
6. 0 15 10 ? * MON-FRI 从周一到周五每天上午的10点15分触发
7. 0 15 10 ? * 6L 每月最后一周的星期五的10点15分触发
8. 0 15 10 ? * 6#3 每月的第三周的星期五开始触发