第018课：Spring Boot 集成 Quartz

在项目开发中，经常需要定时任务帮助我们来做一些内容，如定时派息、跑批对账、业务监控等。Spring Boot 体系中现在有两种方案可以让我们选择，第一种是 Spring Boot 内置的方式简单注解就可以使用，当然如果需要更复杂的应用场景还是得 Quartz 上场，Quartz 目前是 Java 体系中最完善的定时方案。

1. Spring Boot 内置定时

1.1 POM包配置

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

1.2 启动类开启定时

在启动类上面加上@EnableScheduling即可开启定时：

@SpringBootApplication
@EnableScheduling
public class SpringbootQuartzApplication {

    public static void main(String[] args) {
        SpringApplication.run( SpringbootQuartzApplication.class, args );
    }

}

1.3 创建定时任务实现类

使用 Spring Boot 自带的定时非常的简单，只需要在方法上面添加 @Scheduled 注解即可。

/**
 * <h3>springboot-study</h3>
 * <p>SpringBoot内置的定时任务</p>
 * @author : zhang.bw
 * @date : 2020-08-11 15:53
 **/
@Component
public class SchedulerTask {

    private int count = 0;
    private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");

    /**
     * 方式一：设置每6秒执行一次
     */
    @Scheduled(cron = "*/6 * * * * ?")
    private void process1(){
        //TODO 具体业务逻辑
        System.out.println("公众号【猿码天地】测试-SpringBoot内置的定时-调度-方式一 task running " + (count++));
    }

    /**
     * 方式二：设置每6秒执行一次
     */
    @Scheduled(fixedRate = 6000)
    private void process2(){
        //TODO 具体业务逻辑
        System.out.println("公众号【猿码天地】测试-SpringBoot内置的定时-调度-方式二 now time is " + dateFormat.format(new Date()));
    }

}

方式一：设置 process() 每隔六秒执行一次，并统计执行的次数。(@Scheduled(cron = "*/6 * * * * ?"))

方式二：我们还有另外的一种方案来设置，固定时间周期执行方法。(@Scheduled(fixedRate = 6000))

启动项目之后，就会在控制台看到打印的结果，结果如下：可以看出，两种方式调度均执行成功。

1.4 关键说明

参数说明

@Scheduled 参数可以接受两种定时的设置，一种是常用的cron="*/6 * * * * ?"，一种是 fixedRate = 6000，两种都可表示固定周期执行定时任务。

fixedRate 说明

@Scheduled(fixedRate = 6000) ：上一次开始执行时间点之后 6 秒再执行。
@Scheduled(fixedDelay = 6000) ：上一次执行完毕时间点之后 6 秒再执行。
@Scheduled(initialDelay=1000, fixedRate=6000) ：第一次延迟 1 秒后执行，之后按 fixedRate 的规则每 6 秒执行一次。

cron 说明

cron 一共有 7 位，最后一位是年，Spring Boot 定时方案中只需要设置 6 位即可：

第一位，表示秒，取值 0-59；
第二位，表示分，取值 0-59；
第三位，表示小时，取值 0-23；
第四位，日期天/日，取值 1-31；
第五位，日期月份，取值 1-12；
第六位，星期，取值 1-7，星期一、星期二…；
注：不是第1周、第2周的意思，另外：1表示星期天，2表示星期一。
第七位，年份，可以留空，取值 1970-2099。

cron 中，还有一些特殊的符号，含义如下：

（*）星号：可以理解为每的意思，每秒、每分、每天、每月、每年……。
（?）问号：问号只能出现在日期和星期这两个位置，表示这个位置的值不确定，每天 3 点执行，所以第六位星期的位置是不需要关注的，就是不确定的值。同时，日期和星期是两个相互排斥的元素，通过问号来表明不指定值。假如 1 月 10 日是星期一，如果在星期的位置是另指定星期二，就前后冲突矛盾了。
（-）减号：表达一个范围，如在小时字段中使用“10-12”，则表示从 10~12 点，即 10、11、12。
（,）逗号：表达一个列表值，如在星期字段中使用“1、2、4”，则表示星期一、星期二、星期四。
（/）斜杠：如 x/y，x 是开始值，y 是步长，比如在第一位（秒） 0/15 就是，从 0 秒开始，每 15 秒，最后就是 0、15、30、45、60，另 */y，等同于 0/y。

下面列举几个常用的例子

0 0 3 * * ? 每天 3 点执行。
0 5 3 * * ? 每天 3 点 5 分执行。
0 5 3 ? * * 每天 3 点 5 分执行，与上面作用相同。
0 5/10 3 * * ? 每天 3 点的 5 分、15 分、25 分、35 分、45 分、55 分这几个时间点执行。
0 10 3 ? * 1 每周星期天，3点10分执行，注：1 表示星期天。
0 10 3 ? * 1#3 每个月的第三个星期，星期天执行，# 号只能出现在星期的位置。

