定时任务调动框架Quartz+SpringBoot集成

2024-03-01 02:28
文章标签 java springboot spring 框架 集成 quartz 定时 任务 调动

本文主要是介绍定时任务调动框架Quartz+SpringBoot集成，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Quartz 是一个基于 Java 的广泛使用的开源的任务调度框架

官网：
http://www.quartz-scheduler.org/

源码：
https://github.com/quartz-scheduler/quartz

整个 Quartz 的代码流程基本基本如下：

1、首先需要创建我们的任务(Job)，比如取消订单、定时发送短信邮件之类的，这是我们的任务主体，也是写业务逻辑的地方

2、创建任务调度器(Scheduler)，这是用来调度任务的,主要用于启动、停止、暂停、恢复等操作，也就是那几个api的用法

3、创建任务明细(JobDetail)，最开始我们编写好任务(Job)后，只是写好业务代码，并没有触发，这里需要用JobDetail来和之前创建的任务(Job)关联起来，便于执行。

4、创建触发器(Trigger)，触发器是来定义任务的规则的，比如几点执行，几点结束，几分钟执行一次等等。这里触发器主要有两大类(SimpleTrigger和CronTrigger)

5、根据Scheduler来启动JobDetail与Trigger

一、依赖：

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

二、创建Job

JobExecutionContext来获取JobDetail或者Trigger传入的参数进行处理

/**例如任务的执行时间过长，而每次触发的时间间隔太短，则会导致任务会被并发执行。如果是并发执行，就需要一个数据库锁去避免一个数据被多次处理。
*/
@DisallowConcurrentExecution//Job中的任务有可能并发执行。
public class TestJob implements Job{@Overridepublic void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {System.err.println(jobExecutionContext.getJobDetail().getJobDataMap().get("name"));System.err.println(jobExecutionContext.getJobDetail().getJobDataMap().get("age"));System.err.println(jobExecutionContext.getTrigger().getJobDataMap().get("orderNo"));System.err.println("定时任务执行，当前时间："+ DateUtil.formatDateTime(new Date()));}
}

三、创建任务调度器(Scheduler)

Spring IOC，所以直接注入完事。如果是普通的，则需通过工厂创建

①、工厂：

SchedulerFactory schedulerFactory = new StdSchedulerFactory();
Scheduler scheduler = schedulerFactory.getScheduler();

②、IOC：

@Autowired
private Scheduler scheduler;

四、创建任务明细

/**通过JobBuilder.newJob()方法获取到当前Job的具体实现(以下均为链式调用)* 这里是固定Job创建，所以代码写死XXX.class* 如果是动态的，根据不同的类来创建Job，则 ((Job)Class.forName("com.zy.job.TestJob").newInstance()).getClass()* 即是 JobBuilder.newJob(((Job)Class.forName("com.zy.job.TestJob").newInstance()).getClass())*/
JobDetail jobDetail = JobBuilder.newJob(TestJob.class)//获取当前Job具体实现.usingJobData("name","jordan").usingJobData("age",23).withIdentity("我是name","我是group")//添加认证信息（有3种重写方式）.build();

五、创建触发器

主要分为两大类SimpleTrigger、CronTrigger

  • SimpleTrigger：是根据它自带的api方法设置规则，比如每隔5秒执行一次、每隔1小时执行一次
  • CronTrigger：这就比较常用了，是基于Cron表达式来实现的
Trigger trigger = TriggerBuilder.newTrigger().usgingJobData("orderNo","1234").withIdentity("我是name","我是group")//.startNow 立即生效.startAt(start) //开始执行时间.endAt(start)//结束执行时间.withSchedule( //添加执行规则，SimpleTrigger、CronTrigger的区别主要就在这里SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(3)//每隔3s执行一次,api方法有好多规则自行查看.repeatForever()//一直执行,如果不写,定时任务就执行一次).build();//执行

CronTrigger trigger = TriggerBuilder.newTrigger().usingJobData("orderNo","1234").withIdentity("我是name","我是group")/**立即生效*/
//      .startNow()/**开始执行时间*/.startAt(start)/**结束执行时间,不写永久执行*/.endAt(start).withSchedule(CronScheduleBuilder.cronSchedule("0 0/2 * * * ?")).build();

【.startNow( )和.startAt( )这里有个坑，这两个方法是对同一个成员变量进行修改的 也就是说startAt和startNow同时调用的时候任务开始的时间是按后面调用的方法为主的，谁写在后面用谁】

六、启动任务

/**添加定时任务*/
scheduler.scheduleJob(jobDetail, trigger);
if (!scheduler.isShutdown()) {/**启动*/scheduler.start();
}

以上，任务的创建启动都完事了，后面就是任务的暂停、恢复、删除。比较简单，大致原理就是我们在创建任务明细(JobDetail)和创建触发器(Trigger)时，会调用.withIdentity(key,group)来传入认证信息，后续就是根据这些认证信息来管理任务(通过api方法)

七、任务暂停

scheduler.pauseTrigger(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));

八、任务的恢复

scheduler.resumeTrigger(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));

在这里插入图片描述
根据方法来获取

九、任务的删除

scheduler.pauseTrigger(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));//暂停触发器
scheduler.unscheduleJob(TriggerKey.triggerKey("我是刚才写的name","我是刚才写的group"));//移除触发器
scheduler.deleteJob(JobKey.jobKey("我是刚才写的name","我是刚才写的group"));//删除Job

