定时任务调动框架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。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
让树莓派智能语音助手实现定时提醒功能

让树莓派智能语音助手实现定时提醒功能

最初的时候是想直接在rasa 的chatbot上实现，因为rasa本身是带有remindschedule模块的。不过经过一番折腾后，忽然发现，chatbot上实现的定时，语音助手不一定会有响应。因为，我目前语音助手的代码设置了长时间无应答会结束对话，这样一来，chatbot定时提醒的触发就不会被语音助手获悉。那怎么让语音助手也具有定时提醒功能呢？ 我最后选择的方法是用threading.Time
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2