springboot集成quartz完成定时任务

springboot整合Quartz

读取数据库来开启定时任务（案例）

项目目录

首先我们要知道我们整合Quartz需要哪些步骤

1、首先我们需要进入Quartz官网，下载我们使用需要的内置表sql

官网：http://www.quartz-scheduler.org/
下载下来是一个完整的文件夹，我们需要进入docs–>dbTables，然后在里面找你需要的数据类型的sql，然后把sql文件导入你的数据库

如我的是mysql数据库，它里面有11张表，这些表是我们后面操作Quartz需要的

2、创建springboot项目，导入相关pom,下面是我项目中用到的依赖

还有一些依赖是它没有整合进去的，需要我们自己导入

<dependency><groupId>org.quartz-scheduler</groupId><artifactId>quartz-jobs</artifactId><version>2.2.1</version></dependency><dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-starter</artifactId><version>1.1.10</version></dependency>

3、Quartz默认的连接池是c3p0，如果你的连接池不同需要直接替换它的配置文件，比如我用的连接池是druid，就需要自己改配置（如果就用c3p0就不需要改）

Druid连接池Quartz的工具类
DruidConnectionProvider


package com.liuxia.quartz02.utils;import com.alibaba.druid.pool.DruidDataSource;
import org.quartz.SchedulerException;
import org.quartz.utils.ConnectionProvider;import java.sql.Connection;
import java.sql.SQLException;/*
#============================================================================
# JDBC
#============================================================================
org.quartz.jobStore.driverDelegateClass:org.quartz.impl.jdbcjobstore.StdJDBCDelegate
org.quartz.jobStore.useProperties:false
org.quartz.jobStore.dataSource:qzDS
#org.quartz.dataSource.qzDS.connectionProvider.class:org.quartz.utils.PoolingConnectionProvider
org.quartz.dataSource.qzDS.connectionProvider.class:com.zking.q03.quartz.DruidConnectionProvider
org.quartz.dataSource.qzDS.driver:com.mysql.jdbc.Driver
org.quartz.dataSource.qzDS.URL:jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8
org.quartz.dataSource.qzDS.user:root
org.quartz.dataSource.qzDS.password:root
org.quartz.dataSource.qzDS.maxConnections:30
org.quartz.dataSource.qzDS.validationQuery: select 0
*//*** [Druid连接池的Quartz扩展类]** @ProjectName: []* @Author: [xuguang]* @CreateDate: [2015/11/10 17:58]* @Update: [说明本次修改内容] BY[xuguang][2015/11/10]* @Version: [v1.0]*/
public class DruidConnectionProvider implements ConnectionProvider {/** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~** 常量配置，与quartz.properties文件的key保持一致(去掉前缀)，同时提供set方法，Quartz框架自动注入值。** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*///JDBC驱动public String driver;//JDBC连接串public String URL;//数据库用户名public String user;//数据库用户密码public String password;//数据库最大连接数public int maxConnection;//数据库SQL查询每次连接返回执行到连接池，以确保它仍然是有效的。public String validationQuery;private boolean validateOnCheckout;private int idleConnectionValidationSeconds;public String maxCachedStatementsPerConnection;private String discardIdleConnectionsSeconds;public static final int DEFAULT_DB_MAX_CONNECTIONS = 10;public static final int DEFAULT_DB_MAX_CACHED_STATEMENTS_PER_CONNECTION = 120;//Druid连接池private DruidDataSource datasource;/** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~** 接口实现** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/public Connection getConnection() throws SQLException {return datasource.getConnection();}public void shutdown() throws SQLException {datasource.close();}public void initialize() throws SQLException{if (this.URL == null) {throw new SQLException("DBPool could not be created: DB URL cannot be null");}if (this.driver == null) {throw new SQLException("DBPool driver could not be created: DB driver class name cannot be null!");}if (this.maxConnection < 0) {throw new SQLException("DBPool maxConnectins could not be created: Max connections must be greater than zero!");}datasource = new DruidDataSource();try{datasource.setDriverClassName(this.driver);} catch (Exception e) {try {throw new SchedulerException("Problem setting driver class name on datasource: " + e.getMessage(), e);} catch (SchedulerException e1) {}}datasource.setUrl(this.URL);datasource.setUsername(this.user);datasource.setPassword(this.password);datasource.setMaxActive(this.maxConnection);datasource.setMinIdle(1);datasource.setMaxWait(0);datasource.setMaxPoolPreparedStatementPerConnectionSize(this.DEFAULT_DB_MAX_CACHED_STATEMENTS_PER_CONNECTION);if (this.validationQuery != null) {datasource.setValidationQuery(this.validationQuery);if(!this.validateOnCheckout)datasource.setTestOnReturn(true);elsedatasource.setTestOnBorrow(true);datasource.setValidationQueryTimeout(this.idleConnectionValidationSeconds);}}/** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~** 提供get set方法** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/public String getDriver() {return driver;}public void setDriver(String driver) {this.driver = driver;}public String getURL() {return URL;}public void setURL(String URL) {this.URL = URL;}public String getUser() {return user;}public void setUser(String user) {this.user = user;}public String getPassword() {return password;}public void setPassword(String password) {this.password = password;}public int getMaxConnection() {return maxConnection;}public void setMaxConnection(int maxConnection) {this.maxConnection = maxConnection;}public String getValidationQuery() {return validationQuery;}public void setValidationQuery(String validationQuery) {this.validationQuery = validationQuery;}public boolean isValidateOnCheckout() {return validateOnCheckout;}public void setValidateOnCheckout(boolean validateOnCheckout) {this.validateOnCheckout = validateOnCheckout;}public int getIdleConnectionValidationSeconds() {return idleConnectionValidationSeconds;}public void setIdleConnectionValidationSeconds(int idleConnectionValidationSeconds) {this.idleConnectionValidationSeconds = idleConnectionValidationSeconds;}public DruidDataSource getDatasource() {return datasource;}public void setDatasource(DruidDataSource datasource) {this.datasource = datasource;}
}

