摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/Job/ 「芋道源码」欢迎转载，保留摘要，谢谢！

• 1. 概述
• 2. 快速入门 Spring Task
• 3. 快速入门 Quartz 单机
• 4. 再次入门 Quartz 集群
• 5. 快速入门 XXL-JOB
• 6. 快速入门 Elastic-Job
• 666. 彩蛋

本文在提供完整代码示例，可见 https://github.com/YunaiV/SpringBoot-Labs 的 lab-28 目录。

原创不易，给点个 Star 嘿，一起冲鸭！

1. 概述

文末有定时任务的技术选型的投票   

不要问为什么在文末？问就是想让胖友感受下这篇有多长

在产品的色彩斑斓的黑的需求中，有存在一类需求，是需要去定时执行的，此时就需要使用到定时任务。例如说，每分钟扫描超时支付的订单，每小时清理一次日志文件，每天统计前一天的数据并生成报表，每个月月初的工资单的推送，每年一次的生日提醒等等。

其中，艿艿最喜欢“每个月月初的工资单的推送”，你呢？

在 JDK 中，内置了两个类，可以实现定时任务的功能：

• java.util.Timer ：可以通过创建 java.util.TimerTask 调度任务，在同一个线程中串行执行，相互影响。也就是说，对于同一个 Timer 里的多个 TimerTask 任务，如果一个 TimerTask 任务在执行中，其它 TimerTask 即使到达执行的时间，也只能排队等待。因为 Timer 是串行的，同时存在 坑坑 ，所以后来 JDK 又推出了 ScheduledExecutorService ，Timer 也基本不再使用。
• java.util.concurrent.ScheduledExecutorService ：在 JDK 1.5 新增，基于线程池设计的定时任务类，每个调度任务都会被分配到线程池中并发执行，互不影响。这样，ScheduledExecutorService 就解决了 Timer 串行的问题。

在日常开发中，我们很少直接使用 Timer 或 ScheduledExecutorService 来实现定时任务的需求。主要有几点原因：

• 它们仅支持按照指定频率，不直接支持指定时间的定时调度，需要我们结合 Calendar 自行计算，才能实现复杂时间的调度。例如说，每天、每周五、2019-11-11 等等。
• 它们是进程级别，而我们为了实现定时任务的高可用，需要部署多个进程。此时需要等多考虑，多个进程下，同一个任务在相同时刻，不能重复执行。
• 项目可能存在定时任务较多，需要统一的管理，此时不得不进行二次封装。

所以，一般情况下，我们会选择专业的调度任务中间件。

关于“任务”的叫法，也有叫“作业”的。在英文上，有 Task 也有 Job 。本质是一样的，本文两种都会用。

然后，一般来说是调度任务，定时执行。所以胖友会在本文，或者其它文章中，会看到“调度”或“定时”的字眼儿。

在 Spring 体系中，内置了两种定时任务的解决方案：

• 第一种，Spring Framework 的 Spring Task 模块，提供了轻量级的定时任务的实现。

• 第二种，Spring Boot 2.0 版本，整合了 Quartz 作业调度框架，提供了功能强大的定时任务的实现。

  注：Spring Framework 已经内置了 Quartz 的整合。Spring Boot 1.X 版本未提供 Quartz 的自动化配置，而 2.X 版本提供了支持。

在 Java 生态中，还有非常多优秀的开源的调度任务中间件：

• Elastic-Job

  唯品会基于 Elastic-Job 之上，演化出了 Saturn 项目。

• Apache DolphinScheduler

• XXL-JOB

目前国内采用 Elastic-Job 和 XXL-JOB 为主。从艿艿了解到的情况，使用 XXL-JOB 的团队会更多一些，主要是上手较为容易，运维功能更为完善。

本文，我们会按照 Spring Task、Quartz、XXL-JOB 的顺序，进行分别入门。而在文章的结尾，会简单聊聊分布式定时任务的实现原理。

2. 快速入门 Spring Task

示例代码对应仓库：lab-28-task-demo 。

