SpringBoot整合Quartz定时任务
原文:SpringBoot整合Quartz
1、Quartz介绍
1.1.简介
官方网站:http://quartz-scheduler.org/
Quartz 是 OpenSymphony 开源组织在 Job Scheduling 领域又一个开源项目,是完全由 Java 开发的一个开源任务日程管理系统,“任务进度管理器”就是一个在预先确定(被纳入日程)的时间到达时,负责执行(或者通知)其他软件组件的系统。Quartz 是一个开源的作业调度框架,它完全由 Java 写成,并设计用于 J2SE 和 J2EE 应用中,它提供了巨大的灵活性而不牺牲简单性。
当定时任务愈加复杂时,使用 Spring 注解 @Schedule 已经不能满足业务需要。
在项目开发中,经常需要定时任务来帮助我们来做一些内容,如定时派息、跑批对账、将任务纳入日程或者从日程中取消,开始,停止,暂停日程进度等。SpringBoot 中现在有两种方案可以选择,第一种是 SpringBoot 内置的方式简单注解就可以使用,当然如果需要更复杂的应用场景还是得 Quartz 上场,Quartz 目前是 Java 体系中最完善的定时方案。
1.2.优点
- 丰富的
Job 操作 API
- 支持多种配置
SpringBoot 无缝集成
- 支持持久化
- 支持集群
Quartz 还支持开源,是一个功能丰富的开源作业调度库,可以集成到几乎任何 Java 应用程序中
1.3. 核心概念
Scheduler
Quartz 中的任务调度器,通过 Trigger 和 JobDetail 可以用来调度、暂停和删除任务。调度器就相当于一个容器,装载着任务和触发器,该类是一个接口,代表一个 Quartz 的独立运行容器,Trigger 和 JobDetail 可以注册到 Scheduler 中,两者在 Scheduler 中拥有各自的组及名称,组及名称是 Scheduler 查找定位容器中某一对象的依据,Trigger 的组及名称必须唯一,JobDetail 的组和名称也必须唯一(但可以和 Trigger 的组和名称相同,因为它们是不同类型的);
Trigger
Quartz 中的触发器,是一个类,描述触发 Job 执行的时间触发规则,主要有 SimpleTrigger 和 CronTrigger 这两个子类。当且仅当需调度一次或者以固定时间间隔周期执行调度,SimpleTrigger 是最适合的选择;而 CronTrigger 则可以通过 Cron 表达式定义出各种复杂时间规则的调度方案:如工作日周一到周五的 15:00 ~ 16:00 执行调度等;
JobDetail
Quartz 中需要执行的任务详情,包括了任务的唯一标识和具体要执行的任务,可以通过 JobDataMap 往任务中传递数据;
Job
Quartz 中具体的任务,包含了执行任务的具体方法。是一个接口,只定义一个方法 execute() 方法,在实现接口的 execute() 方法中编写所需要定时执行的 Job;
当然可以这样快速理解:
- job: 任务 - 你要做什么事
- Trigger: 触发器 - 你什么时候去做
- Scheduler: 任务调度 - 你什么时候需要做什么事
四者其关系如下图所示

