如何在 Spring Boot 中使用 Quartz 调度作业

在本文中，我们将看看如何使用Quartz框架来调度任务。Quartz是Java应用程序调度库的事实标准。Quartz支持在特定时间运行作业、重复作业执行、将作业存储在数据库中以及Spring集成。,,​,在 Spring 应用程序中使用 Quartz 最简单的方法是使用@Scheduled注解。接下来，我们将考虑一个 Spring Boot 应用程序的示例。让我们添加必要的依赖项build.gradle,implementation 'org.springframework.boot:spring-boot-starter-quartz',
,并考虑一个例子,此外，@Scheduled要使注解起作用，您需要使用@EnableScheduling注解添加配置。,结果将是每五秒在控制台中输出一个文本。,Periodic task: Thu Jul 07 18:24:50 EDT 2022,Periodic task: Thu Jul 07 18:24:55 EDT,2022 Periodic task: Thu Jul 07 18:25:00 EDT 2022,...,
,@Scheduled注解支持以下参数：,默认情况下fixedRate，fixedDelay和initialDelay以毫秒为单位设置。这可以使用timeUnit参数进行更改，将值设置NANOSECONDS为DAYS。,此外，您可以在 @Scheduled 注释中使用属性：,application.properties,PeriodicTask.java
,要使用属性，您可以使用fixedRateString, fixedDelayString, 和initialDelayString参数来代替 fixedRate,fixedDelay和initialDelay相应的。,​,在前面的例子中，我们执行了定时任务，但同时我们不能动态设置作业的开始时间，也不能给它传递参数。要解决这些问题，可以直接使用 Quartz。,下面列出了主要的 Quartz 接口：,要直接使用 Quartz，无需使用@EnableScheduling注解定义配置org.springframework.boot:spring-boot-starter-quartz，您可以使用org.quartz-scheduler:quartz.,让我们定义 SimpleJob 类：,要实现Job接口，您只需要实现一个execute接受JobExecutionContext类型参数的方法。JobExecutionContext包含有关作业实例、触发器、调度程序的信息以及有关作业执行的其他信息。,现在让我们定义一个作业实例：,并创建一个将在五秒后触发的触发器：,另外，创建一个调度程序：,在“待机”模式下Scheduler初始化，所以我们必须调用start方法：,现在我们可以安排作业的执行：,更进一步，在创建时JobDetails，让我们添加额外的数据并在执行作业时使用它：,QuartzDemoApplication.java,SimpleJob.java
,需要注意的是，添加到的所有值都JobDataMap必须是可序列化的。,​,Quartz 将有关JobDetail、Trigger的数据和其他信息存储在JobStore. 默认情况下，JobStore使用内存。这意味着如果我们在它们被触发之前已经安排了任务并关闭了应用程序（例如，在重新启动或崩溃时），那么它们将永远不会再次执行。Quartz 还支持 JDBC-JobStore 在数据库中存储信息。,在使用 JDBC-JobStore 之前，需要在 Quartz 将使用的数据库中创建表。默认情况下，这些表的前缀为QRTZ_.,Quartz 源代码包含用于为各种数据库（如 Oracle、Postgres、MS SQL Server、MySQL 等）创建表的SQL 脚本，并且还有一个用于 Liquibase 的现成 XML 文件。,spring.quartz.jdbc.initialize-schema=always此外，通过指定属性，可以在启动应用程序时自动创建 QRTZ 表。,为简单起见，我们将使用第二种方法和 H2 数据库。让我们配置一个数据源，使用 JDBCJobStore 并在 application.properties 中创建 QRTZ 表：,spring.datasource.url=jdbc:h2:mem:testdb spring.datasource.driverClassName=org.h2.Driver spring.datasource.username=sa spring.datasource.password= spring.quartz.job-store-type=jdbc spring.quartz.jdbc.initialize-schema=always,
,要考虑这些设置，必须将调度程序创建为 Spring bean：,Quartz 在单独的线程中运行每个任务，您可以为调度程序配置线程池。还需要注意的是，默认情况下，通过@Scheduled注解和直接通过 Quartz 启动的任务是在不同的线程池中启动的。我们可以确保这一点：,PeriodicTask.java,SimpleJob.java,输出将是：,Periodic task: Thu Jul 07 19:22:45 EDT 2022; Thread: scheduling-1 Job: class quartzdemo.jobs.SimpleJob; Param: value; Thread: quartzScheduler_Worker-1 Periodic task: Thu Jul 07 19:22:50 EDT 2022; Thread: scheduling-1 Periodic task: Thu Jul 07 19:22:55 EDT 2022; Thread: scheduling-1 Periodic task: Thu Jul 07 19:23:00 EDT 2022; Thread: scheduling-1,任务的线程池@Scheduled只包含一个线程。,让我们更改 @Scheduled 任务的调度程序设置：,​,输出现在将是这样的：,Periodic task: Thu Jul 07 19:44:10 EDT 2022; Thread: my-scheduled-task-pool-1 Job: class quartzdemo.jobs.SimpleJob; Param: value; Thread: quartzScheduler_Worker-1 Periodic task: Thu Jul 07 19:44:15 EDT 2022; Thread: my-scheduled-task-pool-1 Periodic task: Thu Jul 07 19:44:20 EDT 2022; Thread: my-scheduled-task-pool-2,如您所见，这些设置仅影响使用注释设置的任务。,现在让我们更改直接使用 Quartz 的调度程序的设置。这可以通过两种方式完成：通过属性文件或通过创建 bean SchedulerFactoryBeanCustomizer。,​,让我们使用第一种方法。如果我们没有通过 Spring 初始化 Quartz，我们将不得不在 quartz.properties 文件中注册属性。在我们的例子中，我们需要在 application.properties 中注册属性，并spring.quartz.properties.为其添加前缀。,application.properties,spring.quartz.properties.org.quartz.threadPool.threadNamePrefix=my-scheduler_Worker spring.quartz.properties.org.quartz.threadPool.threadCount=25,
,让我们启动应用程序。现在输出将是这样的：,Periodic task: Sat Jul 23 10:45:55 MSK 2022; Thread: my-scheduled-task-pool-1 Job: class quartzdemo.jobs.SimpleJob; Param: value; Thread: my-scheduler_Worker-1,现在调用启动任务的线程my-scheduler_Worker-1。,如果您需要创建多个具有不同参数的调度程序，则必须定义多个SchedulerFactoryBeans. 让我们看一个例子。,​,输出：,Job: class quartzdemo.jobs.SimpleJob; Param: value2; Thread: my-custom-scheduler2_Worker-1 Job: class quartzdemo.jobs.SimpleJob; Param: value1; Thread: my-custom-scheduler1_Worker-1,Quartz 是一个用于自动执行计划任务的强大框架。它既可以在简单直观的 Spring 注解的帮助下使用，也可以通过精细的定制和调整来使用，从而为复杂的问题提供解决方案。,​,原文标题：​​How to Schedule Jobs With Quartz in Spring Boot​​