SpringBoot 集成 Quartz + MySQL

Quartz 简单使用
Java SpringBoot 中，动态执行 bean 对象中的方法
源代码地址 => https://gitee.com/VipSoft/VipBoot/tree/develop/vipsoft-quartz
工作原理解读

只要配置好 DataSource Quartz 会自动进行表的数据操作，
添加 Quartz Job 任务

保存 QRTZ_JOB_DETAILS、QRTZ_TRIGGERS =>  QRTZ_CRON_TRIGGERS

1. public void addJob(QuartzJob job) throws SchedulerException {
2.   ....
3.   JobDetail jobDetail = JobBuilder.newJob(jobClass)
4.                     .withIdentity(jobKey)
5.                     .build();
6.   // 放入参数，运行时的方法可以获取
7.   jobDetail.getJobDataMap().put(ScheduleConstants.TASK_PROPERTIES, job);
8.   //该行代码执行后，会将定时任务插入 QRTZ_JOB_DETAILS 等相关表
9.   scheduler.scheduleJob(jobDetail, trigger);
10.   ....
11. }

复制代码

1. //org.quartz.impl.jdbcjobstore.JobStoreSupport
2. public void storeJobAndTrigger(final JobDetail newJob, final OperableTrigger newTrigger) throws JobPersistenceException {
3.     this.executeInLock(this.isLockOnInsert() ? "TRIGGER_ACCESS" : null, new JobStoreSupport.VoidTransactionCallback() {
4.         public void executeVoid(Connection conn) throws JobPersistenceException {
5.             JobStoreSupport.this.storeJob(conn, newJob, false);  //数据保存 QRTZ_JOB_DETAILS 表
6.             JobStoreSupport.this.storeTrigger(conn, newTrigger, newJob, false, "WAITING", false, false); //数据保存 QRTZ_TRIGGERS 表
7.         }
8.     });
9. }
11. public int insertTrigger(...){
12. INSERT_TRIGGER
13. insertExtendedTriggerProperties => INSERT_CRON_TRIGGER OR INSERT_BLOB_TRIGGER
15. }

复制代码

详见：org.quartz.impl.jdbcjobstore.StdJDBCDelegate
将 job.getJobDataMap()，对像序列化后，存入 JOB_DETAILS.JOB_DATA字段，可以是一个对像，以执行定时任务时，会把该字段反序列化，根据前期设定的内容进行业务处理

获取 Quartz Job 任务

执行计划任务时，获取 Job Detail

1. QuartzSchedulerThread.run()
2. => qsRsrcs.getJobStore().acquireNextTriggers()
3. => txCallback.execute(conn)
4. => JobStoreSupport.acquireNextTriggers()
5. => JobStoreSupport.retrieveJob()
6. => StdJDBCDelegate.selectJobDetail()

复制代码

删除 Quartz Job 任务

1. /**
2. * <p>
3. * Delete the base trigger data for a trigger.
4. * </p>
5. *
6. * @param conn
7. *          the DB Connection
8. * @return the number of rows deleted
9. */
10. public int deleteTrigger(Connection conn, TriggerKey triggerKey) throws SQLException {
11.     PreparedStatement ps = null;
13.     deleteTriggerExtension(conn, triggerKey);
14.    
15.     try {
16.         ps = conn.prepareStatement(rtp(DELETE_TRIGGER));
17.         ps.setString(1, triggerKey.getName());
18.         ps.setString(2, triggerKey.getGroup());
20.         return ps.executeUpdate();
21.     } finally {
22.         closeStatement(ps);
23.     }
24. }

复制代码

清除数据

1. /**
2. * 清任务顺序
3. */
4. public void clearData(Connection conn)
5.     throws SQLException {
7.     PreparedStatement ps = null;
9.     try {
10.         ps = conn.prepareStatement(rtp(DELETE_ALL_SIMPLE_TRIGGERS));
11.         ps.executeUpdate();
12.         ps.close();
13.         ps = conn.prepareStatement(rtp(DELETE_ALL_SIMPROP_TRIGGERS));
14.         ps.executeUpdate();
15.         ps.close();
16.         ps = conn.prepareStatement(rtp(DELETE_ALL_CRON_TRIGGERS));
17.         ps.executeUpdate();
18.         ps.close();
19.         ps = conn.prepareStatement(rtp(DELETE_ALL_BLOB_TRIGGERS));
20.         ps.executeUpdate();
21.         ps.close();
22.         ps = conn.prepareStatement(rtp(DELETE_ALL_TRIGGERS));
23.         ps.executeUpdate();
24.         ps.close();
25.         ps = conn.prepareStatement(rtp(DELETE_ALL_JOB_DETAILS));
26.         ps.executeUpdate();
27.         ps.close();
28.         ps = conn.prepareStatement(rtp(DELETE_ALL_CALENDARS));
29.         ps.executeUpdate();
30.         ps.close();
31.         ps = conn.prepareStatement(rtp(DELETE_ALL_PAUSED_TRIGGER_GRPS));
32.         ps.executeUpdate();
33.     } finally {
34.         closeStatement(ps);
35.     }
36. }

复制代码

Demo 代码

MySQL 脚本

https://github.com/quartz-scheduler/quartz/blob/v2.3.2/quartz-core/src/main/resources/org/quartz/impl/jdbcjobstore/tables_mysql.sql
清除数据

