SpringBoot项目通过触发器调度实现定时任务

news2024/12/30 3:19:21

文章目录

  • 前言
  • 一、quartz是什么？
  • 二、quartz中核心概念
  • 三、集成步骤
    • 1.引入依赖
    • 2.demo样例
      • a.定义一个任务参数实体类
      • b.定义操作触发器、定时任务接口及实现
      • c.作业实现
      • d.结果截图
  • 四、其他
      • 1.QuartzJobBean和Job区别
      • 2.注意事项
      • 3.作业（Job）和触发器（Trigger）参数解析
        • a.JobDetail 参数解析
        • a.Trigger 参数解析

前言

项目中可能会遇到一些需要定时同步数据的业务场景，比如从多个数据库汇总数据形成结果，可以使用数据自带的定时任务去执行存储过程实现，也可以通过集成quartz来实现，

一、quartz是什么？

1、Quartz是一个功能强大且灵活的开源任务调度库，用于在Java应用程序中实现定时任务和作业调度。它允许你根据特定的时间表（比如每天凌晨执行一次，或者每隔一段时间执行一次）来调度任务的执行。Quartz提供了丰富的功能，包括支持CRON表达式、作业持久化、集群环境下的分布式调度、监听器支持等。
2、通过Quartz，可以创建各种类型的作业，例如简单作业（只需要执行一次）、重复作业（按照指定的时间间隔重复执行）、以及基于CRON表达式的作业（按照指定的时间规则执行）。

二、quartz中核心概念

1、任务 Job： Job 就是你想要实现的任务类，每一个 Job 必须实现org.quartz.job 接口，且只需实现接口定义的execute() 方法。
2、触发器 Trigger： Trigger 为你执行任务的触发器，Trigger将会设置3点执行该任务。 Trigger主要包含两种 SimplerTrigger 和 CronTrigger 两种。
3、调度器 Scheduler： Scheduler 为任务的调度器，它会将任务 Job 及触发器 Trigger 整合起来，负责基于Trigger 设定的时间来执行 Job。

三、集成步骤

1.引入依赖

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

2.demo样例

a.定义一个任务参数实体类

@Data
public class QuartzJobInfo {

    private String type;

    private Map<String, Object> params;

    private String jobName;

    private String cronj;

    private String orderId;
}

b.定义操作触发器、定时任务接口及实现

  1. 接口类
public interface IQuartzService {

    //1.添加定时任务
    void addTrigger(QuartzJobInfo jobInfo);

    //2.移除定时任务id
    void delTrigger(Long id);
    }
  1. 接口实现类
@Service
public class QuartzServiceImpl implements IQuartzService {

    @Autowired
    private SchedulerFactoryBean factoryBean;

    @Override
    public void addTrigger(QuartzJobInfo jobInfo) {
        //jobInfo转换为json
        String info = JSONObject.toJSONString(jobInfo);
        //获取调度器
        Scheduler scheduler = factoryBean.getScheduler();
        //调用 工具类设置定时任务
        QuartzUtils.addJob(scheduler, jobInfo.getJobName(), OrderJob.class, info, jobInfo.getCronj());
    }

    @Override
    public void delTrigger(Long id) {
        //获取Job的名字
        String jobName = "product_job" + id;
        //获取调度器
        Scheduler scheduler = factoryBean.getScheduler();
        QuartzUtils.removeJob(scheduler, jobName);
    }
    }
  1. 工具类
/**
 * Quartz调度管理器
 */
public class QuartzUtils {
    private static String JOB_GROUP_NAME = "JOB_GROUP_SYSTEM";
    private static String TRIGGER_GROUP_NAME = "TRIGGER_GROUP_SYSTEM";

