Quartz 调度器
Spring Boot 为使用 Quartz 调度器 提供了多项便利,包括 spring-boot-starter-quartz starter。如果 Quartz 可用,将通过 SchedulerFactoryBean 抽象自动配置一个 Scheduler。
以下类型的 Bean 会自动被识别并与 Scheduler 关联
-
JobDetail:定义一个特定 Job。JobDetail实例可以使用JobBuilderAPI 构建。 -
Trigger:定义何时触发特定 Job。
默认情况下,使用内存中的 JobStore。但是,如果应用程序中存在 DataSource bean 并且 spring.quartz.job-store-type 属性配置得当,则可以配置基于 JDBC 的存储,如下例所示
-
属性
-
YAML
spring.quartz.job-store-type=jdbc
spring:
quartz:
job-store-type: "jdbc"
使用 JDBC 存储时,可以在启动时初始化模式,如下例所示
-
属性
-
YAML
spring.quartz.jdbc.initialize-schema=always
spring:
quartz:
jdbc:
initialize-schema: "always"
默认情况下,数据库通过使用 Quartz 库提供的标准脚本进行检测和初始化。这些脚本会在每次重启时删除现有表,从而删除所有触发器。要使用自定义脚本,请设置 spring.quartz.jdbc.schema 属性。一些标准脚本(例如 SQL Server、Azure SQL 和 Sybase 的脚本)无法在不修改的情况下使用。在这些情况下,请复制脚本并按照脚本注释中的指示进行编辑,然后设置 spring.quartz.jdbc.schema 以使用您的自定义脚本。 |
要让 Quartz 使用应用程序主 DataSource 之外的 DataSource,请声明一个 DataSource bean,并使用 @QuartzDataSource 注解其 @Bean 方法。这样做可以确保 Quartz 特定的 DataSource 被 SchedulerFactoryBean 和模式初始化所使用。同样,要让 Quartz 使用应用程序主 TransactionManager 之外的 TransactionManager,请声明一个 TransactionManager bean,并使用 @QuartzTransactionManager 注解其 @Bean 方法。
默认情况下,由配置创建的 Job 不会覆盖已从持久化 Job 存储中读取的已注册 Job。要启用覆盖现有 Job 定义,请设置 spring.quartz.overwrite-existing-jobs 属性。
Quartz 调度器配置可以通过 spring.quartz 属性和 SchedulerFactoryBeanCustomizer bean 进行定制,这些 bean 允许对 SchedulerFactoryBean 进行程序化定制。高级 Quartz 配置属性可以使用 spring.quartz.properties.* 进行定制。
特别是,Executor bean 不与调度器关联,因为 Quartz 提供了一种通过 spring.quartz.properties 配置调度器的方式。如果需要自定义任务执行器,请考虑实现 SchedulerFactoryBeanCustomizer。 |
Job 可以定义 setter 来注入数据映射属性。常规 bean 也可以以类似的方式注入,如下例所示
-
Java
-
Kotlin
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;
public class MySampleJob extends QuartzJobBean {
// fields ...
private MyService myService;
private String name;
// Inject "MyService" bean
public void setMyService(MyService myService) {
this.myService = myService;
}
// Inject the "name" job data property
public void setName(String name) {
this.name = name;
}
@Override
protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
this.myService.someMethod(context.getFireTime(), this.name);
}
}
import org.quartz.JobExecutionContext
import org.springframework.scheduling.quartz.QuartzJobBean
class MySampleJob : QuartzJobBean() {
// fields ...
private var myService: MyService? = null
private var name: String? = null
// Inject "MyService" bean
fun setMyService(myService: MyService?) {
this.myService = myService
}
// Inject the "name" job data property
fun setName(name: String?) {
this.name = name
}
override fun executeInternal(context: JobExecutionContext) {
myService!!.someMethod(context.fireTime, name)
}
}