以上就是 Spring Boot 自定的定时方案，使用起来非常的简单方便。

2. Spring Boot 集成Quartz

2.1 Quartz 介绍

Quartz 是 OpenSymphony 开源组织在 Job scheduling 领域又一个开源项目，是完全由 Java 开发的一个开源的任务日程管理系统，“任务进度管理器”就是一个在预先确定（被纳入日程）的时间到达时，负责执行（或者通知）其他软件组件的系统。Quartz 是一个开源的作业调度框架，它完全由 Java 写成，并设计用于 J2SE 和 J2EE 应用中，它提供了巨大的灵活性而不牺牲简单性。

当定时任务愈加复杂时，使用 Spring 注解 @Schedule 已经不能满足业务需要。

2.2 Quartz 的优点

丰富的 Job 操作 API；
支持多种配置；
Spring Boot 无缝集成；
支持持久化；
支持集群；
Quartz 还支持开源，是一个功能丰富的开源作业调度库，可以集成到几乎任何 Java 应用程序中。

2.3 Quartz 体系结构

若要明白 Quartz 怎么用首先要了解 Job（任务）、JobDetail（任务信息）、Trigger（触发器）和Scheduler（调度器）这4个核心的概念。

Job：是一个接口，只定义一个方法 execute(JobExecutionContext context)，在实现接口的 execute 方法中编写所需要定时执行的 Job（任务），JobExecutionContext 类提供了调度应用的一些信息。Job 运行时的信息保存在 JobDataMap 实例中。
JobDetail：Quartz 每次调度 Job 时，都重新创建一个 Job 实例，所以它不直接接受一个 Job 的实例，相反它接收一个 Job 实现类（JobDetail，描述 Job 的实现类及其他相关的静态信息，如 Job 名字、描述、关联监听器等信息），以便运行时通过 newInstance() 的反射机制实例化 Job。
Trigger：是一个类，描述触发 Job 执行的时间触发规则。主要有 SimpleTrigger 和 CronTrigger 这两个子类。当且仅当需调度一次或者以固定时间间隔周期执行调度，SimpleTrigger 是最适合的选择；而 CronTrigger 则可以通过 Cron 表达式定义出各种复杂时间规则的调度方案，如工作日周一到周五的 15：00~16：00 执行调度等。
Scheduler：调度器就相当于一个容器，装载着任务和触发器。该类是一个接口，代表一个 Quartz 的独立运行容器，Trigger 和 JobDetail 可以注册到 Scheduler 中，两者在 Scheduler 中拥有各自的组及名称，组及名称是 Scheduler 查找定位容器中某一对象的依据，Trigger 的组及名称必须唯一， JobDetail 的组和名称也必须唯一（但可以和 Trigger 的组和名称相同，因为它们是不同类型的）。Scheduler 定义了多个接口方法，允许外部通过组及名称访问和控制容器中 Trigger 和 JobDetail。

四者其关系如下图所示：

Job 为作业的接口，为任务调度的对象；JobDetail 用来描述 Job 的实现类及其他相关的静态信息；Trigger 做为作业的定时管理工具，一个 Trigger 只能对应一个作业实例，而一个作业实例可对应多个触发器；Scheduler 做为定时任务容器，是 quartz 最上层的东西，它提携了所有触发器和作业，使它们协调工作，每个 Scheduler 都存有 JobDetail 和 Trigger 的注册，一个 Scheduler 中可以注册多个 JobDetail 和多个 Trigger。

2.4 整合

引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

2.4.1 SimpleScheduler方式

定义一个job

/**
 * <h3>springboot-study</h3>
 * <p>定义一个job 定时输出HelloWorld(使用Scheduler 启动)</p>
 * @author : zhang.bw
 * @date : 2020-08-11 16:33
 **/
public class SampleJob extends QuartzJobBean {

    private String name;

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

    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //TODO 具体业务逻辑
        System.out.println("公众号【猿码天地】测试-SpringBoot集成Quartz-Schedule方式 ---->  Hello, " + this.name);
    }
}

构建 JobDetail

/**
 * <h3>springboot-study</h3>
 * <p>构建 JobDetail</p>
 * @author : zhang.bw
 * @date : 2020-08-11 16:34
 **/
@Configuration
public class SampleScheduler {

    @Bean
    public JobDetail sampleJobDetail() {
        // 链式编程,可以携带多个参数,在Job类中声明属性 + setter方法
        return JobBuilder.newJob( SampleJob.class).withIdentity("sampleJob")
                .usingJobData("name","World").storeDurably().build();
    }