考虑到实际场景下，我们很少使用 Spring Task ，所以本小节会写的比较简洁。如果对 Spring Task 比较感兴趣的胖友，可以自己去阅读 《Spring Framework Documentation —— Task Execution and Scheduling》 文档，里面有 Spring Task 相关的详细文档。

在本小节，我们会使用 Spring Task 功能，实现一个每 2 秒打印一行执行日志的定时任务。

2.1 引入依赖

在 pom.xml 文件中，引入相关依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-28-task-demo</artifactId>

    <dependencies>
        <!-- 实现对 Spring MVC 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

</project>

因为 Spring Task 是 Spring Framework 的模块，所以在我们引入 spring-boot-starter-web 依赖后，无需特别引入它。

同时，考虑到我们希望让项目启动时，不自动结束 JVM 进程，所以我们引入了 spring-boot-starter-web 依赖。

2.2 ScheduleConfiguration

在 cn.iocoder.springboot.lab28.task.config 包路径下，创建 ScheduleConfiguration 类，配置 Spring Task 。代码如下：

// ScheduleConfiguration.java

@Configuration
@EnableScheduling
public class ScheduleConfiguration {
}

• 在类上，添加 @EnableScheduling 注解，启动 Spring Task 的定时任务调度的功能。

2.3 DemoJob

在 cn.iocoder.springboot.lab28.task.job 包路径下，创建 DemoJob 类，示例定时任务类。代码如下：

// DemoJob.java

@Component
public class DemoJob {

    private Logger logger = LoggerFactory.getLogger(getClass());

    private final AtomicInteger counts = new AtomicInteger();

    @Scheduled(fixedRate = 2000)
    public void execute() {
        logger.info("[execute][定时第 ({}) 次执行]", counts.incrementAndGet());
    }

}

• 在类上，添加 @Component 注解，创建 DemoJob Bean 对象。
• 创建 #execute() 方法，实现打印日志。同时，在该方法上，添加 @Scheduled 注解，设置每 2 秒执行该方法。

虽然说，@Scheduled 注解，可以添加在一个类上的多个方法上，但是艿艿的个人习惯上，还是一个 Job 类，一个定时任务。

2.4 Application

创建 Application.java 类，配置 @SpringBootApplication 注解即可。代码如下：

@SpringBootApplication
public class Application {

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

}

运行 Application 类，启动示例项目。输出日志精简如下：

# 初始化一个 ThreadPoolTaskScheduler 任务调度器
2019-11-30 18:02:58.415  INFO 83730 --- [           main] o.s.s.c.ThreadPoolTaskScheduler          : Initializing ExecutorService 'taskScheduler'

# 每 2 秒，执行一次 DemoJob 的任务
2019-11-30 18:02:58.449  INFO 83730 --- [ pikaqiu-demo-1] c.i.springboot.lab28.task.job.DemoJob    : [execute][定时第 (1) 次执行]
2019-11-30 18:03:00.438  INFO 83730 --- [ pikaqiu-demo-1] c.i.springboot.lab28.task.job.DemoJob    : [execute][定时第 (2) 次执行]
2019-11-30 18:03:02.442  INFO 83730 --- [ pikaqiu-demo-2] c.i.springboot.lab28.task.job.DemoJob    : [execute][定时第 (3) 次执行]

• 通过日志，我们可以看到，初始化一个 ThreadPoolTaskScheduler 任务调度器。之后，每 2 秒，执行一次 DemoJob 的任务。

至此，我们已经完成了 Spring Task 调度任务功能的入门。实际上，Spring Task 还提供了异步任务 ，这个我们在其它文章中，详细讲解。

下面「2.5 @Scheduled」和「2.6 应用配置文件」两个小节，是补充知识，建议看看。

2.5 @Scheduled

@Scheduled 注解，设置定时任务的执行计划。

常用属性如下：

