Quartz简单使用

最近看Quartz相关资料，借此博客记录自己的见解。

一、什么是Quartz

Quartz是一个开源的作业调度框架（定时触发相关相关事件），是由java语言编写。

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

源码地址：https://github.com/quartz-scheduler/quartz

二、Quartz中的设计模式

1、建造者模式：所有关键组件都有Builder模式来构建 如:JobBuilder、TriggerBuilder

2、工厂模式：最终由Scheduler的来进行组合各种组件 如SchedulerFactory

三、Quartz相关概念

1、

• Scheduler，任务调度的API；它可以用来启动或者终止任务等。
• Job，具体的任务接口；通过实现它，来让任务调度执行具体的任务。
• JobDetail ，用来定义Job的实例。
• Trigger ，触发器用来定义给定的Job应该如何执行。
• JobBuilder ，用来定义/构建Jobdetail实例。
• TriggerBuilder ，用来定义/构建Trigger实例。

2、Jobs、JobDetail、JobDataMap关系

简而言之，Job是对任务的一个具体实现；谁执行了这个任务呢？这就需要JobDetail来实现，所以JobDetail就是Job的一个具体实例；如9点上语文课是一个具体任务，而刘老师在9点上语文课就是这个任务的一个具体实例。 
Scheduler执行Job时，在调用execute()方法前会先实例化Job；一旦执行结束，该实例就会被丢弃，然后被垃圾回收。 
需要注意的是Job必须有一个无参的构造器；另外在Job类中定义数据属性是没有意义的，因为这些属性值并不会在执行期间保存。

JobDataMap

上面说到Job中无法定义属性来传递数据，那么如果我们需要传递数据该怎么做？就是使用JobDataMap，它是JobDetail的一个属性。JobDataMap是Map接口的一个实现，并且它有一些便利的方法来储存和检索基本类型数据。 

如果在Job类中定义与JobDataMap中键值一致的set和get方法，那么Quartz会自动将这些属性注入。如：

public class HelloJob implements Job{

    private String name;

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        //JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
        //String name = jobDataMap.getString("name");
        System.out.println("hello "+name+", "+ DateFormatUtils.format(new Date(), "yyyy-MM-dd HH:mm:ss"));
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

另外Trigger中也可以设置JobDataMap属性，这是为了在多个Trigger中使用相同的Job。JobExecutionContext 将会合并JobDetail与Trigger的JobDataMap，如果其中属性名相同，后者将覆盖前者。可以使用JobExecutionContext.getMergedJobDataMap()方法来获取合并后的JobDataMap。

Job的状态与并发

@DisallowConcurrentExecution，如果使用该注解，那么同一时间将只有一个Job实例被执行。如，ReportJob有个实例为ReportForJoe，那么同一时间只有一个ReportForJoe被执行。而ReportForMike等都可以执行。 
@PersistJobDataAfterExecution，如果使用该注解，在Job被执行结束后，将会更新JobDataMap，这样下次Job执行后就会使用新的值而不是初始值。否则会一直保留初始化的数据
如果使用@PersistJobDataAfterExecution注解，推荐也使用@DisallowConcurrentExecution注解，这是为了避免并发问题导致数据紊乱。

其它属性

• Durability，持久性；如果Job是非持久性的，一旦没有Trigger与其相关联，它就会从Scheduler中被删除。也就是说Job的生命周期和其Trigger是关联的。
• RequestsRecovery，如果为true，那么在Scheduler异常中止或者系统异常关闭后，当Scheduler重启后，Job会被重新执行。

JobExecutionException

execute()方法只允许抛出JobExecutionException异常

四、Cron表达式

 Cron表达式用于配置CronTrigger实例。Cron表达式实际上是由7个子表达式组成的字符串，描述了时间表的详细信息。这些子表达式用空格隔开，分别代表：

1、秒

2、分

3、小时

4、月份中的天数

5、月

6、星期中的天数

7、年（可选）

 一个完整的 Cron 表达式的字符串例子“ 0 0 12 ? * WED ”，意思是“每周三的上午 12:00:00 ”。

通配符（*）用来表示任何的值。 因此“*”在上面的例子中的月份字段表示“每个月”，“*”在星期中的天数字段由此明显是表示“一周的任何一天”

“/”字符用来表示增量。例如，如果你在分钟字段写“0/15”，这表示“每次从一小时中的第0分钟开始，每隔15分钟触发”，如果你在分钟字段上写“3/20”，这表示“每次从一小时中的第3分钟开始，每隔20分钟触发”。换句话说就是/左边表示起始时间，右边表示增量

“?”字符允许出现在月份中的天数和星期中的天数字段中。它一般用来指定“不关心的值”。当你需要在这两个字段中的一个指定不确定的值是非常方便的，这个字符不能用在其他的字段中

“L”字符允许出现在月份中的天数和星期中的天数字段中。这个字符是“last”的缩写，但是在这两个字段中有不同的含义。例如，“L”字符出现在月份中的天数字段中表示“每月的最后一天”——1月31日，平年的2月28日。如果该字符单独用在星期中的天数字段时，仅仅是表示“7”或是“SAT”。但是在星期中的天数字段中该字符用在其他值的后面，表示“每月的最后一个星期几”——例如“6L”或是“FRIL”都表示“每月的最后一个星期五”。你也可以指定每月最后一天的偏移数，例如“L－3”表示日历月份的最后三天。当你使用“L”字符时，最好不要使用排列值或是带范围的值，否则你会对结果感到意外和难以理解。

“w”字符用来指定给定日期的最近一个工作日（工作日指的是从周一到周五）。例如，如果你在月份中的天数字段的值指定为“15w”，这表示“离每月15号最近的工作日”。

“#”字符用来指定每月的第N个工作日，例如，星期中的天数字段的值为“6#3”或是“FRI#3”表示“每月的第三个星期五”。

简单调用：

@Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
        String name = jobDataMap.getString("name");
        System.out.println("hello "+name+", "+ DateFormatUtils.format(new Date(), "yyyy-MM-dd HH:mm:ss"));
    }