- Job 为作业的接口,为任务调度的对象;
- JobDetail 用来描述
Job 的实现类及其他相关的静态信息;
- Trigger 做为作业的定时管理工具,一个
Trigger 只能对应一个作业实例,而一个作业实例可对应多个触发器;
- Scheduler 做为定时任务容器,是
Quartz 最上层的东西,它提携了所有触发器和作业,使它们协调工作,每个 Scheduler 都存有 JobDetail 和 Trigger 的注册,一个 Scheduler 中可以注册多个 JobDetail 和多个 Trigger;
1.4.Quartz的作业存储类型
1.5.Cron表达式
Cron 表达式是一个字符串,包括6~7个时间元素,在 Quartz中可以用于指定任务的执行时间
1.5.1.Cron语法
| Seconds |
Minutes |
Hours |
DayofMonth |
Month |
DayofWeek |
| 秒 |
分钟 |
小时 |
日期天/日 |
日期月份 |
星期 |
1.5.2.Cron元素说明
| 时间元素 |
可出现的字符 |
有效数值范围 |
| Seconds |
, - * / |
0-59 |
| Minutes |
, - * / |
0-59 |
| Hours |
, - * / |
0-23 |
| DayofMonth |
, - * / ? L W |
0-31 |
| Month |
, - * / |
1-12 |
| DayofWeek |
, - * / ? L # |
1-7或SUN-SAT |
1.5.3. Cron字符说明
| 字符 |
作用 |
举例 |
| , |
列出枚举值 |
在Minutes域使用5,10,表示在5分和10分各触发一次 |
| - |
表示触发范围 |
在Minutes域使用5-10,表示从5分到10分钟每分钟触发一次 |
| * |
匹配任意值 |
在Minutes域使用*, 表示每分钟都会触发一次 |
| / |
起始时间开始触发,每隔固定时间触发一次 |
在Minutes域使用5/10,表示5分时触发一次,每10分钟再触发一次 |
| ? |
在DayofMonth和DayofWeek中,用于匹配任意值 |
在DayofMonth域使用?,表示每天都触发一次 |
| # |
在DayofMonth中,确定第几个星期几 |
1#3表示第三个星期日 |
| L |
表示最后 |
在DayofWeek中使用5L,表示在最后一个星期四触发 |
| W |
表示有效工作日(周一到周五) |
在DayofMonth使用5W,如果5日是星期六,则将在最近的工作日4日触发一次 |
1.5.4.在线 Cron 表达式生成器
地址1:https://cron.qqe2.com/
地址2:https://www.pppet.net/
其实 Cron 表达式无需多记,需要使用的时候直接使用在线生成器就可以了
2、SpringBoot整合Quartz
源码:https://gitee.com/chaojiangcj/springboot-quartz.git
SpringBoot 版本:2.0.9.RELEASE
MySQL 版本:5.7.35
2.1. 数据库表准备
Quartz 存储任务信息有两种方式,使用内存或者使用数据库来存储,这里我们采用 MySQL 数据库存储的方式,首先需要新建 Quartz 的相关表,sql 脚本下载地址:http://www.quartz-scheduler.org/downloads/,名称为 tables_mysql.sql,创建成功后数据库中多出 11 张表
2.2.添加Maven依赖
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
| <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-quartz</artifactId> </dependency>
<dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.38</version> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.10</version> </dependency>
<dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.2</version> </dependency>
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.3.0</version> </dependency>
|
这里使用 druid 作为数据库连接池,Quartz 默认使用 c3p0
2.3. 配置文件
2.3.1. quartz.properties
默认情况下,Quartz 会加载 classpath 下的 quartz.properties 作为配置文件。如果找不到,则会使用 quartz 框架自己 jar 包下 org/quartz 底下的 quartz.properties 文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
|
org.quartz.scheduler.instanceId=AUTO org.quartz.scheduler.instanceName=DefaultQuartzScheduler
org.quartz.scheduler.rmi.export=false
org.quartz.scheduler.rmi.proxy=false org.quartz.scheduler.wrapJobExecutionInUserTransaction=false
org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount=5
org.quartz.threadPool.threadPriority=5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread=true
org.quartz.jobStore.misfireThreshold=5000
org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
org.quartz.jobStore.useProperties=true
org.quartz.jobStore.tablePrefix=QRTZ_
org.quartz.jobStore.dataSource=qzDS
org.quartz.dataSource.qzDS.connectionProvider.class=org.example.config.DruidPoolingconnectionProvider org.quartz.dataSource.qzDS.URL=jdbc:mysql://127.0.0.1:3306/test_quartz?characterEncoding=utf8&useSSL=false&autoReconnect=true&serverTimezone=UTC org.quartz.dataSource.qzDS.user=root org.quartz.dataSource.qzDS.password=123456 org.quartz.dataSource.qzDS.driver=com.mysql.jdbc.Driver org.quartz.dataSource.qzDS.maxConnections=10
|
关于配置详细解释:https://blog.csdn.net/zixiao217/article/details/53091812
也可以查看官网:http://www.quartz-scheduler.org/documentation/2.3.1-SNAPSHOT/
2.3.2. application.yml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
| server: port: 8080
mybatis: mapper-locations: classpath:org/example/mapper/*.xml configuration: cache-enabled: true map-underscore-to-camel-case: true log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
spring: datasource: type: com.alibaba.druid.pool.DruidDataSource druid: driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/test_quartz?characterEncoding=utf8&useSSL=false&autoReconnect=true&serverTimezone=UTC username: root password: 123456 initial-size: 3 max-active: 10 max-wait: 60000 min-idle: 3
|
2.4. 配置类 QuartzConfig
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
| @Configuration public class QuartzConfig implements SchedulerFactoryBeanCustomizer {
@Bean public Properties properties() throws IOException { PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean(); propertiesFactoryBean.setLocation(new ClassPathResource("/quartz.properties")); propertiesFactoryBean.afterPropertiesSet(); return propertiesFactoryBean.getObject(); }
@Bean public SchedulerFactoryBean schedulerFactoryBean() throws IOException { SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean(); schedulerFactoryBean.setQuartzProperties(properties()); return schedulerFactoryBean; }
@Bean public QuartzInitializerListener executorListener() { return new QuartzInitializerListener(); }
@Bean public Scheduler scheduler() throws IOException { return schedulerFactoryBean().getScheduler(); }
@Override public void customize(@NotNull SchedulerFactoryBean schedulerFactoryBean) { schedulerFactoryBean.setStartupDelay(2); schedulerFactoryBean.setAutoStartup(true); schedulerFactoryBean.setOverwriteExistingJobs(true); } }
|
2.5. 创建任务类 HelloJob
1 2 3 4 5 6 7 8 9 10 11
| @Slf4j public class HelloJob implements Job {
@Override public void execute(JobExecutionContext jobExecutionContext) { QuartzService quartzService = (QuartzService) SpringUtil.getBean("quartzServiceImpl"); PageInfo<JobAndTriggerDto> jobAndTriggerDetails = quartzService.getJobAndTriggerDetails(1, 10); log.info("任务列表总数为:" + jobAndTriggerDetails.getTotal()); log.info("Hello Job执行时间: " + DateUtil.now()); } }
|
2.6. 业务 Service 层
具体的 QuartzService 接口这里不在赘述,可以查看后面的源码
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
| @Slf4j @Service public class QuartzServiceImpl implements QuartzService {
@Autowired private JobDetailMapper jobDetailMapper;
@Autowired private Scheduler scheduler;
@Override public PageInfo<JobAndTriggerDto> getJobAndTriggerDetails(Integer pageNum, Integer pageSize) { PageHelper.startPage(pageNum, pageSize); List<JobAndTriggerDto> list = jobDetailMapper.getJobAndTriggerDetails(); PageInfo<JobAndTriggerDto> pageInfo = new PageInfo<>(list); return pageInfo; }
@Override public void addjob(String jName, String jGroup, String tName, String tGroup, String cron) { try { JobDetail jobDetail = JobBuilder.newJob(HelloJob.class) .withIdentity(jName, jGroup) .build(); CronTrigger trigger = TriggerBuilder.newTrigger() .withIdentity(tName, tGroup) .startNow() .withSchedule(CronScheduleBuilder.cronSchedule(cron)) .build(); scheduler.start(); scheduler.scheduleJob(jobDetail, trigger); } catch (Exception e) { log.info("创建定时任务失败" + e); } }
@Override public void pausejob(String jName, String jGroup) throws SchedulerException { scheduler.pauseJob(JobKey.jobKey(jName, jGroup)); }
@Override public void resumejob(String jName, String jGroup) throws SchedulerException { scheduler.resumeJob(JobKey.jobKey(jName, jGroup)); }
@Override public void rescheduleJob(String jName, String jGroup, String cron) throws SchedulerException { TriggerKey triggerKey = TriggerKey.triggerKey(jName, jGroup); CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cron); CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey); trigger = trigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(scheduleBuilder).build(); scheduler.rescheduleJob(triggerKey, trigger); }
@Override public void deletejob(String jName, String jGroup) throws SchedulerException { scheduler.pauseTrigger(TriggerKey.triggerKey(jName, jGroup)); scheduler.unscheduleJob(TriggerKey.triggerKey(jName, jGroup)); scheduler.deleteJob(JobKey.jobKey(jName, jGroup)); } }
|
2.7. Controller 层
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
| @Slf4j @Controller @RequestMapping(path = "/quartz") public class QuartzController {
@Autowired private QuartzService quartzService;
@PostMapping(path = "/addjob") @ResponseBody public ResultMap addjob(String jName, String jGroup, String tName, String tGroup, String cron) { try { quartzService.addjob(jName, jGroup, tName, tGroup, cron); return new ResultMap().success().message("添加任务成功"); } catch (Exception e) { e.printStackTrace(); return new ResultMap().error().message("添加任务失败"); } }
@PostMapping(path = "/pausejob") @ResponseBody public ResultMap pausejob(String jName, String jGroup) { try { quartzService.pausejob(jName, jGroup); return new ResultMap().success().message("暂停任务成功"); } catch (SchedulerException e) { e.printStackTrace(); return new ResultMap().error().message("暂停任务失败"); } }
@PostMapping(path = "/resumejob") @ResponseBody public ResultMap resumejob(String jName, String jGroup) { try { quartzService.resumejob(jName, jGroup); return new ResultMap().success().message("恢复任务成功"); } catch (SchedulerException e) { e.printStackTrace(); return new ResultMap().error().message("恢复任务失败"); } }
@PostMapping(path = "/reschedulejob") @ResponseBody public ResultMap rescheduleJob(String jName, String jGroup, String cron) { try { quartzService.rescheduleJob(jName, jGroup, cron); return new ResultMap().success().message("重启任务成功"); } catch (SchedulerException e) { e.printStackTrace(); return new ResultMap().error().message("重启任务失败"); } }
@PostMapping(path = "/deletejob") @ResponseBody public ResultMap deletejob(String jName, String jGroup) { try { quartzService.deletejob(jName, jGroup); return new ResultMap().success().message("删除任务成功"); } catch (SchedulerException e) { e.printStackTrace(); return new ResultMap().error().message("删除任务失败"); } }
@GetMapping(path = "/queryjob") @ResponseBody public ResultMap queryjob(Integer pageNum, Integer pageSize) { PageInfo<JobAndTriggerDto> pageInfo = quartzService.getJobAndTriggerDetails(pageNum, pageSize); Map<String, Object> map = new HashMap<>(); if (!StringUtils.isEmpty(pageInfo.getTotal())) { map.put("JobAndTrigger", pageInfo); map.put("number", pageInfo.getTotal()); return new ResultMap().success().data(map).message("查询任务成功"); } return new ResultMap().fail().message("查询任务成功失败,没有数据"); } }
|
2.8. 接口测试
2.8.1. 新增定时任务
postman 测试如下

数据库数据展示如下


同样,我们的任务类 HelloJob 也开始执行了,控制台日志如下

2.8.2. 停止项目,再启动运行
可以看到项目中 HelloJob 的任务依然在运行,这就是 quartz 数据库持久化的好处
