c#quartz触发_SpringBoot集成Quartz实现定时任务

b358e9227fd6d266bec7d9b2af4e561e.png

1 需求

在我的前后端分离的实验室管理项目中,有一个功能是学生状态统计。我的设计是按天统计每种状态的比例。为了便于计算,在每天0点,系统需要将学生的状态重置,并插入一条数据作为一天的开始状态。另外,考虑到学生的请假需求,请假的申请往往是提前做好,等系统时间走到实际请假时间的时候,系统要将学生的状态修改为请假。

显然,这两个子需求都可以通过定时任务实现。在网上略做搜索以后,我选择了比较流行的定时任务框架Quartz。

2 Quartz

Quartz是一个定时任务框架,其他介绍网上也很详尽。这里要介绍一下Quartz里的几个非常核心的接口。

2.1 Scheduler接口

Scheduler翻译成调度器,Quartz通过调度器来注册、暂停、删除Trigger和JobDetail。Scheduler还拥有一个SchedulerContext,顾名思义就是上下文,通过SchedulerContext我们可以获取到触发器和任务的一些信息。

2.2 Trigger接口

Trigger可以翻译成触发器,通过cron表达式或是SimpleScheduleBuilder等类,指定任务执行的周期。系统时间走到触发器指定的时间的时候,触发器就会触发任务的执行。

2.3 JobDetail接口

Job接口是真正需要执行的任务。JobDetail接口相当于将Job接口包装了一下,Trigger和Scheduler实际用到的都是JobDetail。

3 SpringBoot官方文档解读

SpringBoot官方写了 spring-boot-starter-quartz 。使用过SpringBoot的同学都知道这是一个官方提供的启动器,有了这个启动器,集成的操作就会被大大简化。

现在我们来看一看SpingBoot2.2.6官方文档,其中第4.20小节 Quartz Scheduler 就谈到了Quartz,但很可惜一共只有两页不到的内容,先来看看这么精华的文档里能学到些什么。

Spring Boot offers several conveniences for working with the Quartz scheduler, including the
spring-boot-starter-quartz “Starter”. If Quartz is available, a Scheduler is auto-configured (through the SchedulerFactoryBean abstraction).
Beans of the following types are automatically picked up and associated with the Scheduler:
• JobDetail: defines a particular Job. JobDetail instances can be built with the JobBuilder API.
• Calendar.
• Trigger: defines when a particular job is triggered.

翻译一下:

SpringBoot提供了一些便捷的方法来和Quartz协同工作,这些方法里面包括`spring-boot-starter-quartz`这个启动器。如果Quartz可用,Scheduler会通过SchedulerFactoryBean这个工厂bean自动配置到SpringBoot里。
JobDetail、Calendar、Trigger这些类型的bean会被自动采集并关联到Scheduler上。
Jobs can define setters to inject data map properties. Regular beans can also be injected in a similar manner.

翻译一下:

Job可以定义setter(也就是set方法)来注入配置信息。也可以用同样的方法注入普通的bean。

下面是文档里给的示例代码,我直接完全照着写,拿到的却是null。不知道是不是我的使用方式有误。后来仔细一想,文档的意思应该是在创建Job对象之后,调用set方法将依赖注入进去。但后面我们是通过框架反射生成的Job对象,这样做反而会搞得更加复杂。最后还是决定采用给Job类加@Component注解的方法。

文档的其他篇幅就介绍了一些配置,但是介绍得也不全面,看了帮助也并不是很大。详细的配置可以参考w3school的 Quartz配置

4 SpringBoot集成Quartz

4.1 建表

我选择将定时任务的信息保存在数据库中,优点是显而易见的,定时任务不会因为系统的崩溃而丢失。

建表的sql语句在Quartz的github中可以找到,里面有针对每一种常用数据库的sql语句,具体地址是: Quartz数据库建表sql

6b5ed6139b37ac66de3231c8ada9f7d4.png

建表以后,可以看到数据库里多了11张表。我们完全不需要关心每张表的具体作用,在添加删除任务、触发器等的时候,Quartz框架会操作这些表。

4.2 引入依赖

pom.xml 里添加依赖。

