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

文章目录

  • 前言
  • 一、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();

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

2024年跨境电商大热门:哪个平台最具赚钱潜力?!

2024年&#xff0c;哪个跨境电商平台好做&#xff0c;这取决于多种因素&#xff0c;如平台的知名度、流量、用户基础、市场定位、费用结构以及个人或企业的具体需求和资源。以下是一些近期比较热门&#xff0c;表现突出的跨境电商平台&#xff0c;但请注意&#xff0c;每个平台…

数据库系统概论(超详解!!!) 第四节 关系数据库标准语言SQL(Ⅰ)

1.SQL概述 SQL&#xff08;Structured Query Language&#xff09;结构化查询语言&#xff0c;是关系数据库的标准语言 SQL是一个通用的、功能极强的关系数据库语言 SQL的动词 基本概念 基本表 &#xff1a;本身独立存在的表&#xff1b; SQL中一个关系就对应一个基本表&am…

分享最有效脱单方法【单身狗必看】

用这个方法找不到对象我倒立 ! 发送内容: "脱单神器", 实现今年脱单

# termux连接云服务器

连接服务器 ssh nameip termux使用 pkg install openssh

Java Swing游戏开发学习14

内容来自RyiSnow视频讲解 前言 这一节讲的是Custom Font定制字体&#xff0c;就是在游戏中显示文字的地方&#xff0c;使用特定的ttf字体文件进行文字显示&#xff0c;提升游戏体验。如果觉得arial字体可以接受&#xff0c;这一节可以跳过&#xff0c;或者认为它太普通&#…

Linux离线安装Docker-Oracle_11g

拉取oracle11g镜像 docker pull registry.cn-hangzhou.aliyuncs.com/helowin/oracle_11g创建11g容器 docker run -d -p 1521:1521 --name oracle11g registry.cn-hangzhou.aliyuncs.com/helowin/oracle_11g查看容器是否创建成功 docker ps -a导出oracle容器&#xff0c;查看…

HarmonyOS入门学习

HarmonyOS入门学习 前言快速入门ArkTS组件基础组件Image组件Text组件TextInput 文本输入框Buttonslider 滑动组件 页面布局循环控制ForEach循环创建组件 List自定义组件创建自定义组件Builder 自定义函数 状态管理Prop和LinkProvide和ConsumeObjectLink和Observed ArkUI页面路由…

MCU技术的创新浪潮与产业变革

MCU技术的创新浪潮与产业变革 一、MCU技术的创新发展 MCU&#xff0c;即微控制器&#xff0c;作为现代电子设备的核心部件&#xff0c;一直在不断地创新与发展。随着科技的进步&#xff0c;MCU的性能得到了极大的提升&#xff0c;功能也越来越丰富。从8位到32位&#xff0c;再…

OpenCV4.9.0在Android 开发简介

查看&#xff1a;OpenCV系列文章目录&#xff08;持续更新中......&#xff09; 上一篇&#xff1a;使用 Clojure 进行 OpenCV 开发简介 下一篇&#xff1a;暂无 引言&#xff1a; OpenCV是一个跨平台计算机视觉库&#xff0c;广泛用于图像处理、计算机视觉和机器学习等领域…

TinyEMU源码分析之虚拟机初始化

TinyEMU源码分析之虚拟机初始化 1 初始化结构参数2 配置RAM地址空间3 初始化设备4 拷贝BIOS和Kernel5 手动写入5条指令6 体验第一条指令的执行 本文属于《 TinyEMU模拟器基础系列教程》之一&#xff0c;欢迎查看其它文章。 本文中使用的代码&#xff0c;均为伪代码&#xff0c…

Java 面向对象编程进阶七(字符串 String )

目录 字符串 String String 基础 String 类和常量池 String 类常用的方法 String 类常用方法一 String 类常用方法二 字符串相等的判断 字符串 String String 是我们开发中最常用的类&#xff0c;我们不仅要掌握 String 类常见的方法&#xff0c;对于 String 的 底层实现…

Vue.js+SpringBoot开发智能教学资源库系统

目录 一、摘要1.1 项目介绍1.2 项目录屏 二、功能模块2.1 数据中心模块2.2 课程档案模块2.3 课程资源模块2.4 课程作业模块2.5 课程评价模块 三、系统设计3.1 用例设计3.2 数据库设计3.2.1 课程档案表3.2.2 课程资源表3.2.3 课程作业表3.2.4 课程评价表 四、系统展示五、核心代…

多进程数据库不适合作为hive的元数据库

简介 “今天发现一个比较奇怪的现象&#xff0c;因为博主不熟悉mysql&#xff0c;所以在安装hive的使用了postgresql作为hive的元数据库&#xff0c;在测试几个连接工具对hive进行链接&#xff0c;后面再测试的时候发现链接不上了&#xff0c;并且报错日志如下&#xff1a;” …

【记录39】html element-ui 加载

环境 html使用element-ui组件、用vue框架搭建 方法一&#xff1a; 方法二&#xff08;推荐&#xff09; 将相关资源下载下来&#xff0c;在对应的html文件中相对路径引入。注意&#xff1a;css加载放在js之前

导航栏还是侧栏?flutter 跨平台适配指南

介绍 引言&#xff1a;Flutter 的跨平台特性 Flutter 是由 Google 开发的一款跨平台应用开发框架&#xff0c;它具有许多优点&#xff0c;包括性能优异、开发效率高以及良好的用户体验等。其中&#xff0c;最引人注目的特性之一就是其出色的跨平台能力。通过编写一套代码&…

数学建模(熵权法 python代码 例子)

目录 介绍&#xff1a; 模板&#xff1a; 例子&#xff1a;择偶 极小型指标转化为极大型&#xff08;正向化&#xff09;&#xff1a; 中间型指标转为极大型&#xff08;正向化&#xff09;&#xff1a; 区间型指标转为极大型&#xff08;正向化&#xff09;&#xff1a…

电脑设备管理器在哪?这里有详细指南!

电脑设备管理器是Windows操作系统中一个重要的工具&#xff0c;它允许用户查看和管理计算机中的硬件设备。无论是查找设备驱动程序、识别硬件问题还是管理设备属性&#xff0c;设备管理器都是一个不可或缺的工具。在本文中&#xff0c;我们将介绍三种常见的方法&#xff0c;以分…

Docker容器化技术(docker-compose安装部署案例)

docker-compose编排工具 安装docker-compose [rootservice ~]# systemctl stop firewalld [rootservice ~]# setenforce 0 [rootservice ~]# systemctl start docker[rootservice ~]# wget https://github.com/docker/compose/releases/download/v2.5.0/docker-compose-linux-…

Python——pgzero游戏打包exe执行时报错

Python——pgzero游戏打包exe执行时报错 记录一次使用 pgzero 开发游戏&#xff0c;使用 pyinstaller 打包时报错 目录结构&#xff1a; 1. 第一次报错 打包指令&#xff1a; pyinstaller -Fw .\code.py结果打开报错 报错如下&#xff1a; Traceback (most recent call…

【机器学习300问】39、高斯分布模型如何实现异常检测?

一、异常检测是什么&#xff1f; &#xff08;1&#xff09;举几个例子 ① 信用卡交易异常检测 在信用卡交易数据分析中&#xff0c;如果某个用户的消费习惯通常是小额且本地化消费&#xff0c;那么突然出现一笔大额且跨国的交易就可能被标记为异常。 ② 电机温度异常检测 在电…