• cron 属性：Spring Cron 表达式。例如说，"0 0 12 * * ?" 表示每天中午执行一次，"11 11 11 11 11 ?" 表示 11 月 11 号 11 点 11 分 11 秒执行一次（哈哈哈）。更多示例和讲解，可以看看 《Spring Cron 表达式》 文章。注意，以调用完成时刻为开始计时时间。
• fixedDelay 属性：固定执行间隔，单位：毫秒。注意，以调用完成时刻为开始计时时间。
• fixedRate 属性：固定执行间隔，单位：毫秒。注意，以调用开始时刻为开始计时时间。
• 这三个属性，有点雷同，可以看看 《@Scheduled 定时任务的fixedRate、fixedDelay、cron 的区别》 ，一定要分清楚差异。

不常用属性如下：

• initialDelay 属性：初始化的定时任务执行延迟，单位：毫秒。
• zone 属性：解析 Spring Cron 表达式的所属的时区。默认情况下，使用服务器的本地时区。
• initialDelayString 属性：initialDelay 的字符串形式。
• fixedDelayString 属性：fixedDelay 的字符串形式。
• fixedRateString 属性：fixedRate 的字符串形式。

2.6 应用配置文件

在 application.yml 中，添加 Spring Task 定时任务的配置，如下：

spring:
  task:
    # Spring Task 调度任务的配置，对应 TaskSchedulingProperties 配置类
    scheduling:
      thread-name-prefix: pikaqiu-demo- # 线程池的线程名的前缀。默认为 scheduling- ，建议根据自己应用来设置
      pool:
        size: 10 # 线程池大小。默认为 1 ，根据自己应用来设置
      shutdown:
        await-termination: true # 应用关闭时，是否等待定时任务执行完成。默认为 false ，建议设置为 true
        await-termination-period: 60 # 等待任务完成的最大时长，单位为秒。默认为 0 ，根据自己应用来设置

• 在 spring.task.scheduling 配置项，Spring Task 调度任务的配置，对应 TaskSchedulingProperties 配置类。
• Spring Boot TaskSchedulingAutoConfiguration 自动化配置类，实现 Spring Task 的自动配置，创建 ThreadPoolTaskScheduler 基于线程池的任务调度器。本质上，ThreadPoolTaskScheduler 是基于 ScheduledExecutorService 的封装，增强在调度时间上的功能。

注意，spring.task.scheduling.shutdown 配置项，是为了实现 Spring Task 定时任务的优雅关闭。我们想象一下，如果定时任务在执行的过程中，如果应用开始关闭，把定时任务需要使用到的 Spring Bean 进行销毁，例如说数据库连接池，那么此时定时任务还在执行中，一旦需要访问数据库，可能会导致报错。

• 所以，通过配置 await-termination = true ，实现应用关闭时，等待定时任务执行完成。这样，应用在关闭的时，Spring 会优先等待 ThreadPoolTaskScheduler 执行完任务之后，再开始 Spring Bean 的销毁。
• 同时，又考虑到我们不可能无限等待定时任务全部执行结束，因此可以配置 await-termination-period = 60 ，等待任务完成的最大时长，单位为秒。具体设置多少的等待时长，可以根据自己应用的需要。

3. 快速入门 Quartz 单机

示例代码对应仓库：lab-28-task-quartz-memory 。

在艿艿最早开始实习的时候，公司使用 Quartz 作为任务调度中间件。考虑到我们要实现定时任务的高可用，需要部署多个 JVM 进程。比较舒服的是，Quartz 自带了集群方案。它通过将作业信息存储到关系数据库中，并使用关系数据库的行锁来实现执行作业的竞争，从而保证多个进程下，同一个任务在相同时刻，不能重复执行。

可能很多胖友对 Quartz 还不是很了解，我们先来看一段简介：

FROM https://www.oschina.net/p/quartz

Quartz 是一个开源的作业调度框架，它完全由 Java 写成，并设计用于 J2SE 和 J2EE 应用中。它提供了巨大的灵活性而不牺牲简单性。你能够用它来为执行一个作业而创建简单的或复杂的调度。

它有很多特征，如：数据库支持，集群，插件，EJB 作业预构建，JavaMail 及其它，支持 cron-like 表达式等等。

在 Quartz 体系结构中，有三个组件非常重要：

• Scheduler ：调度器
• Trigger ：触发器
• Job ：任务

不了解的胖友，可以直接看看 《Quartz 入门详解》 文章。这里，艿艿就不重复赘述。

