Quartz2.x学习笔记（一）

java有个Timer类可以实现定时任务，但相比开源框架Quartz，还是有所不足。

这里简单讲讲Quartz的使用。

我的测试环境是jdk8 Quartz版本是2.2.1.

(参考博文：http://www.blogjava.net/baoyaer/articles/155645.html  对很多概念讲的比较清楚 只不过使用的是1.8版本的 我参考后做了quartz2.2.1版本的demo总结如下)

Quartz简介

Quartz 项目 是由 James House 创立的，它在1998年就有该框架最初的构思。包括作业队列的概念，使用线程池来处理作业，也许它最早的模型已不为现今的Quartz使用者所知了。

Quartz下载地址

http://www.quartz-scheduler.org/downloads/

maven使用的全部依赖：

<dependencies>
     <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>
    <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
     </dependency>
    <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.21</version>
     </dependency>
  </dependencies>

入门例子：

普通的java类继承了org.quartz.job就成了一个job。org.quartz.job里只有一个方法：

public void execute(JobExecutionContext context) throws JobExecutionException;

继承了job的类必须实现这个方法。

package com.Howard.test06;

import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class HelloJob implements Job{

     //Job接口里唯一方法
     @Override
     public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {

          System.out.println(jobExecutionContext.getJobDetail().getKey()+" "+new Date());
     }

}

测试类：

package com.Howard.test06;

import java.awt.image.DataBufferInt;
import java.util.Date;

import org.quartz.DateBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerFactory;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
/**
 * 测试作业调度
 * @author Howard
 * 2017年2月21日
 */
public class JobRunnerExample {

    public void run() throws Exception{
        //通过SchedulerFactory工厂类获取Scheduler
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

//        Date runTime = DateBuilder.evenMinuteDate(new Date());
        //JobDetail：用于描叙Job实现类及其他的一些静态信息，构建一个作业实例
        //quartz2.x是用JobBuilder静态方法来new出jobdetail实例的
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class)
                           .withIdentity("job1", "group1") //设定名称和组 可后期用于根据名称或组获取信息等
                           .build();

        //Trigger：描述作业出发的规则等
        //quartz2.x是用TriggerBuilder静态方法来new出trigger实例的
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger1", "group1") //同一个scheduler里的trigger或jobDetail不能有相同的名（jobDetail和trigger可以相同 ）
                .build();

        //向scheduler添加jobDetail和trigger
        scheduler.scheduleJob(jobDetail, trigger);
        //启动
        scheduler.start();
        //主线程睡眠 作业调度是另起一个线程的 主线程睡眠不影响执行 但主线程停止就会影响
        Thread.sleep(65L * 1000L);

        //停止作业调度 默认作业调度一直运行下去的
        scheduler.shutdown(true);
    }

    public static void main(String[] args) throws Exception {
        JobRunnerExample example1 = new JobRunnerExample();
        example1.run();
    }
}

运行结果：

红色部分由于我没加log4j配置文件原因。

使用SimpleTrigger：

SimpleTrigger类通过简单的设定方式使我们可以控制作业调度的时间，简单但是设定时间的方式有限。

package com.Howard.test06;

import java.awt.image.DataBufferInt;
import java.util.Date;

import org.quartz.DateBuilder;
import org.quartz.DateBuilder.IntervalUnit;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
/**
 * 基于Quartz2.2.1的
 * SimpleTrigger简单使用
 * @author Howard
 * 2017年2月21日
 */
public class SimpleTriggerExample {


