在本文中,我们将看看如何使用Quartz框架来调度任务。Quartz是Java应用程序调度库的事实标准。Quartz支持在特定时间运行作业、重复作业执行、将作业存储在数据库中以及Spring集成。
用于调度的 Spring 注解
在 Spring 应用程序中使用 Quartz 最简单的方法是使用@Scheduled注解。接下来,我们将考虑一个 Spring Boot 应用程序的示例。让我们添加必要的依赖项build.gradle
implementation 'org.springframework.boot:spring-boot-starter-quartz'
并考虑一个例子
package quartzdemo.tasks; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Component; import java.util.Date; @Component public class PeriodicTask { @Scheduled(cron = "0/5 * * * * ?") public void everyFiveSeconds() { System.out.println("Periodic task: " + new Date()); } }
此外,@Scheduled要使注解起作用,您需要使用@EnableScheduling注解添加配置。
package quartzdemo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.scheduling.annotation.EnableScheduling; @SpringBootApplication @EnableScheduling public class QuartzDemoApplication { public static void main(String[] args) { SpringApplication.run(QuartzDemoApplication.class, args); } }
结果将是每五秒在控制台中输出一个文本。
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- 该参数用于fixedRate并fixedDelay在第一次执行具有指定延迟的任务之前等待。
- cron- 使用 cron-string 设置任务执行计划。还支持宏@yearly(or @annually)、@monthly、@weekly、@daily(or @midnight) 和@hourly.
默认情况下fixedRate,fixedDelay和initialDelay以毫秒为单位设置。这可以使用timeUnit参数进行更改,将值设置NANOSECONDS为DAYS。
此外,您可以在 @Scheduled 注释中使用属性:
application.properties
cron-string=0/5 * * * * ?
PeriodicTask.java
@Component public class PeriodicTask { @Scheduled(cron = "${cron-string}") public void everyFiveSeconds() { System.out.println("Periodic task: " + new Date()); } }
要使用属性,您可以使用fixedRateString, fixedDelayString, 和initialDelayString参数来代替 fixedRate,fixedDelay和initialDelay相应的。
使用Quartz
在前面的例子中,我们执行了定时任务,但同时我们不能动态设置作业的开始时间,也不能给它传递参数。要解决这些问题,可以直接使用 Quartz。
下面列出了主要的 Quartz 接口:
- Job是由包含我们希望执行的业务逻辑的类实现的接口
- JobDetails定义Job与之相关的实例和数据
- Trigger描述作业执行的时间表
- Scheduler是主要的 Quartz 界面,为作业和触发器提供所有操作和搜索操作
要直接使用 Quartz,无需使用@EnableScheduling注解定义配置org.springframework.boot:spring-boot-starter-quartz,您可以使用org.quartz-scheduler:quartz.
让我们定义 SimpleJob 类:
package quartzdemo.jobs; import org.quartz.Job; import org.quartz.JobExecutionCo