    /**
     * @param sched   调度器
     * @param jobName 任务名
     * @param cls     任务
     * @param params  任务参数
     * @param time    时间设置，参考quartz说明文档
     * @Description: 添加一个定时任务，使用默认的任务组名，触发器名，触发器组名
     * @Title: QuartzManager.java
     */
    public static void addJob(Scheduler sched, String jobName, @SuppressWarnings("rawtypes") Class cls, Object params,
                              String time) {
        try {
            JobKey jobKey = new JobKey(jobName, JOB_GROUP_NAME);// 任务名，任务组，任务执行类
            @SuppressWarnings("unchecked")

            JobDataMap jobDataMap = new JobDataMap();
            jobDataMap.put("params", params);
            JobDetail jobDetail = newJob(cls).withIdentity(jobKey).setJobData(jobDataMap).build();
            TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);// 触发器
            System.out.println(time);
            Trigger trigger = newTrigger().withIdentity(triggerKey).withSchedule(cronSchedule(time)).build();// 触发器时间设定
            sched.scheduleJob(jobDetail, trigger);
            if (!sched.isShutdown()) {
                sched.start();// 启动
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched            调度器
     * @param jobName          任务名
     * @param jobGroupName     任务组名
     * @param triggerName      触发器名
     * @param triggerGroupName 触发器组名
     * @param jobClass         任务
     * @param params           任务参数
     * @param time             时间设置，参考quartz说明文档
     * @Description: 添加一个定时任务
     * @Title: QuartzManager.java
     */
    public static void addJob(Scheduler sched, String jobName, String jobGroupName, String triggerName,
                              String triggerGroupName, @SuppressWarnings("rawtypes") Class jobClass, Object params, String time) {
        try {
            JobKey jobKey = new JobKey(jobName, jobGroupName);
            JobDataMap jobDataMap = new JobDataMap();
            jobDataMap.put("params", params);
            @SuppressWarnings("unchecked")
            JobDetail jobDetail = newJob(jobClass).withIdentity(jobKey).setJobData(jobDataMap).build();
            // 触发器
            TriggerKey triggerKey = new TriggerKey(triggerName, triggerGroupName);
            Trigger trigger = newTrigger().withIdentity(triggerKey).withSchedule(cronSchedule(time)).build();
            sched.scheduleJob(jobDetail, trigger);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched   调度器
     * @param jobName
     * @param time
     * @Description: 修改一个任务的触发时间(使用默认的任务组名 ， 触发器名 ， 触发器组名)
     * @Title: QuartzManager.java
     */
    @SuppressWarnings("rawtypes")
    public static void modifyJobTime(Scheduler sched, String jobName, String time) {
        try {
            TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);
            CronTrigger trigger = (CronTrigger) sched.getTrigger(triggerKey);
            if (trigger == null) {
                return;
            }
            String oldTime = trigger.getCronExpression();
            if (!oldTime.equalsIgnoreCase(time)) {
                JobKey jobKey = new JobKey(jobName, JOB_GROUP_NAME);
                JobDetail jobDetail = sched.getJobDetail(jobKey);
                Class objJobClass = jobDetail.getJobClass();
                Object params = jobDetail.getJobDataMap().get("params");
                removeJob(sched, jobName);
                System.out.println("修改任务：" + jobName);
                addJob(sched, jobName, objJobClass, params, time);
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched            调度器 *
     * @param sched            调度器
     * @param triggerName
     * @param triggerGroupName
     * @param time
     * @Description: 修改一个任务的触发时间
     * @Title: QuartzManager.java
     */
    public static void modifyJobTime(Scheduler sched, String triggerName, String triggerGroupName, String time) {
        try {
            TriggerKey triggerKey = new TriggerKey(triggerName, triggerGroupName);
            CronTrigger trigger = (CronTrigger) sched.getTrigger(triggerKey);
            if (trigger == null) {
                return;
            }
            String oldTime = trigger.getCronExpression();
            if (!oldTime.equalsIgnoreCase(time)) {
                // 修改时间
                trigger.getTriggerBuilder().withSchedule(cronSchedule(time));
                // 重启触发器
                sched.resumeTrigger(triggerKey);
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched   调度器
     * @param jobName
     * @Description: 移除一个任务(使用默认的任务组名 ， 触发器名 ， 触发器组名)
     * @Title: QuartzManager.java
     */
    public static void removeJob(Scheduler sched, String jobName) {
        try {
            TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);
            sched.pauseTrigger(triggerKey);// 停止触发器
            sched.unscheduleJob(triggerKey);// 移除触发器
            JobKey jobKey = new JobKey(jobName, JOB_GROUP_NAME);
            sched.deleteJob(jobKey);// 删除任务
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched            调度器
     * @param jobName
     * @param jobGroupName
     * @param triggerName
     * @param triggerGroupName
     * @Description: 移除一个任务
     * @Title: QuartzManager.java
     */
    public static void removeJob(Scheduler sched, String jobName, String jobGroupName, String triggerName,
                                 String triggerGroupName) {
        try {
            TriggerKey triggerKey = new TriggerKey(triggerName, triggerGroupName);
            sched.pauseTrigger(triggerKey);// 停止触发器
            sched.unscheduleJob(triggerKey);// 移除触发器
            JobKey jobKey = new JobKey(jobName, jobGroupName);
            sched.deleteJob(jobKey);// 删除任务
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched 调度器
     * @Description:启动所有定时任务
     * @Title: QuartzManager.java
     */
    public static void startJobs(Scheduler sched) {
        try {
            sched.start();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @param sched 调度器
     * @Description:关闭所有定时任务
     */
    public static void shutdownJobs(Scheduler sched) {
        try {
            if (!sched.isShutdown()) {
                sched.shutdown();
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}

c.作业实现

新增作业时，需要继承QuartzJobBean类，实现executeInternal方法。

@Component
public class OrderJob  extends QuartzJobBean implements CommandLineRunner {

    @Autowired
    IQuartzService iQuartzService;

    //遵循规范
    @Override
    public void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        String params = (String) jobExecutionContext.getJobDetail().getJobDataMap().get("params");
        QuartzJobInfo info = JSONObject.parseObject(params, QuartzJobInfo.class);
        String type = info.getType();
        Date now = new Date();
        switch (type) {
            case JobTypeConsts.WAIT_PRODUCT_ORDER_PAY_CANCEL_JOB:
                //执行逻辑1
                System.out.println("----------->>>>>>>>执行逻辑1,订单ID：" + info.getOrderId());
                break;
            case JobTypeConsts.WAIT_USERDEPOSIT_ORDER_PAY_CANCEL_JOB:
                //执行逻辑2
                System.out.println("----------->>>>>>>>执行逻辑2,订单ID：" + info.getOrderId());
                break;
            case JobTypeConsts.WAIT_REFUNDUSERDEPOSIT_ORDER_PAY_CANCEL_JOB:
                //执行逻辑3
                System.out.println("----------->>>>>>>>执行逻辑3,订单ID：" + info.getOrderId());
                break;
        }
    }
    @Override
    public void run(String... args) throws Exception {
        for (int i = 1; i < 4; i++) {
            QuartzJobInfo quartzJobInfo = new QuartzJobInfo();
            quartzJobInfo.setJobName("测试定时任务--->>>>." + i);
            quartzJobInfo.setCronj("0 0/1 * * * ?");
            quartzJobInfo.setType(String.valueOf(i));
            quartzJobInfo.setOrderId(String.valueOf(i));
            iQuartzService.addTrigger(quartzJobInfo);
        }
    }
}
  1. 实现CommandLineRunner接口的作用是，当项目启动时，会扫描到此接口，执行实现接口中的逻辑；
  2. 执行完run方法，然后根据Quartz 的调度触发机制，在适当的时间执行 execute 方法。

d.结果截图

0 0/1 * * * ?代表每分钟执行一次
在这里插入图片描述

四、其他

1.QuartzJobBean和Job区别

  1. 继承关系：QuartzJobBean 是一个 Spring 定制的 Quartz 作业类，是 Quartz 提供的 Job 接口的一个实现类。因此，QuartzJobBean 继承自 Spring 的 QuartzJobBean 类和实现了 Quartz 的 Job 接口。

  2. 扩展性：通过继承 QuartzJobBean 类，您可以利用 Spring 框架提供的依赖注入和生命周期管理等功能，更容易地将 Quartz 作业集成到 Spring 应用中。而直接实现 Quartz 的 Job 接口则是一种更传统的方式，不具备 Spring 相关的特性。

  3. 依赖注入：使用 QuartzJobBean 可以方便地利用 Spring 的依赖注入机制，从 Spring 容器中获取其他 Bean，并在作业中使用这些 Bean，例如使用使用@Autowired方式。而直接实现 Job 接口时，无法直接获得 Spring 托管的 Bean，需要手动从 Spring 上下文中获取。

  4. 配置方式：QuartzJobBean 更适合在 Spring 应用中使用，可以通过 Spring 的配置文件或注解的方式来配置和管理定时任务。而直接实现 Job 接口通常需要通过 Quartz 的配置文件或 API 来进行配置。

2.注意事项

  1. 调度作业在在继承QuartzJobBean类后，需要加@Component注解，确保Spring Boot 应用程序能正确扫描到。

3.作业（Job）和触发器（Trigger）参数解析

a.JobDetail 参数解析
  1. Job Class（作业类）：指定实现了Job接口的类，该类定义了要执行的作业逻辑。
  2. Job Name（作业名称）：作业的名称，用于在调度器中标识该作业。
  3. Job Group（作业组）：作业所属的分组，用于对作业进行分类管理。
  4. Job Data Map（作业数据）：可以传递一些作业执行时需要的数据，以键值对的形式存储在JobDataMap中。

例：

 JobDetail jobDetail = newJob(cls).withIdentity(jobKey).setJobData(jobDataMap).build();
a.Trigger 参数解析
  1. Trigger Name（触发器名称）：触发器的名称，用于在调度器中标识该触发器。
  2. Trigger Group（触发器组）：触发器所属的分组，用于对触发器进行分类管理。
  3. Trigger Start Time（触发器开始时间）：指定触发器首次触发的时间点。
  4. Trigger End Time（触发器结束时间）：可选参数，指定触发器的结束时间，超过该时间后触发器不再生效。
  5. Repeat Interval（重复间隔时间）：指定触发器重复执行的间隔时间。

例:

//创建触发器的唯一标识 TriggerKey 对象
 TriggerKey triggerKey = new TriggerKey(jobName, TRIGGER_GROUP_NAME);
//withSchedule() 方法用于设置触发器的调度规则
//cronSchedule(time) 表示使用 CRON 表达式来指定触发规则
//time 是一个表示 CRON 表达式的字符串，用于定义触发器的执行时间规则         
 Trigger trigger = newTrigger().withIdentity(triggerKey).withSchedule(cronSchedule(time)).build();

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1532047.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

考虑功率均分与电压频率的事件触发分布式二次控制MATLAB模型

考虑功率均分与电压频率的事件触发分布式二次控制MATLAB模型

微❤关注“电气仔推送”获得资料&#xff08;专享优惠&#xff09; 模型简介 此模型是在《基于事件触发机制的孤岛微电网二次电压与频率协同控制MATLAB仿真模型》上进一步创作的&#xff0c;之前的模型只考虑了二次电压与频率控制&#xff0c;并没有考虑均分这一项点。 因此…
阅读更多...
STM32相关资料汇总

STM32相关资料汇总

STM32选型表 STM32手册参考网站 https://www.stmcu.org.cn/
阅读更多...
文件包含漏洞之包含NGINX日志文件（常用）

文件包含漏洞之包含NGINX日志文件（常用）

条件&#xff1a;知道目标服务器的日志文件存贮路径&#xff0c;并且存在文件包含漏洞 首先对目标服务器发送一次含有木马的请求&#xff0c;目的是让目标服务器日志中生成含有木马的日志记录。因为发送过程中&#xff0c;使用了url编码&#xff0c;我们抓包进行更改成能够执行…
阅读更多...
网络——入门基础

网络——入门基础

目录 协议 网络协议 OSI七层模型 网络传输基本流程 网络传输流程图 局域网通信 数据包的封装和解包 广域网通信 网络地址管理 IP地址 MAC地址 协议 关于什么是局域网&#xff0c;什么是广域网&#xff0c;我这里就不过多赘述了&#xff0c;我们直接来谈一下什么…
阅读更多...
复旦发布层次性奖励学习框架，增强大模型人类偏好对齐

复旦发布层次性奖励学习框架，增强大模型人类偏好对齐

在人工智能领域&#xff0c;强化学习&#xff08;Reinforcement Learning, RL&#xff09;一直是实现智能体自主学习的关键技术之一。通过与环境的交互&#xff0c;智能体能够自我优化其行为策略&#xff0c;以获得更多的奖励。然而&#xff0c;当涉及到复杂的人类偏好时&#…
阅读更多...
codeforces 1600分

codeforces 1600分

文章目录 1.[G. Special Permutation](https://codeforces.com/problemset/problem/1352/G)2.[D. Constructing the Array](https://codeforces.com/problemset/problem/1353/D)3.[C2. k-LCM (hard version)](https://codeforces.com/problemset/problem/1497/C2)4.[C. Circle …
阅读更多...
【ollama】linux、window系统更改模型存放位置，全网首发2024！

【ollama】linux、window系统更改模型存放位置，全网首发2024！

首先是window系统 so easy 直接进入系统环境变量添加就行 其次是linux系统 全靠自己试出来的&#xff0c;去Ollama官网找半天文档不知道在哪&#xff0c;而且linux也没有说&#xff1a;【 https://github.com/ollama/ollama/blob/main/docs/README.md https://github.com/o…
阅读更多...
CSS Module

CSS Module

CSS Module的作用&#xff1a;将CSS样式作用域限制在特定的组件范围内&#xff0c;以避免全局样式污染和命名冲突。 Vue中如何实现样式模块…
阅读更多...
一款博客网站源码

一款博客网站源码

一款博客网站源码 源码软件库 为大家内置了主题 清爽又强大真正的永久可用的一条源码&#xff0c;该版本为整合版本&#xff0c;内置了Joe主题&#xff0c;搭建后直接启用即可~ 安装环境要求&#xff1a; PHP 7.2 以上 MySQL, PostgreSQL, SQLite 任意一种数据库支持&#xff…
阅读更多...
BUUCTF-WEB1

BUUCTF-WEB1

[ACTF2020 新生赛]Exec1 1.打开靶机 是一个ping命令 2.利用管道符“|” ping一下本地主机并查看ls ping 127.0.0.1 | ls 可以看到回显的内容是一个文件 127.0.0.1 | cat index.php #查看主机下index.php 127.0.0.1 | ls / #查看主机根目录下的文件 看的一个flag文件 …
阅读更多...
专升本 C语言 万字考点笔记全国通用

专升本 C语言 万字考点笔记全国通用

前言 全章内容多次校验整理,可以放心食用;如果发现内容有不严谨的地方,请随时私信张三xy 形而上学者谓之道&#xff0c;形而下学者谓之器 目录 前言 常考概念 一、C语言的基础知识 第一节、对C语言的基础认识 第二节、C语言程序生命周期 第三节、标识符 第四节、进制的转…
阅读更多...
帆软笔记整理

帆软笔记整理

一&#xff1a;表格值自定义显示 1、日期型格式化&#xff1a;FORMAT($$$,"MM月dd日") 或者&#xff1a; 2、普通值自定义显示&#xff1a;if($$$SW_1,丝网一号机,if($$$SW_2,丝网二号机,丝网三号机)) 或者&#xff1a; 二&#xff1a;从数据集中再次筛选&#…
阅读更多...
Wireshare捕获接口中没有本地连接

Wireshare捕获接口中没有本地连接

1. 查看npf服务是否启动 服务名无效&#xff0c;需要安转WinPcap 2. 勾选Npcap Packet Driver (NPCAP) 3. 重新启动Wireshark 重新启动Wireshark后&#xff0c;本地连接有了
阅读更多...
吴恩达机器学习-可选实验室：简单神经网络（Simple Neural Network）

吴恩达机器学习-可选实验室：简单神经网络（Simple Neural Network）

在这个实验室中&#xff0c;我们将使用Tensorflow构建一个小型神经网络 import numpy as np import matplotlib.pyplot as plt plt.style.use(./deeplearning.mplstyle) import tensorflow as tf from tensorflow.keras.models import Sequential from tensorflow.keras.laye…
阅读更多...
C++：继承：面向对象编程的重要特性

C++：继承：面向对象编程的重要特性

(❁◡❁)(●◡●)╰(*▽*)╯(*/ω&#xff3c;*)(^///^)(❁◡❁)(❁◡❁)(●◡●)╰(*▽*)╯(*/ω&#xff3c;*)(❁◡❁)(●’◡’●)╰(▽)╯(/ω&#xff3c;)(///) C&#xff1a;继承&#xff1a;面向对象编程的重要特性 前言**继承**1.继承的概念及定义1.1继承的概念1.2继…
阅读更多...
联合和枚举

联合和枚举

联合体类型的声明 联合体&#xff08;Union&#xff09;是一种特殊的数据类型&#xff0c;它允许在同一内存位置存储不同类型的数据。与结构体不同的是&#xff0c;联合体的所有成员共享同一块内存空间&#xff0c;因此联合体的大小取决于它最大的成员的大小。 所以联合体也叫…
阅读更多...
vue学习笔记27-组件生命周期⭐

vue学习笔记27-组件生命周期⭐

每个vue组件实例在创建时都需要经历一系列初始化步骤&#xff0c;比如设置好数据侦听&#xff0c;编译模板&#xff0c;挂载实列到DOM&#xff0c;以及在数据改变时更新DOM。在此过程中&#xff0c;它也会运行称为生命周期钩子的函数&#xff0c;让开发者有机会在特定阶段运行自…
阅读更多...
金融知识分享系列之：KD指标

金融知识分享系列之：KD指标

金融知识分享系列之&#xff1a;KD指标 一、KD指标二、KD指标计算三、KD指标原理四、KD指标应用 一、KD指标 KD信号提供入场的工具 名称&#xff1a;随机震荡指标参数&#xff1a;&#xff08;9,3,3&#xff09;组成&#xff1a;K线&#xff0c;D线&#xff0c;20轴&#xff0…
阅读更多...
因时夹爪urdf文件改写为xacro并搭配aubo_i5机械臂

因时夹爪urdf文件改写为xacro并搭配aubo_i5机械臂

因时夹爪urdf文件改写为xacro并搭配aubo_i5机械臂 一、因时夹爪内容二、改写为xacro模式三、aubo i5搭配因时夹爪 一、因时夹爪内容 因时夹爪型号&#xff1a;EG2-4C 夹爪的urdf文件内容&#xff1a; <robotname"jawasm1"><linkname"base_link"…
阅读更多...
PyCharm中设置代码模版

PyCharm中设置代码模版

前言 新创建一个.py文件后&#xff0c;我们总需要在开头写一些必要的代码&#xff0c;有什么方法能够一劳永逸&#xff0c;让这些代码自动生成呢&#xff1f; 有&#xff0c;它就是代码模版。 设置代码模版 这里先说说如何设置它。 步骤&#xff1a;首先打开PyCharm&#xff0…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023