quartz.properties

#
#============================================================================
# Configure Main Scheduler Properties 调度器属性
#============================================================================
org.quartz.scheduler.instanceName: DefaultQuartzScheduler
org.quartz.scheduler.instanceId = AUTO
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= 10
org.quartz.threadPool.threadPriority: 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true
org.quartz.jobStore.misfireThreshold: 60000
#============================================================================
# Configure JobStore
#============================================================================
#存储方式使用JobStoreTX，也就是数据库
org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.driverDelegateClass:org.quartz.impl.jdbcjobstore.StdJDBCDelegate
#使用自己的配置文件
org.quartz.jobStore.useProperties:true
#数据库中quartz表的表名前缀
org.quartz.jobStore.tablePrefix:qrtz_
org.quartz.jobStore.dataSource:qzDS
#是否使用集群（如果项目只部署到 一台服务器，就不用了）
org.quartz.jobStore.isClustered = true
#============================================================================
# Configure Datasources
#============================================================================
#配置数据库源（org.quartz.dataSource.qzDS.maxConnections: c3p0配置的是有s的，druid数据源没有s）
org.quartz.dataSource.qzDS.connectionProvider.class:com.liuxia.quartz02.utils.DruidConnectionProvider
org.quartz.dataSource.qzDS.driver: com.mysql.jdbc.Driver
org.quartz.dataSource.qzDS.URL: jdbc:mysql://localhost:3306/t226_layui?useUnicode=true&characterEncoding=utf8
org.quartz.dataSource.qzDS.user: root
org.quartz.dataSource.qzDS.password: 123
org.quartz.dataSource.qzDS.maxConnection: 10

application.yml

server:port: 80servlet:context-path: /
spring:datasource:#1.JDBCtype: com.alibaba.druid.pool.DruidDataSourcedriver-class-name: com.mysql.jdbc.Driverurl: jdbc:mysql://localhost:3306/t226_layui?useUnicode=true&characterEncoding=utf8username: rootpassword: 123druid:#2.连接池配置#初始化连接池的连接数量 大小，最小，最大initial-size: 5min-idle: 5max-active: 20#配置获取连接等待超时的时间max-wait: 60000#配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒time-between-eviction-runs-millis: 60000# 配置一个连接在池中最小生存的时间，单位是毫秒min-evictable-idle-time-millis: 30000validation-query: SELECT 1 FROM DUALtest-while-idle: truetest-on-borrow: truetest-on-return: false# 是否缓存preparedStatement，也就是PSCache  官方建议MySQL下建议关闭   个人建议如果想用SQL防火墙 建议打开pool-prepared-statements: truemax-pool-prepared-statement-per-connection-size: 20# 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙filter:stat:merge-sql: trueslow-sql-millis: 5000#3.基础监控配置web-stat-filter:enabled: trueurl-pattern: /*#设置不统计哪些URLexclusions: "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*"session-stat-enable: truesession-stat-max-count: 100stat-view-servlet:enabled: trueurl-pattern: /druid/*reset-enable: true#设置监控页面的登录名和密码login-username: adminlogin-password: adminallow: 127.0.0.1#deny: 192.168.1.100#显示日志
logging:level:com.liuxia.quartz02.mapper: debug