    @Bean
    public Trigger sampleJobTrigger(){
        // 每隔3秒执行一次
        SimpleScheduleBuilder scheduleBuilder =
                SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(3).repeatForever();
        return TriggerBuilder.newTrigger().forJob(sampleJobDetail()).withIdentity("sampleTrigger")
                .withSchedule(scheduleBuilder).build();
    }

}

JobBuilder 无构造函数，只能通过 JobBuilder 的静态方法 newJob(Class jobClass)生成 JobBuilder 实例。
withIdentity 方法可以传入两个参数 withIdentity(String name,String group) 来定义 TriggerKey，也可以不设置，像上文示例中会自动生成一个独一无二的 TriggerKey 用来区分不同的 Trigger。

启动项目之后，就会在控制台看到打印的结果，结果如下：

2.4.2 CronSchedule方式

CronSchedule可以设置更灵活的方式,定时设置与SpringBoot自带的表达式相同。

同理,先定义两个个Job,与ScheduledJob相同,不过实现Job接口,如下:

定义job1

/**
 * <h3>springboot-study</h3>
 * <p>定义 job1 </p>
 * @author : zhang.bw
 * @date : 2020-08-11 16:35
 **/
public class ScheduledJob1 implements Job {

    private String name;

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

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {

        SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
        //TODO 具体业务逻辑
        System.out.println("CRON ----> schedule job1 is running ... + " + name + "  ---->  " + dateFormat.format(new Date()));
    }
}

定义job2

/**
 * <h3>springboot-study</h3>
 * <p>定义 job2 </p>
 * @author : zhang.bw
 * @date : 2020-08-11 16:36
 **/
public class ScheduledJob2 implements Job {

    private String name;

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

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {

        SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
        //TODO 具体业务逻辑
        System.out.println("CRON ----> schedule job2 is running ... + " + name + "  ---->  " + dateFormat.format(new Date()));

    }
}

构建Schedule来执行任务:

/**
 * <h3>springboot-study</h3>
 * <p>CronSchedulerJob</p>
 * @author : zhang.bw
 * @date : 2020-08-11 16:37
 **/

@Component
public class CronSchedulerJob {

    @Autowired
    private SchedulerFactoryBean schedulerFactoryBean;

    /**
     * 调度1
     * @param scheduler
     * @throws SchedulerException
     */
    private void scheduleJob1(Scheduler scheduler) throws SchedulerException {
        JobDetail jobDetail = JobBuilder.newJob( ScheduledJob1.class) .withIdentity("job1", "group1").build();
        // 6的倍数秒执行 也就是 6 12 18 24 30 36 42 ....
        CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/6 * * * * ?");
        CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1")
                .usingJobData("name","猿码天地1").withSchedule(scheduleBuilder).build();
        scheduler.scheduleJob(jobDetail,cronTrigger);
    }

    /**
     * 调度2
     * @param scheduler
     * @throws SchedulerException
     */
    private void scheduleJob2(Scheduler scheduler) throws SchedulerException {
        JobDetail jobDetail = JobBuilder.newJob(ScheduledJob2.class) .withIdentity("job2", "group2").build();
        // 12秒的倍数执行 也就是 12  24 36  48  60....
        CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/12 * * * * ?");
        CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger2", "group2")
                .usingJobData("name","猿码天地2").withSchedule(scheduleBuilder).build();
        scheduler.scheduleJob(jobDetail,cronTrigger);
    }

    /**
     * 同时启动两个定时任务
     * @throws SchedulerException
     */
    public void scheduleJobs() throws SchedulerException {
        Scheduler scheduler = schedulerFactoryBean.getScheduler();
        scheduleJob1(scheduler);
        scheduleJob2(scheduler);
    }
}

触发定时任务

/**
 * <h3>springboot-study</h3>
 * 启动定时任务
 * @author : zhang.bw
 * @date : 2020-08-11 16:38
 **/
@Component
public class MyStartupRunner implements CommandLineRunner {

    @Autowired
    public CronSchedulerJob scheduleJobs;

    @Override
    public void run(String... args) throws Exception {
        scheduleJobs.scheduleJobs();
        System.out.println(">>>>>>定时任务开始执行<<<<<<");
    }
}

启动项目之后，就会在控制台看到打印的结果，结果如下：

3. 总结

通过本节课程可以看出，如果仅需要执行简单定时任务，就可以使用 Spring Boot 自带 Scheduled，可以非常简单和方便的使用。但如果需要在项目中执行大量的批任务处理时，可以采用 Quartz 来解决，Spring Boot 2.0 中提供了对 Quartz 的支持，让我们在项目使用的过程中更加的灵活简洁。

源码下载地址：关注公众号【猿码天地】并回复 springboot 获取