java cron表达式_入门Java开源任务调度框架-Quartz（后篇）

1） 读前须知

本文是《入门Java开源任务调度框架-Quartz（前篇）》的后续文章，是对前篇的补充，请结合前篇阅读！

2）关于JobDataMap数据获取的补充

在前篇中，我们讲述了JobDataMap的数据获取方式，尽管后面通过使用getMergeJobDataMap方法使得数据获取简单了很多，但是我们还有另一种选择，那就是在Job的实现类中定义对应于JobDetail和Trigger中JobDataMap的键名的字段，并且提供对应的setXXX方法。这里为了简化代码我们使用lombok生成get和set方法，先在pom文件中引入lombok（你也可以手动生成方法）：

            org.projectlombok
            lombok
            1.18.12
        

！使用lombok前记得先在Idea中安装lombok插件支持，同时开启到设置中开启lombok注解支持！

然后QuartzJob做如下改变即可，运行结果和之前是一致的。

@Data // 生成get和set方法
@Slf4j // 使用lombok自动获取日志对象log
public class QuartzJob implements Job {
    private String message;
    private Integer number;
    public void execute(JobExecutionContext jobExecutionContext)
            throws JobExecutionException {
        log.info(message);
        log.info(number);
    }
}

3）SimpleTrigger触发器

之前我们简单通过TriggerBuilder创建了一个SimpleTrigger，通过查看TriggerBuilder的代码我们可以知道更多属性设置：

public class TriggerBuilder {
    private TriggerKey key;  // 前面介绍过
    private String description;  // Trigger的描述
    private Date startTime = new Date();  // 任务开始时间，不设置默认立即开始
    private Date endTime; // 结束时间
    private int priority = Trigger.DEFAULT_PRIORITY; // 任务优先级
    private String calendarName;  // 日历名称
    private JobKey jobKey;  // 前面介绍过
    private JobDataMap jobDataMap = new JobDataMap(); // 用于携带数据

    private ScheduleBuilder scheduleBuilder = null; // 调度规则
}

基本上通过名称我们也能知道大概怎么使用，这里就不给出示例了。

下面来看最重要的调度规则的构建器，我们创建SimpleTrigger的时候使用的是SimpleSchedulerBuilder：

public class SimpleScheduleBuilder extends ScheduleBuilder {
    private long interval = 0; // 执行的时间间隔
    private int repeatCount = 0; // 任务执行的次数
    private int misfireInstruction = SimpleTrigger.MISFIRE_INSTRUCTION_SMART_POLICY; // 任务未正常执行时的处理策略
}

SimpleSchedulerBuilder使用静态方法返回实例，相关的设置方法基本都以with、repeat开头，知道了属性的含义之后调用也是很简单了。

最后关于TriggerBuilder和SimpleSchedulerBuilder还有需要注意的地方：

• 重复的次数可以是0到SimpleTrigger.REPEAT_INDEFINITELY
• 重复的执行间隔必须是大于等于0的正整数
• 如果指定了endTime参数，则重复执行的参数会被覆盖。

4）CronTrigger触发器

接下来介绍另一个使用频度很高的触发器CronTrigger，它是基于日历（Calendar）的，不用像SimpleTrigger那样精确指定调度的时间间隔和执行次数，而是通过cron表达式描述运行规则，所以要想使用CronTrigger，我们还得知道cron表达式是什么？怎么表示？。

4.1）什么是corn表达式

cron表达式广泛应用于Linux和Unix系统中，cron表达式被分成了7段，分别对应【秒】【分】【时】【日】【月】【周】【年】，每段用英文半角空格隔开，每段的编写规则如表所示：

下面对表中出现的一些特殊字符进行解释：

（1）：表示匹配该域的任意值。假如在Minutes域使用, 即表示每分钟都会触发事件。

（2）?：只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值，但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度，不管20日到底是星期几，则只能使用如下写法： 13 13 15 20 * ?, 其中最后一位只能用？，而不能使用，如果使用表示不管星期几都会触发，实际上并不是这样。

（3）-：表示范围。例如在Minutes域使用5-20，表示从5分到20分钟每分钟触发一次