1. DELETE FROM qrtz_simple_triggers ;
2. DELETE FROM qrtz_simprop_triggers ;
3. DELETE FROM qrtz_cron_triggers ;
4. DELETE FROM qrtz_blob_triggers ;
5. DELETE FROM qrtz_triggers ;
6. DELETE FROM qrtz_job_details ;
7. DELETE FROM qrtz_calendars ;
8. DELETE FROM qrtz_paused_trigger_grps ;
9. DELETE FROM qrtz_scheduler_state ;
10. DELETE FROM qrtz_locks ;
11. DELETE FROM qrtz_fired_triggers

复制代码

Pom.xml
如果SpringBoot版本是2.0.0以后的，则在spring-boot-starter中已经包含了quart的依赖，则可以直接使用spring-boot-starter-quartz依赖：

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-quartz</artifactId>
4. </dependency>
6. <dependency>
7.     <groupId>mysql</groupId>
8.     <artifactId>mysql-connector-java</artifactId>
9.     <version>5.0.8</version>
10. </dependency>
11. <dependency>
12.     <groupId>com.alibaba</groupId>
13.     <artifactId>druid</artifactId>
14.     <version>1.1.20</version>
15. </dependency>
16. <dependency>
17.     <groupId>org.mybatis.spring.boot</groupId>
18.     <artifactId>mybatis-spring-boot-starter</artifactId>
19. </dependency>
21. <dependency>
22.     <groupId>cn.hutool</groupId>
23.     <artifactId>hutool-all</artifactId>
24.     <version>5.3.7</version>
25. </dependency>

复制代码

QuartzJob 参考上图，建立实体
点击查看代码

1. package com.vipsoft.web.entity;
3. import javax.validation.constraints.NotBlank;
4. import javax.validation.constraints.Size;
5. import java.io.Serializable;
7. /**
8. * 定时任务调度
9. */
10. public class QuartzJob implements Serializable {
12.     private static final long serialVersionUID = -6798153039624729495L;
14.     /**
15.      * 任务序号
16.      */
17.     private int jobId;
19.     /**
20.      * 任务名称
21.      */
22.     @NotBlank(message = "任务名称不能为空")
23.     @Size(max = 10, message = "任务名称不能超过10个字符")
24.     private String jobName;
26.     /**
27.      * 任务组名
28.      */
29.     @NotBlank(message = "任务组名不能为空")
30.     @Size(max = 10, message = "任务组名不能超过10个字符")
31.     private String jobGroup;
33.     /**
34.      * 调用目标字符串
35.      */
36.     private String invokeTarget;
38.     /**
39.      * 执行表达式
40.      */
41.     private String cronExpression;
43.     /**
44.      * cron计划策略 0=默认,1=立即触发执行,2=触发一次执行,3=不触发立即执行
45.      */
46.     private String misfirePolicy = "0";
48.     /**
49.      * 并发执行 0=允许,1=禁止
50.      */
51.     private String concurrent;
53.     /**
54.      * 描述 -- 任务说明
55.      */
56.     private String description;
59.     /**
60.      * 任务状态（0正常 1暂停）
61.      */
62.     private String status;
65.     public int getJobId() {
66.         return jobId;
67.     }
69.     public void setJobId(int jobId) {
70.         this.jobId = jobId;
71.     }
73.     public String getJobName() {
74.         return jobName;
75.     }
77.     public void setJobName(String jobName) {
78.         this.jobName = jobName;
79.     }
81.     public String getJobGroup() {
82.         return jobGroup;
83.     }
85.     public void setJobGroup(String jobGroup) {
86.         this.jobGroup = jobGroup;
87.     }
89.     public String getInvokeTarget() {
90.         return invokeTarget;
91.     }
93.     public void setInvokeTarget(String invokeTarget) {
94.         this.invokeTarget = invokeTarget;
95.     }
97.     public String getCronExpression() {
98.         return cronExpression;
99.     }
101.     public void setCronExpression(String cronExpression) {
102.         this.cronExpression = cronExpression;
103.     }
105.     public String getMisfirePolicy() {
106.         return misfirePolicy;
107.     }
109.     public void setMisfirePolicy(String misfirePolicy) {
110.         this.misfirePolicy = misfirePolicy;
111.     }
113.     public String getConcurrent() {
114.         return concurrent;
115.     }
117.     public void setConcurrent(String concurrent) {
118.         this.concurrent = concurrent;
119.     }
121.     public String getStatus() {
122.         return status;
123.     }
125.     public void setStatus(String status) {
126.         this.status = status;
127.     }
129.     public String getDescription() {
130.         return description;
131.     }
133.     public void setDescription(String description) {
134.         this.description = description;
135.     }
136. }

复制代码

核心代码：QuartzJobServiceImpl
点击查看代码[code]package com.vipsoft.web.service.impl;import cn.hutool.core.util.StrUtil;import com.vipsoft.web.config.ScheduleConstants;import com.vipsoft.web.entity.QuartzJob;import com.vipsoft.web.exception.CustomException;import com.vipsoft.web.job.CommonJob;import com.vipsoft.web.service.IQuartzJobService;import org.quartz.*;import org.quartz.impl.matchers.GroupMatcher;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Service;import java.util.ArrayList;import java.util.List;import java.util.Set;@Servicepublic class QuartzJobServiceImpl implements IQuartzJobService {    @Autowired    Scheduler scheduler;    /**     * 新增任务     *     * @param job 调度信息     * @return 结果     */    @Override    public void clearAll(QuartzJob job) throws SchedulerException {        scheduler.clear();    }    /**     * 新增任务     *     * @param job 调度信息     * @return 结果     */    @Override    public void addJob(QuartzJob job) throws SchedulerException {        if (StrUtil.isEmpty(job.getStatus())) {            // 如果没值，设置暂停            job.setStatus(ScheduleConstants.Status.PAUSE.getValue());        }        Class