    public void RunJob1()throws Exception{
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        //job1：只执行一次

        //开始时间   第一个参数为在某个时间之后 第二个为多久后
        //nextGivenSecondDate（Date date, int secondBase)：在date之后的xx秒启动
        //nextGivenMinteDate（Date date, int secondBase)：在date之后的xx分启动
        Date startTime = DateBuilder.nextGivenSecondDate(null, 15);

        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();

        SimpleTrigger trigger = (SimpleTrigger) TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").startAt(startTime).build();

        Date time = scheduler.scheduleJob(jobDetail, trigger);

        System.out.println(jobDetail.getKey() + " 启动时间： " +time + " 重复次数： " + trigger.getRepeatCount()+ "执行间隔： "
                 + trigger.getRepeatInterval() / 1000 + " seconds");

        //默认启动job之后就不会关闭调度了。即使是只执行一次 如果需要 可以下面sleep线程一段时间（等待job执行完成后）手动关闭
//        Thread.sleep(65L * 1000L);
//        scheduler.shutdown(true);
    }

    public void RunJob2()throws Exception{
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        //job2 执行10次 间隔5秒  5秒后开始
//        Logger log = LoggerFactory.getLogger(HelloJob.class);
//        开始时间   第一个参数为在某个时间之后 第二个为多久后
//        nextGivenSecondDate（Date date, int secondBase)：在date之后的xx秒启动
//        nextGivenMinteDate（Date date, int secondBase)：在date之后的xx分启动
        Date startTime = DateBuilder.nextGivenSecondDate(null, 15);

        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();

        SimpleTrigger trigger = (SimpleTrigger) TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").
                        startAt(startTime)
                        .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                                     .withIntervalInSeconds(5)
                                      .withRepeatCount(10))
                        .build();

        Date time = scheduler.scheduleJob(jobDetail, trigger);

        System.out.println(jobDetail.getKey() + " 启动时间： " +time + " 重复次数： " + trigger.getRepeatCount()+ "执行间隔： "
                 + trigger.getRepeatInterval() / 1000 + " seconds");
    }

    public void RunJob3()throws Exception{
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        //job3：执行10次 间隔5秒 5秒后开始
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job3", "group1").build();

        SimpleTrigger trigger = (SimpleTrigger) TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
                        .startAt(DateBuilder.futureDate(5, IntervalUnit.SECOND)) //5秒后开始job
                        .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                                     .withIntervalInSeconds(5)
                                      .withRepeatCount(10))
                        .build();

        Date time = scheduler.scheduleJob(jobDetail, trigger);

        System.out.println(jobDetail.getKey() + " 启动时间： " +time + " 重复次数： " + trigger.getRepeatCount()+ "执行间隔： "
                 + trigger.getRepeatInterval() / 1000 + " seconds");
        scheduler.start();
    }

    public void RunJob4()throws Exception{
        SchedulerFactory factory = new StdSchedulerFactory();
        Scheduler scheduler = factory.getScheduler();

        //job4：执行无数次  间隔2秒 5秒后开始
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job3", "group1").build();

        SimpleTrigger trigger = (SimpleTrigger) TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
                        .startAt(DateBuilder.futureDate(5, IntervalUnit.SECOND)) //5秒后开始job
                        .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                                     .withIntervalInSeconds(2)
                                      .repeatForever())  //永久执行
                        .build();

        Date time = scheduler.scheduleJob(jobDetail, trigger);

        System.out.println(jobDetail.getKey() + " 启动时间： " +time + " 重复次数： " + trigger.getRepeatCount()+ "执行间隔： "
                 + trigger.getRepeatInterval() / 1000 + " seconds");
        scheduler.start();
    }

    public void run() throws Exception{


    }

    public static void main(String[] args) throws Exception {
        SimpleTriggerExample example1 = new SimpleTriggerExample();
//        example1.RunJob1();
//        example1.RunJob2();
//        example1.RunJob3();
//        example1.RunJob4();
    }
}

使用CronTrigger

CronTrigger 能够提供比 SimpleTrigger 更有具体实际意义的调度方案，调度规则基于 Cron 表达式，CronTrigger 支持日历相关的重复时间间隔（比如每月第一个周一执行），而不是简单的周期时间间隔。因此，相对于SimpleTrigger而言，CronTrigger在使用上也要复杂一些。