4、需要配置我们的JobFactory，因为我们在项目开发中是需要在Job中操作数据库的，那么当然需要把它交给spring管理，但是quartz本身是不支持的，所以我们需要修改它的底层代码，让我们的Job类能被spring所管理

MyJobFactory

package com.liuxia.quartz02.utils;import lombok.extern.slf4j.Slf4j;
import org.quartz.spi.TriggerFiredBundle;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.scheduling.quartz.AdaptableJobFactory;
import org.springframework.stereotype.Component;@Component
@Slf4j
public class MyJobFactory extends AdaptableJobFactory {//这个对象Spring会帮我们自动注入进来@Autowiredprivate AutowireCapableBeanFactory autowireCapableBeanFactory;//重写创建Job任务的实例方法@Overrideprotected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {Object jobInstance = super.createJobInstance(bundle);//通过以下方式，解决Job任务无法使用Spring中的Bean问题autowireCapableBeanFactory.autowireBean(jobInstance);return super.createJobInstance(bundle);}
}

然后把刚刚写的配置全部丢进我们的配置类中
QuartzConfiguration


package com.liuxia.quartz02.config;import com.liuxia.quartz02.utils.MyJobFactory;
import org.quartz.Scheduler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.PropertiesFactoryBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;import java.io.IOException;
import java.util.Properties;@Configuration
public class QuartzConfiguration {@Autowiredprivate MyJobFactory myJobFactory;//创建调度器工厂@Beanpublic SchedulerFactoryBean schedulerFactoryBean(){//1.创建SchedulerFactoryBean//2.加载自定义的quartz.properties配置文件//3.设置MyJobFactorySchedulerFactoryBean factoryBean=new SchedulerFactoryBean();try {factoryBean.setQuartzProperties(quartzProperties());factoryBean.setJobFactory(myJobFactory);return factoryBean;} catch (IOException e) {throw new RuntimeException(e);}}@Beanpublic Properties quartzProperties() throws IOException {PropertiesFactoryBean propertiesFactoryBean=new PropertiesFactoryBean();propertiesFactoryBean.setLocation(new ClassPathResource("/quartz.properties"));propertiesFactoryBean.afterPropertiesSet();return propertiesFactoryBean.getObject();}@Bean(name="scheduler")public Scheduler scheduler(){return schedulerFactoryBean().getScheduler();}
}

读取数据库来开启定时任务（案例）
那么我们还需要自己创建两张表，通过这两张表和Quartz的内置表来管理动态的定时任务,表里面的数据我们测试用的数据
t_schedule_trigger，管理具体的任务，
id：标识列
cron：表达式
status（0关闭，1开启）是否开启
job_name：job的name
job_group：job的group

t_schedule_trigger——param,管理传递的参数

然后用mybatis逆向生成这两张表的实体类和mapper

这是我的3个job类
MyJob

package com.liuxia.quartz02.quartz;import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.stereotype.Component;import java.util.Date;@Component
@Slf4j
public class MyJob implements Job {@Overridepublic void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {System.out.println("MyJob是一个空的任务计划,时间："+new Date().toLocaleString());}
}

MyJob1


package com.liuxia.quartz02.quartz;import com.liuxia.quartz02.service.ScheduleTriggerParamService;
import lombok.extern.slf4j.Slf4j;
import org.quartz.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;import java.util.Date;@Component
@Slf4j
public class MyJob1 implements Job {@Autowiredprivate ScheduleTriggerParamService scheduleTriggerParamService;@Overridepublic void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {JobDetail jobDetail =jobExecutionContext.getJobDetail();JobDataMap jobDataMap = jobDetail.getJobDataMap();System.out.println(new Date().toLocaleString()+"-->携带参数个数:"+jobDataMap.size());}
}

