企业任务调度框架Quartz入门

定时任务，无论是互联网行业还是传统软件行业都是不可少的。今天介绍的Quartz就是一款非常优秀的企业任务调度框架。

Quartz简介

Quartz是OpenSymphony开源组织在Job scheduling领域的又一开源项目，它可以和J2EE或J2SE程序结合使用也可以单独使用。小到独立的应用，大到电子商业系统，Quartz都能够创建执行成百上千甚至上万的任务。简而言之就是Quartz是基于Java实现的任务调度框架，可以执行你想执行的任何任务。

Quartz体系结构

Job
Job就是你想要实现的任务类，每一个Job必须实现org.quartz.job接口，且只需实现接口定义的execute方法。

JobDetail
JobDetail为Job实例提供了许多设置属性以及JobDataMap成员变量属性，它用来存储特定Job实例的状态信息。常见属性name、group、jobClass、jobDataMap等

Trigger
触发器，Trigger就是你执行任务的触发器，定时去触发你想要执行的任务。Trigger主要分为SimpleTrigger和CronTrigger两种。

Scheduler
调度器，将任务Job和触发器Trigger整合起来，负责根据Trigger设定的时间执行Job。

Quartz体系结构图

入门例子

需求：每隔5秒钟控制台输出一下当前时间，并传递数据给任务类。

/**
 * 定义要执行的任务类
 *  1.必须实现Job接口
 *  2.实现接口中的execute方法, 在该方法中编写任务执行的业务逻辑
 *  3.每次执行Job时, 都会在调用execute方法前创建一个新的Job实例, 调用完成后, Job实例就会被释放
 */
public class MyJob implements Job {

    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //1.获取当前时间
        LocalTime localTime = LocalTime.now();
        System.out.println("当前时间: "+localTime);
        //2.获取trigger传递的数据
        String name = jobExecutionContext.getTrigger().getJobDataMap().getString("name");
        System.out.println("触发器传递数据："+name);
        //3.获取jobDetail传递的数据
        int count = jobExecutionContext.getJobDetail().getJobDataMap().getInt("count");
        System.out.println("JobDetail传递数据："+count);
    }

}

public static void main(String[] args) throws Exception{
    //1.定义任务调度器Scheduler并启动
    Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
    scheduler.start();

    /**
     * 定义定时任务的实例JobDetail
     *    1.通过JobBuilder创建
     *    2.JobDetail为Job提供了很多设置属性, 用来存储Job实例的状态信息
     */
    JobDetail jobDetail = JobBuilder.newJob(MyJob.class)
                                    //设置任务名称和任务组名
                                    .withIdentity("myjob", "job-group")
                                    //设置JobDataMap, 可以在MyJob任务类中获取到
                                    .usingJobData("count", 10)
                                    .build();

    //3.定义触发器Trigger
    Trigger trigger = TriggerBuilder.newTrigger()
                                     //设置触发器名称和触发器组名
                                    .withIdentity("trigger", "trigger-group")
                                    //设置JobDataMap, 可以在MyJob任务类中获取到
                                    .usingJobData("name", "zhangsan")
                                     //每5秒触发一次
                                    .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5).repeatForever())
                                    .build();

    //4.通过调度器关联任务和触发器
    scheduler.scheduleJob(jobDetail, trigger);
}

输出：
当前时间: 16:56:27.579
触发器传递数据：zhangsan
JobDetail传递数据：10
当前时间: 16:56:32.509
触发器传递数据：zhangsan
JobDetail传递数据：10
....

Job

定时任务并发执行问题

在任务类上加@DisallowConcurrentExecution即可解决并发问题

@DisallowConcurrentExecution
public class MyJob implements Job {
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
    }
}

Job状态

Job分为有状态的Job和无状态的Job
有状态的Job：多次Job调用期间可以持有一些状态信息，这些信息存储在JobDataMap中
无状态的Job：每次调用都会创建一个新的JobDataMap