（4）/：表示起始时间开始触发，然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次，而25，45等分别触发一次.

（5）,：表示列出枚举值。例如：在Minutes域使用5,20，则意味着在5和20分每分钟触发一次。

（6）L：表示最后，只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。

（7）W:表示有效工作日(周一到周五),只能出现在DayofMonth域，系统将在离指定日期的最近的有效工作日触发事件。例如：在 DayofMonth使用5W，如果5日是星期六，则将在最近的工作日：星期五，即4日触发。如果5日是星期天，则在6日(周一)触发；如果5日在星期一到星期五中的一天，则就在5日触发。另外一点，W的最近寻找不会跨过月份 。

（8）LW:这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。

（9）#:用于确定每个月第几个星期几，只能出现在DayofMonth域。例如在4#2，表示某月的第二个星期三。

确实解释很是繁琐，但如果你想要理解cron表达式那么这是必要的，要想熟练使用还少不了多加练习，当然如果你实在不想手写，直接百度“cron表达式在线生成”能够以更直观、更人性化的方式生成cron表达式。

4.2）使用CronTrigger

在使用CronTrigger之前同样需要准备一个Job任务类：

@Slf4j
public class QuartzJob implements Job {
    public void execute(JobExecutionContext jobExecutionContext)
            throws JobExecutionException {
        log.info("开始执行"); // 这里就不做什么复杂的操作了，重要的是看任务调度的时机
    }
}

为了看到cron表达式的强大之处，我们使用一个稍微复杂点的规则：“每天凌晨1:00到1:59，以及2:00到2:59执行，每隔两秒执行一次”，那么cron表达式应该是这样的：0/2 * 1,2 * * ?，下面我们就将这个表达式应用到项目中。

编写Scheduler任务调度类：

public class QuartzScheduler {
    public static void main(String[] args) throws SchedulerException {
        // 创建一个JobDetail实例
        JobDetail jobDetail = JobBuilder.newJob(QuartzJob.class)
                // 指定JobDetail的名称和组名称
                .withIdentity("job1", "group1").build();

        // 创建一个CronTrigger，规定Job每隔一秒执行一次
        CronTrigger trigger = TriggerBuilder.newTrigger()
                // 指定Trigger名称和组名称
                .startNow().withIdentity("trigger1", "group1")
                // 设置cron运行规则，定义每秒执行一次
                .withSchedule(CronScheduleBuilder.cronSchedule("0/3 * 1-2 * * ?")).build();

        // 得到Scheduler调度器实例
        Scheduler scheduler = new StdSchedulerFactory().getScheduler();
        scheduler.scheduleJob(jobDetail, trigger); // 绑定JobDetail和Trigger
        scheduler.start();                         // 开始任务调度
    }
}

通过结果可以看到，我们使用CronTrigger实现了功能需求：

手动把系统时间改为2:59，Quartz在执行了数十秒后，正好在2:59:58停止了执行：

cron表达式灵活多变，这也造就了它的强大。只需要一段简短的表达式就可以应对各种复杂的场景，这就是cron表达式的魅力所在！

5）再叙Scheduler

Scheduler维护了一个JobDetails 和Triggers的注册表。在Scheduler注册过后，当定时任务触发时间一到，调度程序就会负责执行预先定义的Job。

程序获取Scheduler应该通过工厂的方式，前面我们提到了Scheduler获取实例的两个工厂类：StdSchedulerFactory和DirectSchedulerFactory，而由于StdSchedulerFactory使用的是配置文件的方式配置必要的参数，所以使用较DirectSchedulerFactory硬编码的方式配置参数更为普遍，同时也更推荐使用StdSchedulerFactory。

5.1）Scheduler的主要方法

下面是Scheduler接口中比较重要且常用的几个方法，Scheduler接口中的方法有很多，这里不一一列举，只看几个最重要的：

1. java Date scheduleJob(JobDetail jobDetail, Trigger trigger) throws SchedulerException;

调度任务，并返回开始执行的时间

1. java void start() throws SchedulerException;