Cron表达式
Cron表达式时间字段

位置	时间域名	允许值	允许的特殊字符
1	秒	0-59	, - * /
2	分钟	0-59	, - * /
3	小时	0-23	, - * /
4	日期	1-31	, - * ? / L W C
5	月份	1-12	, - * /
6	星期	1-7	, - * ? / L C #
7	年(可选)	空值1970-2099	, - * /

Cron表达式的时间字段除允许设置数值外，还可使用一些特殊的字符，提供列表、范围、通配符等功能，细说如下：

●星号(*)：可用在所有字段中，表示对应时间域的每一个时刻，例如，*在分钟字段时，表示“每分钟”；

●问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于点位符；

●减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即10,11,12；

●逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五；

●斜杠(/)：x/y表达一个等步长序列，x为起始值，y为增量步长值。如在分钟字段中使用0/15，则表示为0,15,30和45秒，而5/15在分钟字段中表示5,20,35,50，你也可以使用*/y，它等同于0/y；

●L：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L在日期字段中，表示这个月份的最后一天，如一月的31号，非闰年二月的28号；如果L用在星期中，则表示星期六，等同于7。但是，如果L出现在星期字段里，而且在前面有一个数值X，则表示“这个月的最后X天”，例如，6L表示该月的最后星期五；

●W：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日，如果该月15号是星期六，则匹配14号星期五；如果15日是星期日，则匹配16号星期一；如果15号是星期二，那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月，如你指定1W，如果1号是星期六，结果匹配的是3号星期一，而非上个月最后的那天。W字符串只能指定单一日期，而不能指定日期范围；

●LW组合：在日期字段可以组合使用LW，它的意思是当月的最后一个工作日；