MyJob2

package com.liuxia.quartz02.quartz;import lombok.extern.slf4j.Slf4j;
import org.quartz.*;
import org.springframework.stereotype.Component;import java.util.Date;@Component
@Slf4j
public class MyJob2 implements Job {@Overridepublic void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {JobDetail jobDetail =jobExecutionContext.getJobDetail();JobDataMap jobDataMap = jobDetail.getJobDataMap();System.out.println(new Date().toLocaleString()+"-->MyJob2参数传递name="+jobDataMap.get("name")+",score="+jobDataMap.get("score"));}
}

ScheduleTriggerServiceImpl


package com.liuxia.quartz02.service.impl;import com.liuxia.quartz02.mapper.ScheduleTriggerMapper;
import com.liuxia.quartz02.mapper.ScheduleTriggerParamMapper;
import com.liuxia.quartz02.model.ScheduleTrigger;
import com.liuxia.quartz02.model.ScheduleTriggerParam;
import com.liuxia.quartz02.mapper.ScheduleTriggerMapper;
import com.liuxia.quartz02.mapper.ScheduleTriggerParamMapper;
import com.liuxia.quartz02.service.ScheduleTriggerService;
import org.quartz.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;import java.util.List;@Service
public class ScheduleTriggerServiceImpl implements ScheduleTriggerService {@Autowiredprivate ScheduleTriggerMapper scheduleTriggerMapper;@Autowiredprivate ScheduleTriggerParamMapper scheduleTriggerParamMapper;@Autowiredprivate Scheduler scheduler;@Overridepublic int deleteByPrimaryKey(Integer id) {return scheduleTriggerMapper.deleteByPrimaryKey(id);}@Overridepublic int insert(ScheduleTrigger record) {return scheduleTriggerMapper.insert(record);}@Overridepublic int insertSelective(ScheduleTrigger record) {return scheduleTriggerMapper.insertSelective(record);}@Overridepublic ScheduleTrigger selectByPrimaryKey(Integer id) {return scheduleTriggerMapper.selectByPrimaryKey(id);}@Overridepublic int updateByPrimaryKeySelective(ScheduleTrigger record) {return scheduleTriggerMapper.updateByPrimaryKeySelective(record);}@Overridepublic int updateByPrimaryKey(ScheduleTrigger record) {return scheduleTriggerMapper.updateByPrimaryKey(record);}@Overridepublic List<ScheduleTrigger> queryScheduleTriggerLst() {return scheduleTriggerMapper.queryScheduleTriggerLst();}@Scheduled(cron = "0/10 * * * * ?")public void refreshScheduler(){try {List<ScheduleTrigger> scheduleTriggers =scheduleTriggerMapper.queryScheduleTriggerLst();if(null!=scheduleTriggers){for (ScheduleTrigger scheduleTrigger : scheduleTriggers) {String cron = scheduleTrigger.getCron();  //表达式String jobName = scheduleTrigger.getJob_name(); //任务名称String jobGroup = scheduleTrigger.getJob_group(); //任务分组String status = scheduleTrigger.getStatus();  //任务状态//JobName+JobGroup=Primary Key//根据jobName和jobGroup生成TriggerKeyTriggerKey triggerKey =TriggerKey.triggerKey(jobName, jobGroup);//根据TriggerKey到Scheduler调度器中获取触发器CronTrigger cronTrigger = (CronTrigger)scheduler.getTrigger(triggerKey);if(null==cronTrigger){if(status.equals("0"))continue;System.out.println("创建调度器");//创建任务详情JobDetail jobDetail=JobBuilder.newJob((Class<? extends Job>) Class.forName(jobName)).withIdentity(jobName,jobGroup).build();//往Job任务中传递参数JobDataMap jobDataMap = jobDetail.getJobDataMap();List<ScheduleTriggerParam> params =scheduleTriggerParamMapper.queryScheduleParamLst(scheduleTrigger.getId());for (ScheduleTriggerParam param : params) {jobDataMap.put(param.getName(),param.getValue());}//创建表达式调度器CronScheduleBuilder cronSchedule =CronScheduleBuilder.cronSchedule(cron);//创建TriggercronTrigger=TriggerBuilder.newTrigger().withIdentity(jobName,jobGroup).withSchedule(cronSchedule).build();//将jobDetail和Trigger注入到scheduler调度器中scheduler.scheduleJob(jobDetail,cronTrigger);}else{//System.out.println("Quartz 调度任务中已存在该任务");if(status.equals("0")){JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.deleteJob(jobKey);continue;}//调度器中的表达式String cronExpression =cronTrigger.getCronExpression();if(!cron.equals(cronExpression)){//创建表达式调度器CronScheduleBuilder cronSchedule =CronScheduleBuilder.cronSchedule(cron);//重构cronTrigger=cronTrigger.getTriggerBuilder().withIdentity(triggerKey).withSchedule(cronSchedule).build();//刷新调度器scheduler.rescheduleJob(triggerKey,cronTrigger);}}}}} catch (Exception e) {e.printStackTrace();}}}

ScheduleTriggerService


package com.liuxia.quartz02.service;import com.liuxia.quartz02.model.ScheduleTrigger;import java.util.List;public interface ScheduleTriggerService {int deleteByPrimaryKey(Integer id);int insert(ScheduleTrigger record);int insertSelective(ScheduleTrigger record);ScheduleTrigger selectByPrimaryKey(Integer id);int updateByPrimaryKeySelective(ScheduleTrigger record);int updateByPrimaryKey(ScheduleTrigger record);/*** 查询触发器中包含的所有任务* @return*/List<ScheduleTrigger> queryScheduleTriggerLst();}

控制器 QuartzController


package com.liuxia.quartz02.Controller;import com.liuxia.quartz02.model.ScheduleTrigger;
import com.liuxia.quartz02.service.ScheduleTriggerService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;import java.util.List;@Controller
@RequestMapping("/quartz")public class QuartzController {@Autowiredprivate ScheduleTriggerService scheduleTriggerService;@RequestMapping("/list")public ModelAndView getAll(){ModelAndView modelAndView = new ModelAndView();List<ScheduleTrigger> list = scheduleTriggerService.queryScheduleTriggerLst();modelAndView.addObject("quartzList",list);modelAndView.setViewName("index");return modelAndView;}@RequestMapping("/edit")public String editStatus(ScheduleTrigger scheduleTrigger){int n = scheduleTriggerService.updateByPrimaryKeySelective(scheduleTrigger);return "redirect:/quartz/list";}@RequestMapping("/proSave/{id}")public ModelAndView proSave(@PathVariable(value = "id") Integer id){ModelAndView modelAndView=new ModelAndView();ScheduleTrigger scheduleTrigger = scheduleTriggerService.selectByPrimaryKey(id);modelAndView.addObject("schedule",scheduleTrigger);modelAndView.setViewName("edit");return modelAndView;}}

index.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head><meta charset="UTF-8"><title>quartz定时任务管理</title>
</head>
<body>
<h1 style="text-align: center">定时任务管理</h1>
<table style="text-align: center" align="center" border="1px" width="50%"><tr><td>任务id</td><td>任务表达式</td><td>任务状态</td><td>job工作类</td><td>job分组</td><td>操作</td></tr><tr th:each="q : ${quartzList}"><td th:text="${q.id}"></td><td th:text="${q.cron}"></td><td th:text="${q.status}"></td><td th:text="${q.job_name}"></td><td th:text="${q.job_group}"></td><td th:switch ="${q.status} == 0"><a th:case="true" th:href="@{/quartz/edit(id=${q.id},status=1)}">启动</a><a th:case="false" th:href="@{/quartz/edit(id=${q.id},status=0)}">停止</a><a th:href="@{'/quartz/proSave/'+${q.id}}">编辑</a></td></tr>
</table></body>
</html>

edit.html


<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head><meta charset="UTF-8"><title>编辑定时任务</title>
</head>
<body>
<h1>编辑定时任务</h1>
<form th:action="@{/quartz/edit}" method="post"><input type="hidden" name="id" th:value="${schedule.id}" />任务表达式： <input width="300px" type="text" name="cron" th:value="${schedule.cron}" /></br>job工作类： <input width="300px" type="text" name="job_name" th:value="${schedule.job_name}" /></br>job分组：<input width="300px" type="text" name="job_group" th:value="${schedule.job_group}" /></br><input type="submit" value="提交"/>
</form>
</body>
</html>

最终效果

完了…