重学SpringBoot3-整合Quartz定时任务

server/2024/11/17 20:14:08/

更多SpringBoot3内容请关注我的专栏:《SpringBoot3》
期待您的点赞👍收藏⭐评论✍

Quartz 是一个开源的任务调度框架,用于在应用程序中创建、管理和调度定时任务。将 Quartz 和 Spring Boot 3 结合,可以轻松实现定时任务的灵活管理。本文将详细介绍如何在 Spring Boot 3 项目中集成 Quartz Scheduler 并实现示例任务的调度。

Quartz_Scheduler_7">1. 什么是 Quartz Scheduler?

Quartz 是 Java 平台下的一个强大、灵活的调度库,它支持复杂的任务调度,包括:

  • 简单的任务:按固定频率或延迟执行任务。
  • 基于 Cron 表达式的任务:支持类似于 Linux Cron 的表达式,用于定义复杂的定时任务。
  • 持久化任务:支持将任务数据持久化存储,以便在应用程序重启后可以恢复任务状态。

Quartz_Scheduler__15">2. Spring Boot 3 集成 Quartz Scheduler 的优势

  • 无缝集成:通过 Spring Boot 3 的自动配置特性,无需编写复杂的配置即可使用 Quartz
  • 灵活管理:支持任务的动态添加、暂停、恢复和删除。
  • 扩展性:可以轻松扩展任务调度系统,便于业务逻辑的复杂应用。

Quartz__21">3. Spring Boot 3 集成 Quartz 的步骤

3.1 创建 Spring Boot 项目

可以使用 Spring Initializr 创建项目,选择以下依赖:

image-20241113205514778

Quartz__32">3.2 添加 Quartz 依赖

如果使用的是手动创建的项目,可以在 pom.xml 中添加 Quartz 的依赖:

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

Quartz__49">3.3 配置 Quartz 属性

application.ymlapplication.properties 文件中配置 Quartz 的基本属性,例如任务存储和调度方式。

以下是 application.yml 配置示例:

spring:application:name: spring-boot3-19-quartzquartz:job-store-type: memory  # 储类型为内存存储properties:org:quartz:threadPool:threadCount: 5  # 配置线程池线程数为 5jobStore:misfireThreshold: 60000  # 设置作业存储的错过触发阈值为 60000 毫秒(1分钟)

这里使用了内存存储方式(job-store-type: memory),也可以根据需要配置数据库存储任务信息。

Quartz__72">3.4 创建一个 Quartz 任务类

创建一个简单的 Quartz 任务类,需要实现 Job 接口,并重写 execute 方法:

java">import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;@Component
public class SampleJob implements Job {private static final Logger logger = LoggerFactory.getLogger(SampleJob.class);@Overridepublic void execute(JobExecutionContext context) throws JobExecutionException {logger.info("Executing Sample Job at: " + context.getFireTime());}
}

3.5 配置任务调度器

在 Spring Boot 3 中,可以通过 @Configuration 创建 Quartz 的调度器,并配置定时任务的触发器(Trigger)和任务详情(JobDetail)。

java">import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class QuartzConfig {@Beanpublic JobDetail sampleJobDetail() {return JobBuilder.newJob(SampleJob.class).withIdentity("sampleJob").storeDurably().build();}@Beanpublic Trigger sampleJobTrigger() {SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(10)  // 每 10 秒执行一次.repeatForever();return TriggerBuilder.newTrigger().forJob(sampleJobDetail()).withIdentity("sampleJobTrigger").withSchedule(scheduleBuilder).build();}
}
  • sampleJobDetail 方法定义了任务的基本信息,包括任务类和名称。
  • sampleJobTrigger 方法定义了触发器的调度策略,这里设置为每 10 秒执行一次。

3.6 使用 Cron 表达式配置任务

除了简单的时间间隔,还可以通过 Cron 表达式实现更灵活的调度。以下示例展示如何使用 Cron 表达式配置任务触发器。

java">import org.quartz.CronScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;@Bean
public Trigger cronJobTrigger() {return TriggerBuilder.newTrigger().forJob(sampleJobDetail()).withIdentity("cronJobTrigger").withSchedule(CronScheduleBuilder.cronSchedule("0 0/1 * 1/1 * ? *"))  // 每分钟执行一次.build();
}

在这个例子中,Cron 表达式 "0 0/1 * 1/1 * ? *" 表示每分钟执行一次任务。

4. 运行应用并查看日志

配置完成后,启动 Spring Boot 应用。Quartz Scheduler 会按照配置执行 SampleJob 任务。您可以在控制台中看到日志输出,类似如下:

2024-11-13T21:07:39.910+08:00  INFO 11984 --- [spring-boot3-18-quartz] [eduler_Worker-4] c.coderjia.boot318quartz.job.SampleJob   : Executing Sample Job at: Wed Nov 13 21:07:39 CST 2024

每 10 秒执行一次效果:

每 10 秒执行一次

每分钟执行一次效果:

每分钟执行一次

Quartz__177">5. 动态管理 Quartz 任务

可以在代码中动态地添加、暂停、恢复和删除任务。例如,以下是动态添加任务的示例:

java">package com.coderjia.boot318quartz;import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.Trigger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;/*** @author CoderJia* @create 2024/11/13 下午 09:25* @Description**/
@Service
public class QuartzService {private final Scheduler scheduler;@Autowiredpublic QuartzService(Scheduler scheduler) {this.scheduler = scheduler;}public void scheduleJob(JobDetail jobDetail, Trigger trigger) {try {scheduler.scheduleJob(jobDetail, trigger);} catch (Exception e) {e.printStackTrace();}}public void pauseJob(String jobName, String jobGroup) {try {JobKey jobKey = new JobKey(jobName, jobGroup);scheduler.pauseJob(jobKey);System.out.println("Job paused: " + jobKey);} catch (SchedulerException e) {e.printStackTrace();}}public void resumeJob(String jobName, String jobGroup) {try {JobKey jobKey = new JobKey(jobName, jobGroup);scheduler.resumeJob(jobKey);System.out.println("Job resumed: " + jobKey);} catch (SchedulerException e) {e.printStackTrace();}}public void deleteJob(String jobName, String jobGroup) {try {JobKey jobKey = new JobKey(jobName, jobGroup);boolean deleted = scheduler.deleteJob(jobKey);if (deleted) {System.out.println("Job deleted: " + jobKey);} else {System.out.println("Job not found: " + jobKey);}} catch (SchedulerException e) {e.printStackTrace();}}
}

调用 scheduleJob 方法可以动态地添加新的任务。类似地,使用 scheduler.pauseJob()scheduler.deleteJob() 可以暂停或删除任务。

6. 总结

通过将 Quartz 与 Spring Boot 3 结合,我们可以实现强大而灵活的定时任务调度系统。本文介绍了 Quartz 的基本配置和使用方法,包括如何配置任务、触发器,以及使用 Cron 表达式实现复杂的调度策略。


http://www.ppmy.cn/server/142725.html

相关文章

【数据结构】11.哈夫曼树哈夫曼编码

一、哈夫曼树的基本概念 哈夫曼&#xff08;Huffman&#xff09;树又称最优树&#xff0c;是一类带权路径长度最短的树&#xff0c;在实际中有广泛的用途。 路径&#xff1a; 从树中一个节点到另一个节点之间的分支构成这两个节点之间的路径。路径长度&#xff1a; 路径上的分…

鸿蒙系统(HarmonyOS)与OpenHarmony

一、概述 华为推出的鸿蒙系统&#xff08;HarmonyOS&#xff09;凭借其分布式架构及多设备协同能力在业界引起了广泛关注。与此同时&#xff0c;还有一个名为OpenHarmony的开源项目&#xff0c;它在推动物联网设备之间的互联互通。尽管两者同源&#xff0c;但它们的应用场景、…

Stable Diffusion Hypernetwork Embedding

本节内容&#xff0c;给大家带来的是stable diffusion的Embedding与HyperNetwork课程。在上节课程中&#xff0c;我们已经了解了关于Lora模型和LyCORIS模型的使用。我们可以通过训练Lora模型与LyCORIS模型来对基础模型进行低资源微调&#xff0c;从而实现具有某一类特征的图像产…

什么是SSL VPN?其中的协议结构是怎样的?

定义&#xff1a;SSL VPN是以SSL协议为安全基础的VPN远程接入技术&#xff0c;移动办公人员使用SSL VPN可以安全、方便的接入企业内网&#xff0c;访问企业内网资源&#xff0c;提高工作效率。 SSL&#xff08;Security Socket Layer&#xff09;是一个安全协议&#xff0c;为…

macOS解决U盘装完系统容量变小的问题

发现原来256GB容量的U盘在mac电脑上只显示34GB&#xff0c;想起来之前用该U盘装过系统&#xff0c;最终搜到了以下解决方案&#xff0c;在此记录&#xff1a; (1) 查看盘符列表&#xff0c;找到需要格式化的U盘&#xff0c;假设为disk4 diskutil list(2) 卸载分区disk4 disk…

计算机毕业设计Hadoop+Spark高考推荐系统 高考分数线预测 知识图谱 高考数据分析可视化 高考大数据 大数据毕业设计 Hadoop 深度学习

温馨提示&#xff1a;文末有 CSDN 平台官方提供的学长联系方式的名片&#xff01; 温馨提示&#xff1a;文末有 CSDN 平台官方提供的学长联系方式的名片&#xff01; 温馨提示&#xff1a;文末有 CSDN 平台官方提供的学长联系方式的名片&#xff01; 作者简介&#xff1a;Java领…

SQL面试题——抖音SQL面试题 最大在线用户数

最大在线用户数 下面的数据记录了一个直播平台上用户进入平台和离开平台的情况 +---+-------------------+-----+ | id| etime| type| +---+-------------------+-----+ | 1|2021-06-10 10:00:00|enter| | 1|2021-06-10 19:00:00|leave| | 2|2021-06-10 11:0…

Uniapp 引入 Android aar 包 和 Android 离线打包

需求&#xff1a; 原生安卓 apk 要求嵌入到 uniapp 中&#xff0c;并通过 uniapp 前端调起 app 的相关组件。 下面手把手教你&#xff0c;从 apk 到 aar&#xff0c;以及打包冲突到如何运行&#xff0c;期间我所遇到的问题都会 一 一 进行说明&#xff0c;相关版本以我文章内为…