调度器实例化后仍处于“待命”状态，需要start方法启动调度器

1. java void standby() throws SchedulerException;

挂起调度器，暂停执行任务，可以恢复

1. java void shutdown(boolean waitForJobsToComplete)

关闭调度器，如果传入的参数为true，等待所有任务完成后再关闭，否则立即关闭

1. java void shutdown() throws SchedulerException;

立即关闭调度器，不等待任务正常完成

1. java boolean isShutdown() throws SchedulerException;
   查看调度器是否关闭了
2. java void resumeAll() throws SchedulerException;
   重新执行挂起的任务

5.2）StdSchedulerFactory的配置文件

StdSchedulerFactory通过名为quartz.properties文件来创建和初始化Quartz调度器Scheduler，此时你也许会问了：“之前我们使用StdSchedulerFactory的时候也没见有配置quartz.properties文件呐，为什么也能正常使用呢？”其实在我们导入的Quartz依赖中自带了一个默认的quartz.properties文件，我们可以到项目的External Libraries找到Quartz相关的jar文件，在org.quartz包下即可看到，打开文件内容如下（注意这里键与值是通过冒号加空格的方式分割的）：

# 调度器的配置
org.quartz.scheduler.instanceName: DefaultQuartzScheduler
org.quartz.scheduler.rmi.export: false
org.quartz.scheduler.rmi.proxy: false
org.quartz.scheduler.wrapJobExecutionInUserTransaction: false

# 线程池的配置
org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount: 10
org.quartz.threadPool.threadPriority: 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true
# misfire阈值设置
org.quartz.jobStore.misfireThreshold: 60000
# 任务存储配置
org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore

以上就是Quartz运行时的必要参数设置，当然Quartz可以配置的属性远不止这些，这里就不展开了。简单说一下两个属性：org.quartz.scheduler.instanceName用来设置调度器的实例名称（任意字符串）；另外还有一个比较重要的属性org.quartz.scheduler.instanceId上面没有设置，它用来设置调度器的实例Id（任意字符串），它是全局唯一的，不能与其他调度器Id重名，如果你不想指定，可以通过设置为AUTO让Quartz自动生成。

这里有必要提一下，在使用StdSchedulerFactory获取Scheduler实例的时候，Quartz会现在工程下查找quartz.properties配置文件，如果没有则使用它默认的，所以如果我们需要自己定义配置参数，可以在工程下（注意是工程下，跟pom文件是同级的）创建一个名为quartz.properties的文件，将上面的内容复制到新文件中，根据需求改动就可以了，更多属性设置请查阅相关资料。

当然如果你想自己指定properties文件的名称和路径就需要使用到StdSchedulerFactory工厂实例的initialize方法了，有三种使用方式：

public class QuartzScheduler {
    public static void main(String [] args)  throws SchedulerException {
        StdSchedulerFactory schedulerFactory = new StdSchedulerFactory();

        // 第一种方式 通过Properties创建，你可以没有properties文件，直接代码设置properties属性
        Properties props = new Properties();
        props.load(new FileInputStream("config.properties"));
        schedulerFactory.initialize(props);

        // 第二种方式 直接通过文件名，properties文件放置在classpath下
        // schedulerFactory.initialize("config.properties");

        // 第三种方式 传入文件流
        // InputStream is = new FileInputStream(new File("config.properties"));
        // schedulerFactory.initialize(is);

        // 获取调度器实例
        Scheduler scheduler = schedulerFactory.getScheduler();
    }
}

5.3）DirectSchedulerFactory获取Scheduler实例

虽然更推荐使用StdSchedulerFactory工厂获取Scheduler实例，但还是要提一下。 DirectSchedulerFactory是一个org.quartz.SchedulerFactory的单例实现，提供了静态方法getInstance来获取工厂实例，之后我们需要通过一堆createXXX方法来设置繁琐的参数从而获取Scheduler实例，有的方法参数多达13个之多：

在调用了createXXX方法设置好参数之后，我们才能调用getScheduler方法获取调度器实例。硬编码的缺点不言而喻，所以这种方式了解即可。