如果想让定时任务在启动项目后自动启动，则需要持久化任务，可以把基本信息保存在数据库，项目启动时启动完，或者做分布式任务

 @Autowiredprivate Scheduler scheduler;@PostMapping("/Quartz")@ApiOperation(value = "定时任务_创建", notes = "创建")@ResponseBodypublic Object quartz(@RequestParam("orderNo")  String orderNo) throws Exception {Date start=new Date(System.currentTimeMillis() + 7 * 1000);//当前时间7秒之后/**通过JobBuilder.newJob()方法获取到当前Job的具体实现(以下均为链式调用)* 这里是固定Job创建，所以代码写死XXX.class* 如果是动态的，根据不同的类来创建Job，则 ((Job)Class.forName("com.zy.job.TestJob").newInstance()).getClass()* 即是 JobBuilder.newJob(((Job)Class.forName("com.zy.job.TestJob").newInstance()).getClass())* */JobDetail jobDetail = JobBuilder.newJob(TestJob.class)/**给当前JobDetail添加参数，K V形式*/.usingJobData("name","zy")/**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getJobDetail().getJobDataMap().get("age")获取值*/.usingJobData("age",23)/**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/.withIdentity(orderNo).build();//执行Trigger trigger = TriggerBuilder.newTrigger()/**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getTrigger().getJobDataMap().get("orderNo")获取值*/.usingJobData("orderNo", orderNo)/**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/.withIdentity(orderNo)/**立即生效*/
//      .startNow()/**开始执行时间*/.startAt(start)/**结束执行时间*/
//        .endAt(start)/**添加执行规则，SimpleTrigger、CronTrigger的区别主要就在这里*/.withSchedule(SimpleScheduleBuilder.simpleSchedule()/**每隔1s执行一次*/.withIntervalInSeconds(3)/**一直执行，*/.repeatForever()).build();//执行//CronTrigger  trigger = TriggerBuilder.newTrigger()
//        /**给当前JobDetail添加参数，K V形式，链式调用，可以传入多个参数，在Job实现类中，可以通过jobExecutionContext.getTrigger().getJobDataMap().get("orderNo")获取值*/
//        .usingJobData("orderNo", orderNo)
//        /**添加认证信息，有3种重写的方法，我这里是其中一种，可以查看源码看其余2种*/
//        .withIdentity(orderNo)
//        /**开始执行时间*/
//        .startAt(start)
//        /**结束执行时间*/
//        .endAt(start)
//        /**添加执行规则，SimpleTrigger、CronTrigger的区别主要就在这里*/
//        .withSchedule(CronScheduleBuilder.cronSchedule("* 30 10 ? * 1/5 2018"))
//        .build();//执行/**添加定时任务*/scheduler.scheduleJob(jobDetail, trigger);if (!scheduler.isShutdown()) {/**启动*/scheduler.start();}System.err.println("--------定时任务启动成功 "+new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())+" ------------");return "ok";}@PostMapping("/shutdown")@ApiOperation(value = "定时任务_停止", notes = "停止")@ResponseBodypublic Object shutdown(@RequestParam("orderNo")  String orderNo) throws IOException, SchedulerException {scheduler.pauseTrigger(TriggerKey.triggerKey(orderNo));//暂停Triggerreturn "";}@PostMapping("/resume")@ApiOperation(value = "定时任务_恢复", notes = "恢复")@ResponseBodypublic Object resume(@RequestParam("orderNo")  String orderNo) throws IOException, SchedulerException {scheduler.resumeTrigger(TriggerKey.triggerKey(orderNo));//恢复Triggerreturn "ok";}@PostMapping("/del")@ApiOperation(value = "定时任务_删除", notes = "删除")@ResponseBodypublic Object del(@RequestParam("orderNo")  String orderNo) throws IOException, SchedulerException {scheduler.pauseTrigger(TriggerKey.triggerKey(orderNo));//暂停触发器scheduler.unscheduleJob(TriggerKey.triggerKey(orderNo));//移除触发器scheduler.deleteJob(JobKey.jobKey(orderNo));//删除Jobreturn "ok";}

这篇关于定时任务调动框架Quartz+SpringBoot集成的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/760896。

相关文章

Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
Java中Redisson 的原理深度解析

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、
阅读更多...
SpringBoot基于注解实现数据库字段回填的完整方案

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代
阅读更多...
一篇文章彻底搞懂macOS如何决定java环境

一篇文章彻底搞懂macOS如何决定java环境

《一篇文章彻底搞懂macOS如何决定java环境》MacOS作为一个功能强大的操作系统,为开发者提供了丰富的开发工具和框架,下面：本文主要介绍macOS如何决定java环境的相关资料,文中通过代码... 目录方法一：使用 which命令方法二：使用 Java_home工具（Apple 官方推荐）那问题来了，
阅读更多...
Java HashMap的底层实现原理深度解析

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述：HashMap的宏观结构二、核心数据结构解析1. 数组（桶数组）2. 链表节点（Node
阅读更多...
Java AOP面向切面编程的概念和实现方式

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点（如日志、事务）与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么？二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关
阅读更多...
详解SpringBoot+Ehcache使用示例

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储：配置灵活性：编码示例引入依赖：配置ehcache.XML文件：配置
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
Java中的.close()举例详解

Java中的.close()举例详解

《Java中的.close()举例详解》.close()方法只适用于通过window.open()打开的弹出窗口,对于浏览器的主窗口,如果没有得到用户允许是不能关闭的,：本文主要介绍Java中的.... 目录当你遇到以下三种情况时，一定要记得使用 .close()：用法作用举例如何判断代码中的 input
阅读更多...
Spring Gateway动态路由实现方案

Spring Gateway动态路由实现方案

《SpringGateway动态路由实现方案》本文主要介绍了SpringGateway动态路由实现方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随... 目录前沿何为路由RouteDefinitionRouteLocator工作流程动态路由实现尾巴前沿S
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2