FROM https://medium.com/@ChamithKodikara/spring-boot-2-quartz-2-scheduler-integration-a8eaaf850805

Quartz 整体架构图

Quartz 分成单机模式和集群模式。

• 本小节，我们先来学习下 Quartz 的单机模式，入门比较快。
• 下一下「5. 再次入门 Quartz 集群」 ，我们再来学习下 Quartz 的集群模式。在生产环境下，一定一定一定要使用 Quartz 的集群模式，保证定时任务的高可用。

下面，让我们开始遨游~

3.1 引入依赖

在 pom.xml 文件中，引入相关依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-28-task-quartz-memory</artifactId>

    <dependencies>
        <!-- 实现对 Spring MVC 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 实现对 Quartz 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>
    </dependencies>

</project>

具体每个依赖的作用，胖友自己认真看下艿艿添加的所有注释噢。

3.2 示例 Job

在 cn.iocoder.springboot.lab28.task.config.job 包路径下，我们来创建示例 Job 。

创建 DemoJob01 类，示例定时任务 01 类。代码如下：

// DemoJob01.java

public class DemoJob01 extends QuartzJobBean {

    private Logger logger = LoggerFactory.getLogger(getClass());

    private final AtomicInteger counts = new AtomicInteger();

    @Autowired
    private DemoService demoService;

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        logger.info("[executeInternal][定时第 ({}) 次执行, demoService 为 ({})]", counts.incrementAndGet(),
                demoService);
    }

}

• 继承 QuartzJobBean 抽象类，实现 #executeInternal(JobExecutionContext context) 方法，执行自定义的定时任务的逻辑。

• QuartzJobBean 实现了 org.quartz.Job 接口，提供了 Quartz 每次创建 Job 执行定时逻辑时，将该 Job Bean 的依赖属性注入。例如说，DemoJob01 需要 @Autowired 注入的 demoService 属性。核心代码如下：

  // QuartzJobBean.java
  
  public final void execute(JobExecutionContext context) throws JobExecutionException {
      try {
          // 将当前对象，包装成 BeanWrapper 对象
          BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
          // 设置属性到 bw 中
          MutablePropertyValues pvs = new MutablePropertyValues();
          pvs.addPropertyValues(context.getScheduler().getContext());
          pvs.addPropertyValues(context.getMergedJobDataMap());
          bw.setPropertyValues(pvs, true);
   } catch (SchedulerException ex) {
    throw new JobExecutionException(ex);
   }
  
      // 执行提供给子类实现的抽象方法
      this.executeInternal(context);
  }
  
  protected abstract void executeInternal(JobExecutionContext context) throws JobExecutionException;
  

  • 这样一看，是不是清晰很多。不要惧怕中间件的源码，好奇哪个类或者方法，就点进去看看。反正，又不花钱。

• counts 属性，计数器。用于我们后面我们展示，每次 DemoJob01 都会被 Quartz 创建出一个新的 Job 对象，执行任务。这个很重要，也要非常小心。

创建 DemoJob02 类，示例定时任务 02 类。代码如下：

// DemoJob02.java

public class DemoJob02 extends QuartzJobBean {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        logger.info("[executeInternal][我开始的执行了]");
    }

}

• 比较简单，为了后面演示案例之用。

3.3 ScheduleConfiguration

在 cn.iocoder.springboot.lab28.task.config 包路径下，创建 ScheduleConfiguration 类，配置上述的两个示例 Job 。代码如下：

// ScheduleConfiguration.java

@Configuration
public class ScheduleConfiguration {

    public static class DemoJob01Configuration {

        @Bean
        public JobDetail demoJob01() {
            return JobBuilder.newJob(DemoJob01.class)
                    .withIdentity("demoJob01") // 名字为 demoJob01
                    .storeDurably() // 没有 Trigger 关联的时候任务是否被保留。因为创建 JobDetail 时，还没 Trigger 指向它，所以需要设置为 true ，表示保留。
                    .build();
        }