●井号(#)：该字符只能在星期字段中使用，表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五，#3表示当前的第三个)，而4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；

● C：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。

Cron表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。

表2下面给出一些完整的Cron表示式的实例：

 Cron表示式示例

表示式	说明
"0 0 12 * * ? "	每天12点运行
"0 15 10 ? * *"	每天10:15运行
"0 15 10 * * ?"	每天10:15运行
"0 15 10 * * ? *"	每天10:15运行
"0 15 10 * * ? 2008"	在2008年的每天10：15运行
"0 * 14 * * ?"	每天14点到15点之间每分钟运行一次，开始于14:00，结束于14:59。
"0 0/5 14 * * ?"	每天14点到15点每5分钟运行一次，开始于14:00，结束于14:55。
"0 0/5 14,18 * * ?"	每天14点到15点每5分钟运行一次，此外每天18点到19点每5钟也运行一次。
"0 0-5 14 * * ?"	每天14:00点到14:05，每分钟运行一次。
"0 10,44 14 ? 3 WED"	3月每周三的14:10分到14:44，每分钟运行一次。
"0 15 10 ? * MON-FRI"	每周一，二，三，四，五的10:15分运行。
"0 15 10 15 * ?"	每月15日10:15分运行。
"0 15 10 L * ?"	每月最后一天10:15分运行。
"0 15 10 ? * 6L"	每月最后一个星期五10:15分运行。
"0 15 10 ? * 6L 2007-2009"	在2007,2008,2009年每个月的最后一个星期五的10:15分运行。
"0 15 10 ? * 6#3"	每月第三个星期五的10:15分运行。

代码示例：

package com.Howard.test06;

import java.util.Date;

import org.quartz.CronScheduleBuilder;
import org.quartz.CronTrigger;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.SchedulerMetaData;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
/**
 * 基于Quartz2.2.1的
 * CronTrigger 的简单使用
 * @author Howard
 * 2017年2月
 */
public class CronTriggerExample {

     public void runJob1() throws SchedulerException, InterruptedException{
           //job1:使用cron表达式设定时间 每3秒执行一次
//         Logger log = LoggerFactory.getLogger(CronTriggerExample.class);

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

         JobDetail job = JobBuilder.newJob(HelloJob.class)
                .withIdentity("job_1", "group_1")
                .build();

         CronTrigger trigger = TriggerBuilder.newTrigger()
         .withIdentity("trigger_1", "group_1")
         .withSchedule(CronScheduleBuilder.cronSchedule("0/3 * * * * ?"))
         .build();

         Date time = scheduler.scheduleJob(job, trigger);

         System.out.println(job.getKey() + " 启动时间： " +time +  "使用的Cron表达式： "
                  + trigger.getCronExpression() + " seconds");
//       log.info(job.getKey() + " 启动时间： " +time +  "使用的Cron表达式： "
//                + trigger.getCronExpression() + " seconds");


         scheduler.start();
         //job调度是另起一个线程的 主线程睡眠并不影响 但主线程结束支线程也会结束
         Thread.sleep(10000);
         scheduler.shutdown(true);

         SchedulerMetaData metaData = scheduler.getMetaData();
         System.out.println("执行了： " + metaData.getNumberOfJobsExecuted() + " jobs.");
     }

     public static void main(String[] args) throws SchedulerException, InterruptedException {

           CronTriggerExample example = new CronTriggerExample();
           example.runJob1();
     }
}

package com.Howard.test06;

import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class HelloJob implements Job{

     //Job接口里唯一方法
     @Override
     public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {

          System.out.println(jobExecutionContext.getJobDetail().getKey()+" "+new Date());
     }

}

运行结果：

每隔3秒执行一次job，由于主线程睡眠10秒后就让作业调度停止了，所以总共作了4次job

使用Calendar

有时候我们想要按照自己的安排排除一些时间或时间段 比如节日等 这时候就需要使用Calendar了（这个貌似跟旧版本没多大不同）

/**
      * 排除指定的日期
      * @throws SchedulerException
      * @throws InterruptedException
      */
     public void runJob2() throws SchedulerException, InterruptedException{
           //job2:使用cron表达式设定时间 每3秒执行一次 排除指定的日期
//         Logger log = LoggerFactory.getLogger(CronTriggerExample.class);

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

         //每年执行的日历 相应的还有MonthlyCalendar等
         AnnualCalendar holidays = new AnnualCalendar();
         //劳动节
         Calendar laborDay = new GregorianCalendar();
         laborDay.add(Calendar.MONTH,5);//java.util.Calendar;
         laborDay.add(Calendar.DATE,1);

         holidays.setDayExcluded(laborDay, true); //排除的日期，如果设置为false则为包含

//       Calendar nationalDay = new GregorianCalendar();
//
//       nationalDay.add(Calendar.MONTH,10);
//       nationalDay.add(Calendar.DATE,1);
//       holidays.setDayExcluded(nationalDay, true);

         scheduler.addCalendar("holidays", holidays, false, false);

         JobDetail job = JobBuilder.newJob(HelloJob.class)
                .withIdentity("job_1", "group_1")
                .build();

         CronTrigger trigger = TriggerBuilder.newTrigger()
         .withIdentity("trigger_1", "group_1")
         .withSchedule(CronScheduleBuilder.cronSchedule("0/3 * * * * ?"))
         .modifiedByCalendar("holidays")//告诉trigger按这个日历规则执行
         .build();

         Date time = scheduler.scheduleJob(job, trigger);

         System.out.println(job.getKey() + " 启动时间： " +time +  "使用的Cron表达式： "
                  + trigger.getCronExpression() + " seconds");

         scheduler.start();
         //job调度是另起一个线程的 主线程睡眠并不影响 但主线程结束支线程也会结束
         Thread.sleep(10000);
         scheduler.shutdown(true);

         SchedulerMetaData metaData = scheduler.getMetaData();
         System.out.println("执行了： " + metaData.getNumberOfJobsExecuted() + " jobs.");
     }