# 没有添加该注解，每次调用创建一个新的JobDataMap，不会累加
# 添加该注解，多次Job调用可以持有一些状态信息
@PersistJobDataAfterExecution
public class HelloJob implements Job {
}

Trigger

Simple触发器

简单的触发器，适合于按照时间间隔重复执行一项定时任务。

常用属性：开始时间、结束时间、重复次数和重复间隔
重复次数：0、正整数、无限次执行
重复间隔：0(并发执行)、long类型(毫秒级)

Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("trigger-name", "trigger-group")
                    .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                                    .withIntervalInSeconds(5) //时间间隔：5秒
                                    .withRepeatCount(100)     //重复执行100次
                    )
                    .startAt(DateBuilder.futureDate(10, DateBuilder.IntervalUnit.SECOND)) //10秒后开始执行
                    .endAt(DateBuilder.futureDate(50, DateBuilder.IntervalUnit.SECOND))   //50秒后结束
                    .build();

Cron触发器

按日历方式触发任务。

Cron表达式：由7个字表达式组成的字符串，每个表达式都描述了一个单独的日程细节，表达式使用空格分割
1.秒
2.分
3.小时
4.天(月)
5.月
6.天(周)
7.年

字段	必须	值	特殊符号
秒	是	0-59	, - * /
分	是	0-59	, - * /
时	是	0-23	, - * /
天(月)	是	1-31	, - * / ? L W C
月	是	1-12 或 JAN-DEC	, - * /
周	是	1-7 或 SUN-SAT	, - * / ? L C #
年	否	不填写 或 1970-2099	, - * /

特殊符号	含义
*	用来表示域中每个可能的值
?	不指定值，忽略这个值
-	表示区间，比如3-5，就表示3,4,5
,	指定多个值， 比如3,4,5
/	表示值的增量，例如分钟域上0/2表示每个2分钟从0开始
L	last的简写，day of month中表示这个月的最后一天，day of week表示7(周六)，在day of week域中6L表示最后一周的周5
W	用来指定距离给定日最近的周几(在day of week域中指定)，例如day of month域中指定12W表示距离12号最近的周几
#	表示月中第几个周几，day of week中6#3表示月中第三个周五

示例
0 0 2,4,20 * * ? 每天上午2点4点, 下午20点执行
0 0/30 9-20 * * ? 每天早上9点到20点每隔半个小时执行一次
0 0 12 ？ * WED 每个周三中午12点
0 0 12 * * ？ 每天中午12点触发
0 * 14 * * ？ 每天下午14点到14点59每隔一分钟执行一次

Trigger trigger = TriggerBuilder.newTrigger()
        .withIdentity("trigger1", "group1") //触发器名称，触发器组名称
        //每5秒执行一次
        .withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?"))
        .build();

Trigger的优先级问题

Trigger默认优先级为5，只有在多个Trigger同时执行，并且线程数小于Trigger数量时才会有用。

    Trigger trigger = TriggerBuilder.newTrigger()
                                    .withIdentity("trigger", "trigger-group")
                                    .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5).repeatForever())
                                    .withPriority(6) //设置Trigger的优先级为6
                                    .build();

Scheduler调度器

StdSchedulerFactory

默认创建Scheduler的方式，使用一组参数(java.util.Properties)来创建和初始化Quartz调度器。
配置参数我们可以存储在quartz.properties
调用getScheduler方法就能创建和初始化调度器对象

# 方式1
SchedulerFactory schedulerFactory = new StdSchedulerFactory();
Scheduler scheduler = schedulerFactory.getScheduler();

# 方式2
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();

Scheduler

调度器，将任务Job和触发器Trigger整合起来，负责根据Trigger设定的时间执行Job。

//将任务Job和触发器Trigger整合起来， 并返回调度器开始时间
Date date = scheduler.scheduleJob(jobDetail, trigger);
//开启任务调度
scheduler.start();
//挂起，即暂停操作
scheduler.standby();
//等所以正在执行的任务执行完毕，再关闭
scheduler.shutdown(true); 
//直接关闭
scheduler.shutdown(false);