        @Bean
        public Trigger demoJob01Trigger() {
            // 简单的调度计划的构造器
            SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
                    .withIntervalInSeconds(5) // 频率。
                    .repeatForever(); // 次数。
            // Trigger 构造器
            return TriggerBuilder.newTrigger()
                    .forJob(demoJob01()) // 对应 Job 为 demoJob01
                    .withIdentity("demoJob01Trigger") // 名字为 demoJob01Trigger
                    .withSchedule(scheduleBuilder) // 对应 Schedule 为 scheduleBuilder
                    .build();
        }

    }

    public static class DemoJob02Configuration {

        @Bean
        public JobDetail demoJob02() {
            return JobBuilder.newJob(DemoJob02.class)
                    .withIdentity("demoJob02") // 名字为 demoJob02
                    .storeDurably() // 没有 Trigger 关联的时候任务是否被保留。因为创建 JobDetail 时，还没 Trigger 指向它，所以需要设置为 true ，表示保留。
                    .build();
        }

        @Bean
        public Trigger demoJob02Trigger() {
            // 基于 Quartz Cron 表达式的调度计划的构造器
            CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/10 * * * * ? *");
            // Trigger 构造器
            return TriggerBuilder.newTrigger()
                    .forJob(demoJob02()) // 对应 Job 为 demoJob02
                    .withIdentity("demoJob02Trigger") // 名字为 demoJob02Trigger
                    .withSchedule(scheduleBuilder) // 对应 Schedule 为 scheduleBuilder
                    .build();
        }

    }

}

• 内部创建了 DemoJob01Configuration 和 DemoJob02Configuration 两个配置类，分别配置 DemoJob01 和 DemoJob02 两个 Quartz Job 。
• ========== DemoJob01Configuration ==========
• #demoJob01() 方法，创建 DemoJob01 的 JobDetail Bean 对象。
• #demoJob01Trigger() 方法，创建 DemoJob01 的 Trigger Bean 对象。其中，我们使用 SimpleScheduleBuilder 简单的调度计划的构造器，创建了每 5 秒执行一次，无限重复的调度计划。
• ========== DemoJob2Configuration ==========
• #demoJob2() 方法，创建 DemoJob02 的 JobDetail Bean 对象。
• #demoJob02Trigger() 方法，创建 DemoJob02 的 Trigger Bean 对象。其中，我们使用 CronScheduleBuilder 基于 Quartz Cron 表达式的调度计划的构造器，创建了每第 10 秒执行一次的调度计划。这里，推荐一个 Quartz/Cron/Crontab 表达式在线生成工具 ，方便帮我们生成 Quartz Cron 表达式，并计算出最近 5 次运行时间。

因为 JobDetail 和 Trigger 一般是成双成对出现，所以艿艿习惯配置成一个 Configuration 配置类。

3.4 Application

创建 Application.java 类，配置 @SpringBootApplication 注解即可。代码如下：

@SpringBootApplication
public class Application {

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

}

运行 Application 类，启动示例项目。输出日志精简如下：

# 创建了 Quartz QuartzScheduler 并启动
2019-11-30 23:40:05.123  INFO 92812 --- [           main] org.quartz.impl.StdSchedulerFactory      : Using default implementation for ThreadExecutor
2019-11-30 23:40:05.130  INFO 92812 --- [           main] org.quartz.core.SchedulerSignalerImpl    : Initialized Scheduler Signaller of type: class org.quartz.core.SchedulerSignalerImpl
2019-11-30 23:40:05.130  INFO 92812 --- [           main] org.quartz.core.QuartzScheduler          : Quartz Scheduler v.2.3.2 created.
2019-11-30 23:40:05.131  INFO 92812 --- [           main] org.quartz.simpl.RAMJobStore             : RAMJobStore initialized.
2019-11-30 23:40:05.132  INFO 92812 --- [           main] org.quartz.core.QuartzScheduler          : Scheduler meta-data: Quartz Scheduler (v2.3.2) 'quartzScheduler' with instanceId 'NON_CLUSTERED'
  Scheduler class: 'org.quartz.core.QuartzScheduler' - running locally.
  NOT STARTED.
  Currently in standby mode.
  Number of jobs executed: 0
  Using thread pool 'org.quartz.simpl.SimpleThreadPool' - with 10 threads.
  Using job-store 'org.quartz.simpl.RAMJobStore' - which does not support persistence. and is not clustered.