<!-- quartz 定时任务 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-quartz</artifactId><version>2.2.6.RELEASE</version>
</dependency>

4.3 配置quartz

application.yml 中配置quartz。相关配置的作用已经写在注解上。

# spring的datasource等配置未贴出
spring:quartz:# 将任务等保存化到数据库job-store-type: jdbc# 程序结束时会等待quartz相关的内容结束wait-for-jobs-to-complete-on-shutdown: true# QuartzScheduler启动时更新己存在的Job,这样就不用每次修改targetObject后删除qrtz_job_details表对应记录overwrite-existing-jobs: true# 这里居然是个map,搞得智能提示都没有,佛了properties:org:quartz:# scheduler相关scheduler:# scheduler的实例名instanceName: schedulerinstanceId: AUTO# 持久化相关jobStore:class: org.quartz.impl.jdbcjobstore.JobStoreTXdriverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate# 表示数据库中相关表是QRTZ_开头的tablePrefix: QRTZ_useProperties: false# 线程池相关threadPool:class: org.quartz.simpl.SimpleThreadPool# 线程数threadCount: 10# 线程优先级threadPriority: 5threadsInheritContextClassLoaderOfInitializingThread: true

4.4 注册周期性的定时任务

第1节中提到的第一个子需求是在每天0点执行的,是一个周期性的任务,任务内容也是确定的,所以直接在代码里注册JobDetail和Trigger的bean就可以了。当然,这些JobDetail和Trigger也是会被持久化到数据库里。

/*** Quartz的相关配置,注册JobDetail和Trigger* 注意JobDetail和Trigger是org.quartz包下的,不是spring包下的,不要导入错误*/
@Configuration
public class QuartzConfig {@Beanpublic JobDetail jobDetail() {JobDetail jobDetail = JobBuilder.newJob(StartOfDayJob.class).withIdentity("start_of_day", "start_of_day").storeDurably().build();return jobDetail;}@Beanpublic Trigger trigger() {Trigger trigger = TriggerBuilder.newTrigger().forJob(jobDetail()).withIdentity("start_of_day", "start_of_day").startNow()// 每天0点执行.withSchedule(CronScheduleBuilder.cronSchedule("0 0 0 * * ?")).build();return trigger;}
}

builder类创建了一个JobDetail和一个Trigger并注册成为Spring bean。从第3节中摘录的官方文档中,我们已经知道这些bean会自动关联到调度器上。需要注意的是JobDetail和Trigger需要设置组名和自己的名字,用来作为唯一标识。当然,JobDetail和Trigger的唯一标识可以相同,因为他们是不同的类。

Trigger通过cron表达式指定了任务执行的周期。对cron表达式不熟悉的同学可以百度学习一下。

JobDetail里有一个StartOfDayJob类,这个类就是Job接口的一个实现类,里面定义了任务的具体内容,看一下代码:

@Component
public class StartOfDayJob extends QuartzJobBean {private StudentService studentService;@Autowiredpublic StartOfDayJob(StudentService studentService) {this.studentService = studentService;}@Overrideprotected void executeInternal(JobExecutionContext jobExecutionContext)throws JobExecutionException {// 任务的具体逻辑}
}

网上很多博客也是这么介绍的。但是根据我的实际测试,这样写可以完成依赖注入,但我还不知道它的实现原理。

198a773dda564641f142c7ebcbe0634d.png

e3040ace176d9682bf72aaf44214855d.png

4.5 注册无周期性的定时任务

第1节中提到的第二个子需求是学生请假,显然请假是不定时的,一次性的,而且不具有周期性。

4.5节与4.4节大体相同,但是有两点区别:

  • Job类需要获取到一些数据用于任务的执行;
  • 任务执行完成后删除Job和Trigger。

业务逻辑是在老师批准学生的请假申请时,向调度器添加Trigger和JobDetail。

实体类:

public class LeaveApplication {@TableId(type = IdType.AUTO)private Integer id;private Long proposerUsername;@JsonFormat( pattern = "yyyy-MM-dd HH:mm",timezone="GMT+8")private LocalDateTime startTime;@JsonFormat( pattern = "yyyy-MM-dd HH:mm",timezone="GMT+8")private LocalDateTime endTime;private String reason;private String state;private String disapprovedReason;private Long checkerUsername;private LocalDateTime checkTime;// 省略getter、setter
}

Service层逻辑,重要的地方已在注释中说明。

@Service
public class LeaveApplicationServiceImpl implements LeaveApplicationService {@Autowiredprivate Scheduler scheduler;// 省略其他方法与其他依赖/*** 添加job和trigger到scheduler*/private void addJobAndTrigger(LeaveApplication leaveApplication) {Long proposerUsername = leaveApplication.getProposerUsername();// 创建请假开始JobLocalDateTime startTime = leaveApplication.getStartTime();JobDetail startJobDetail = JobBuilder.newJob(LeaveStartJob.class)// 指定任务组名和任务名.withIdentity(leaveApplication.getStartTime().toString(),proposerUsername + "_start")// 添加一些参数,执行的时候用.usingJobData("username", proposerUsername).usingJobData("time", startTime.toString()).build();// 创建请假开始任务的触发器// 创建cron表达式指定任务执行的时间,由于请假时间是确定的,所以年月日时分秒都是确定的,这也符合任务只执行一次的要求。String startCron = String.format("%d %d %d %d %d ? %d",startTime.getSecond(),startTime.getMinute(),startTime.getHour(),startTime.getDayOfMonth(),startTime.getMonth().getValue(),startTime.getYear());CronTrigger startCronTrigger = TriggerBuilder.newTrigger()// 指定触发器组名和触发器名.withIdentity(leaveApplication.getStartTime().toString(),proposerUsername + "_start").withSchedule(CronScheduleBuilder.cronSchedule(startCron)).build();// 将job和trigger添加到scheduler里try {scheduler.scheduleJob(startJobDetail, startCronTrigger);} catch (SchedulerException e) {e.printStackTrace();throw new CustomizedException("添加请假任务失败");}}
}

Job类逻辑,重要的地方已在注释中说明。

@Component
public class LeaveStartJob extends QuartzJobBean {private Scheduler scheduler;private SystemUserMapperPlus systemUserMapperPlus;@Autowiredpublic LeaveStartJob(Scheduler scheduler,SystemUserMapperPlus systemUserMapperPlus) {this.scheduler = scheduler;this.systemUserMapperPlus = systemUserMapperPlus;}@Overrideprotected void executeInternal(JobExecutionContext jobExecutionContext)throws JobExecutionException {Trigger trigger = jobExecutionContext.getTrigger();JobDetail jobDetail = jobExecutionContext.getJobDetail();JobDataMap jobDataMap = jobDetail.getJobDataMap();// 将添加任务的时候存进去的数据拿出来long username = jobDataMap.getLongValue("username");LocalDateTime time = LocalDateTime.parse(jobDataMap.getString("time"));// 编写任务的逻辑// 执行之后删除任务try {// 暂停触发器的计时scheduler.pauseTrigger(trigger.getKey());// 移除触发器中的任务scheduler.unscheduleJob(trigger.getKey());// 删除任务scheduler.deleteJob(jobDetail.getKey());} catch (SchedulerException e) {e.printStackTrace();}}
}

5 总结

上文所述的内容应该可以满足绝大部分定时任务的需求。我在查阅网上的博客之后,发现大部分博客里介绍的Quartz使用还是停留在Spring阶段,配置也都是通过xml,因此我在实现了功能以后,将整个过程总结了一下,留给需要的人以及以后的自己做参考。

总体上来说,Quartz实现定时任务还是非常方便的,与SpringBoot整合之后配置也非常简单,是实现定时任务的不错的选择。

5.2 小坑1

在IDEA2020.1版本里使用SpringBoot与Quartz时,报错找不到org.quartz程序包,但是依赖里面明明有org.quartz,类里的import也没有报错,还可以通过Ctrl+鼠标左键直接跳转到相应的类里。后面我用了IDEA2019.3.4就不再有这个错误。那么就是新版IDEA的BUG了。

e403ef0d8513b14cac45a29cd7749448.png
本文由博客群发一文多发等运营工具平台 OpenWrite 发布
来源:https://www.tuicool.com/articles/zyQfmqV

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

ABP入门系列(10)——扩展AbpSession

一、AbpSession是Session吗&#xff1f; 1、首先来看看它们分别对应的类型是什么&#xff1f; 查看源码发现Session是定义在Controller中的类型为HttpSessionStateBase的属性。 public HttpSessionStateBase Session { get; set; } 再来看看AbpSession是何须类也&#xff0c…

太吾绘卷第一世攻略_耽美推文-BL-仿佛在攻略一只河豚

目录&#xff1a;《全能攻略游戏》by公子如兰《无限升级游戏》by暗夜公主《无限游戏》BY SISIMO《请听游戏的话》by木兮娘《游戏&#xff0c;在线直播》by雨田君《最强游戏制作人》by木兰竹《在逃生游戏里撩宿敌》by临钥《游戏加载中》by龙柒《狩猎游戏》by砯涯《当异性参加逃生…

ABP入门系列(11)——编写单元测试

1. 前言 In computer programming, unit testing is a software testing method by which individual units of source code, sets of one or more computer program modules together with associated control data, usage procedures, and operating procedures, are tested …

etl构建数据仓库五步法_带你了解数据仓库的基本架构

数据仓库的目的是构建面向分析的集成化数据环境&#xff0c;为企业提供决策支持&#xff08;Decision Support&#xff09;。其实数据仓库本身并不“生产”任何数据&#xff0c;同时自身也不需要“消费”任何的数据&#xff0c;数据来源于外部&#xff0c;并且开放给外部应用&a…

ABP入门系列(12)——如何升级Abp并调试源码

1. 升级Abp 本系列教程是基于Abp V1.0版本&#xff0c;现在Abp版本已经升级至V1.4.2&#xff0c;其中新增了New Feature&#xff0c;并对Abp做了相应的Enhancements&#xff0c;以及Bug fixs。现在我们就把它升级至最新版本&#xff0c;那如何升级呢&#xff1f; 下面就请按我…

聚类分析在用户行为中的实例_看完这篇,你还敢说不懂聚类分析?

点击上方蓝色字关注我们~大数据分析中的应用&#xff0c;最常用的经典算法之一就是聚类法&#xff0c;这是数据挖掘采用的起步技术&#xff0c;也是数据挖掘入门的一项关键技术。什么是聚类分析&#xff1f;聚类分析有什么用&#xff1f;聚类算法有哪些&#xff1f;聚类分析的应…

ABP入门系列(13)——Redis缓存用起来

1. 引言 创建任务时我们需要指定分配给谁&#xff0c;Demo中我们使用一个下拉列表用来显示当前系统的所有用户&#xff0c;以供用户选择。我们每创建一个任务时都要去数据库取一次用户列表&#xff0c;然后绑定到用户下拉列表显示。如果就单单对一个demo来说&#xff0c;这样实…

ABP入门系列(14)——应用BootstrapTable表格插件

1. 引言 之前的文章ABP入门系列&#xff08;7&#xff09;——分页实现讲解了如何进行分页展示&#xff0c;但其分页展示仅适用于前台web分页&#xff0c;在后台管理系统中并不适用。后台管理系统中的数据展示一般都是使用一些表格插件来完成的。这一节我们就使用BootstrapTab…

musictools怎么用不了_夏天少不了一只草编包,怎么搭配才不像“买菜用”?

要说有什么包包能跟夏天的气息一拍即合&#xff0c;那绝对非“草编包”莫属&#xff01;由藤条、柳条等编制而成的田园风“小篮子”&#xff0c;已经成了夏日街头小姐姐们的包包首选。各大品牌都争相推出草编包系列&#xff0c;在原有的浪漫度假风之外&#xff0c;添加了更多时…

ABP入门系列(15)——创建微信公众号模块

1. 引言 现在的互联网已不在仅仅局限于网页应用&#xff0c;IOS、Android、平板、智能家居等平台正如火如荼的迅速发展&#xff0c;移动应用的需求也空前旺盛。所有的互联网公司都不想错过这一次移动浪潮&#xff0c;布局移动市场分一份移动红利。 的确&#xff0c;智能手机作…

spark 算子例子_Spark性能调优方法

公众号后台回复关键词&#xff1a;pyspark&#xff0c;获取本项目github地址。Spark程序可以快如闪电⚡️&#xff0c;也可以慢如蜗牛?。它的性能取决于用户使用它的方式。一般来说&#xff0c;如果有可能&#xff0c;用户应当尽可能多地使用SparkSQL以取得更好的性能。主要原…

ABP入门系列(16)——通过webapi与系统进行交互

1. 引言 上一节我们讲解了如何创建微信公众号模块&#xff0c;这一节我们就继续跟进&#xff0c;来讲一讲公众号模块如何与系统进行交互。 微信公众号模块作为一个独立的web模块部署&#xff0c;要想与现有的【任务清单】进行交互&#xff0c;我们要想明白以下几个问题&#x…

python嵩天第二版第五章_如何避免从入门到放弃——python小组学习复盘

2019年春节python学习行动复盘2019-02-09为了主攻python&#xff0c;没有参加心理学晨读。对心理学也不敢兴趣&#xff0c;怕耽误学习python的时间。那么没学习心理学的情况下&#xff0c;python学的怎么样&#xff1f;是否达到自己的预期&#xff1f;一、预期目标&#xff1a;…

ABP入门系列(17)——使用ABP集成的邮件系统发送邮件

1.Abp集成的邮件模块是如何实现的 ABP中对邮件的封装主要集成在Abp.Net.Mail和Abp.Net.Mail.Smtp命名空间下&#xff0c;相应源码在此。 分析可以看出主要由以下几个核心类组成&#xff1a; EmailSettingNames&#xff1a;静态常量类&#xff0c;主要定义了发送邮件需要的相关…

cdn转发防攻击_高防CDN和高防服务器的区别?

越来越多的网络攻击需要处理&#xff0c;而高防CDN和高防服务器是很好的选择&#xff0c;那么如何选择呢&#xff1f;我们就来分析一下关于这两者之间的选择。首先从价格上看的话&#xff0c;高防御CDN的价格相对高一些&#xff0c;防御上看&#xff0c;高防御CDN的防御效果也更…

ABP入门系列(18)—— 使用领域服务

1.引言 自上次更新有一个多月了&#xff0c;发现越往下写&#xff0c;越不知如何去写。特别是当遇到DDD中一些概念术语的时候&#xff0c;尤其迷惑。如果只是简单的去介绍如何去使用ABP&#xff0c;我只需参照官方文档&#xff0c;实现到任务清单Demo中去就可以了&#xff0c;…

mysql文件类型_MyCat教程:实现MySql主从复制

原文&#xff1a;http://iii75.cn/mwQhBW 作者&#xff1a;波波烤鸭历史相关文章Mycat入门教程单个mysql数据库在处理业务的时候肯定是有限的&#xff0c;这时我们扩展数据库的第一种方式就是对数据库做读写分离(主从复制),本文我们就先来介绍下怎么来实现mysql的主从复制操作。…

截屏当前界面_电脑屏幕怎么截取,常见的几种电脑截屏方法

随着科技的快速发展电脑已经逐渐渗入到我们的工作和生活中&#xff0c;我们需要使用电脑的地方也越来越多&#xff0c;电脑已经成为了一种新式的办公工具。今天小编不是向大家介绍电脑的应用&#xff0c;而是想要和大家分享一下关于电脑截图的几种方法。1、Print Screen SysRqP…

ABP入门系列(19)——使用领域事件

1.引言 最近刚学习了下DDD中领域事件的理论知识&#xff0c;总的来说领域事件主要有两个作用&#xff0c;一是解耦&#xff0c;二是使用领域事件进行事务的拆分&#xff0c;通过引入事件存储&#xff0c;来实现数据的最终一致性。若想了解DDD中领域事件的概念&#xff0c;可参…

扩容是元素还是数组_Java中对数组的操作

数组对于每一门编程语言来说都是重要的数据结构之一&#xff0c;当然不同语言对于数组的实现及处理也不尽相同。Java语言中提供的数组是用来存储固定大小的同类型元素。如&#xff1a;声明一个数组变量&#xff0c;numbers[100]来代替直接声明100个独立变量number0,number1,...…