2019-11-30 23:40:05.132  INFO 92812 --- [           main] org.quartz.impl.StdSchedulerFactory      : Quartz scheduler 'quartzScheduler' initialized from an externally provided properties instance.
2019-11-30 23:40:05.132  INFO 92812 --- [           main] org.quartz.impl.StdSchedulerFactory      : Quartz scheduler version: 2.3.2
2019-11-30 23:40:05.132  INFO 92812 --- [           main] org.quartz.core.QuartzScheduler          : JobFactory set to: org.springframework.scheduling.quartz.SpringBeanJobFactory@203dd56b
2019-11-30 23:40:05.158  INFO 92812 --- [           main] o.s.s.quartz.SchedulerFactoryBean        : Starting Quartz Scheduler now
2019-11-30 23:40:05.158  INFO 92812 --- [           main] org.quartz.core.QuartzScheduler          : Scheduler quartzScheduler_$_NON_CLUSTERED started.

# DemoJob01
2019-11-30 23:40:05.164  INFO 92812 --- [eduler_Worker-1] c.i.springboot.lab28.task.job.DemoJob01  : [executeInternal][定时第 (1) 次执行, demoService 为 (cn.iocoder.springboot.lab28.task.service.DemoService@23d75d74)]
2019-11-30 23:40:09.866  INFO 92812 --- [eduler_Worker-2] c.i.springboot.lab28.task.job.DemoJob01  : [executeInternal][定时第 (1) 次执行, demoService 为 (cn.iocoder.springboot.lab28.task.service.DemoService@23d75d74)]
2019-11-30 23:40:14.865  INFO 92812 --- [eduler_Worker-4] c.i.springboot.lab28.task.job.DemoJob01  : [executeInternal][定时第 (1) 次执行, demoService 为 (cn.iocoder.springboot.lab28.task.service.DemoService@23d75d74)]

# DemoJob02
2019-11-30 23:40:10.004  INFO 92812 --- [eduler_Worker-3] c.i.springboot.lab28.task.job.DemoJob02  : [executeInternal][我开始的执行了]
2019-11-30 23:40:20.001  INFO 92812 --- [eduler_Worker-6] c.i.springboot.lab28.task.job.DemoJob02  : [executeInternal][我开始的执行了]
2019-11-30 23:40:30.002  INFO 92812 --- [eduler_Worker-9] c.i.springboot.lab28.task.job.DemoJob02  : [executeInternal][我开始的执行了]

• 项目启动时，会创建了 Quartz QuartzScheduler 并启动。
• 考虑到阅读日志方便，艿艿这里把 DemoJob01 和 DemoJob02 的日志分开来了。
• 对于 DemoJob01 ，每 5 秒左右执行一次。同时我们可以看到，demoService 成功注入，而 counts 每次都是 1 ，说明每次 DemoJob01 都是新创建的。
• 对于 DemoJob02 ，每第 10 秒执行一次。

下面「3.5 应用配置文件」两个小节，是补充知识，建议看看。

3.5 应用配置文件

在 application.yml 中，添加 Quartz 的配置，如下：

spring:
  # Quartz 的配置，对应 QuartzProperties 配置类
  quartz:
    job-store-type: memory # Job 存储器类型。默认为 memory 表示内存，可选 jdbc 使用数据库。
    auto-startup: true # Quartz 是否自动启动
    startup-delay: 0 # 延迟 N 秒启动
    wait-for-jobs-to-complete-on-shutdown: true # 应用关闭时，是否等待定时任务执行完成。默认为 false ，建议设置为 true
    overwrite-existing-jobs: false # 是否覆盖已有 Job 的配置
    properties: # 添加 Quartz Scheduler 附加属性，更多可以看 http://www.quartz-scheduler.org/documentation/2.4.0-SNAPSHOT/configuration.html 文档
      org:
        quartz:
          threadPool:
            threadCount: 25 # 线程池大小。默认为 10 。
            threadPriority: 5 # 线程优先级
            class: org.quartz.simpl.SimpleThreadPool # 线程池类型
#    jdbc: # 这里暂时不说明，使用 JDBC 的 JobStore 的时候，才需要配置

• 在 spring.quartz 配置项，Quartz 的配置，对应 QuartzProperties 配置类。
• Spring Boot QuartzAutoConfiguration 自动化配置类，实现 Quartz 的自动配置，创建 Quartz Scheduler(调度器) Bean 。

注意，spring.quartz.wait-for-jobs-to-complete-on-shutdown配置项，是为了实现 Quartz 的优雅关闭，建议开启。关于这块，和我们在 Spring Task 的「2.6 应用配置文件」 提到的是一致的。

4. 再次入门 Quartz 集群

示例代码对应仓库：lab-28-task-quartz-memory 。

实际场景下，我们必然需要考虑定时任务的高可用，所以基本上，肯定使用 Quartz 的集群方案。因此本小节，我们使用 Quartz 的 JDBC    存储器 JobStoreTX ，并是使用 MySQL 作为数据库。

如下是 Quartz 两种存储器的对比：

FROM https://blog.csdn.net/Evankaka/article/details/45540885

艿艿：实际上，有方案可以实现兼具这两种方式的优点，我们在 「666. 彩蛋」 中来说。

另外，本小节提供的示例和 「3. 快速入门 Quartz 单机」 基本一致。 下面，让我们开始遨游~

4.1 引入依赖

在 pom.xml 文件中，引入相关依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-28-task-quartz-jdbc</artifactId>

    <dependencies>
        <!-- 实现对数据库连接池的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency> <!-- 本示例，我们使用 MySQL -->
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.48</version>
        </dependency>

        <!-- 实现对 Spring MVC 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 实现对 Quartz 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>

        <!-- 方便等会写单元测试 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

• 和 「3.1 引入依赖」 基本一致，只是额外引入 spring-boot-starter-test 依赖，等会会写两个单元测试方法。

4.2 示例 Job

在 cn.iocoder.springboot.lab28.task.config.job 包路径下，创建 DemoJob01 和 DemoJob02 类。代码如下：

// DemoJob01.java

@DisallowConcurrentExecution
public class DemoJob01 extends QuartzJobBean {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @Autowired
    private DemoService demoService;

    @Override
    protected void executeInternal(JobExecutionContext context) {
        logger.info("[executeInternal][我开始的执行了, demoService 为 ({})]", demoService);
    }

}

// DemoJob02.java

@DisallowConcurrentExecution
public class DemoJob02 extends QuartzJobBean {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @Override
    protected void executeInternal(JobExecutionContext context) {
        logger.info("[executeInternal][我开始的执行了]");
    }

}

• 相比 「3.2 示例 Job」 来说，在类上添加了 Quartz 的 @DisallowConcurrentExecution 注解，保证相同 JobDetail 在多个 JVM 进程中，有且仅有一个节点在执行。

注意，不是以 Quartz Job 为维度，保证在多个 JVM 进程中，有且仅有一个节点在执行，而是以 JobDetail 为维度。虽然说，绝大多数情况下，我们会保证一个 Job 和 JobDetail 是一一对应。 所以，搞不清楚这个概念的胖友，最好搞清楚这个概念。实在有点懵逼，保证一个 Job 和 JobDetail 是一一对应就对了。

而 JobDetail 的唯一标识是 JobKey ，使用 name + group 两个属性。一般情况下，我们只需要设置 name 即可，而 Quartz 会默认 group = DEFAULT 。

不过这里还有一点要补充，也是需要注意的，在 Quartz 中，相同 Scheduler 名字的节点，形成一个 Quartz 集群。在下文中，我们可以通过 spring.quartz.scheduler-name 配置项，设置 Scheduler 的名字。

【重要】为什么要说这个呢？因为我们要完善一下上面的说法：通过在 Job 实现类上添加 @DisallowConcurrentExecution 注解，实现在相同 Quartz Scheduler 集群中，相同 JobKey 的 JobDetail ，保证在多个 JVM 进程中，有且仅有一个节点在执行。

4.3 应用配置文件

在 application.yml 中，添加 Quartz 的配置，如下：

spring:
  datasource:
    user:
      url: jdbc:mysql://127.0.0.1:3306/lab-28-quartz-jdbc-user?useSSL=false&useUnicode=true&characterEncoding=UTF-8
      driver-class-name: com.mysql.jdbc.Driver
      username: root
      password:
    quartz:
      url: jdbc:mysql://127.0.0.1:3306/lab-28-quartz-jdbc-quartz?useSSL=false&useUnicode=true&characterEncoding=UTF-8
      driver-class-name: com.mysql.jdbc.Driver
      username: root
      password:

  # Quartz 的配置，对应 QuartzProperties 配置类
  quartz:
    scheduler-name: clusteredScheduler # Scheduler 名字。默认为 schedulerName
    job-store-type: jdbc # Job 存储器类型。默认为 memory 表示内存，可选 jdbc 使用数据库。
    auto-startup: true # Quartz 是否自动启动
    startup-delay: 0 # 延迟 N 秒启动
    wait-for-jobs-to-complete-on-shutdown: true # 应用关闭时，是否等待定时任务执行完成。默认为 false ，建议设置为 true
    overwrite-existing-jobs: false # 是否覆盖已有 Job 的配置
    properties: # 添加 Quartz Scheduler 附加属性，更多可以看 http://www.quartz-scheduler.org/documentation/2.4.0-SNAPSHOT/configuration.html 文档
      org:
        quartz:
          # JobStore 相关配置
          jobStore:
            # 数据源名称
            dataSource: quartzDataSource # 使用的数据源
            class: org.quartz.impl.jdbcjobstore.JobStoreTX # JobStore 实现类
            driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate
            tablePrefix: QRTZ_ # Quartz 表前缀
            isClustered: true # 是集群模式
            clusterCheckinInterval: 1000
            useProperties: false
          # 线程池相关配置
          threadPool:
            threadCount: 25 # 线程池大小。默认为 10 。
            threadPriority: 5 # 线程优先级
            class: org.quartz.simpl.SimpleThreadPool # 线程池类型
    jdbc: # 使用 JDBC 的 JobStore 的时候，JDBC 的配置
      initialize-schema: never # 是否自动使用 SQL 初始化 Quartz 表结构。这里设置成 never ，我们手动创建表结构。

• 配置项比较多，我们主要对比 「3.5 应用配置文件」 来看看。

• 在 spring.datasource 配置项下，用于创建多个数据源的配置。

  • user 配置，连接 lab-28-quartz-jdbc-user 库。目的是，为了模拟我们一般项目，使用到的业务数据库。
  • quartz 配置，连接 lab-28-quartz-jdbc-quartz 库。目的是，Quartz 会使用单独的数据库。©著作权归作者所有：来自51CTO博客作者mb5ff80520dfa04的原创作品，如需转载，请注明出处，否则将追究法律责任

    更多相关文章

    1. flask示例
    2. ThingJS官方示例（十一）：基于数据矢量及贴图url开发OD线
    3. LightningChart JS Angular图表使用示例
    4. 每日 (No.0x01)ECMAScript 2016,2017和2018中所有新功能的示例（上
    5. 每日前端夜话(0x02)：ECMAScript 2016,2017和2018中所有新功能的示
    6. 官方示例（十二）：网页加载道路及Geoline开发ThingJS
    7. 官方示例（十三）：3步70行代码开发GIS点坐标技术 ThingJS
    8. 利用端口扫描进行终端合规性检查的一个示例
    9. 如何将smarty安装到MVC架构中（代码示例）

    随机推荐

    1. 2013.07.11——— android MediaRecorder
    2. Android编码规范
    3. 【翻译】(8-补丁1)Android接口定义语言（AI
    4. Android之Google Map(一)
    5. android 多项对话框
    6. android有用网址
    7. [转] 软键盘android:windowSoftInputMode
    8. Android 常用的权限
    9. 探索Android该Parcel机制上
    10. Android 角标 BadgeView/android-viewbad