SpringBoot整合Quartz
首先我們要知道我們整合Quartz需要哪些步驟
1、首先我們需要進入Quartz官網，下載我們使用需要的內置表sql
官網：http://www.quartz-scheduler.org/
下載下來是一個完整的文件夾，我們需要進入docs–>dbTables，然后在里面找你需要的數據類型的sql，然后把sql文件導入你的數據庫
它里面有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.su.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.su.quartz02.utils.DruidConnectionProvider
org.quartz.dataSource.qzDS.driver: com.mysql.jdbc.Driver
org.quartz.dataSource.qzDS.URL: jdbc:mysql://localhost:3306/db_0524?useUnicode=true&characterEncoding=utf8
org.quartz.dataSource.qzDS.user: root
org.quartz.dataSource.qzDS.password: 123
org.quartz.dataSource.qzDS.maxConnection: 10
然后在后面把這個文件配會丟入我們的配置文件中
4、需要配置我們的JobFactory，因為我們在項目開發中是需要在Job中操作數據庫的，那么當然需要把它交給spring管理，但是quartz本身是不支持的，所以我們需要修改它的底層代碼，讓我們的Job類能被spring所管理
MyJobFactory
package com.su.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.su.quartz02.config;import com.su.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();}
}
然后這次項目還用到了mybatis逆向生成，jdbc等配置類就不發上去了，和以前的代碼一樣，可以去我以前的博客里面copy
讀取數據庫來開啟定時任務（案例）
那么我們還需要自己創建兩張表，通過這兩張表和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.su.quartz02.job;import lombok.extern.slf4j.Slf4j;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.beans.factory.annotation.Autowired;
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.su.quartz02.job;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 {@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.su.quartz02.job;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"));}
}
主要的業務邏輯類，這個類負責控制我們創建的兩張中間表和Quartz的內置表中的業務邏輯,比如當我們中間表的狀態為0時，我們定時任務就需要停止，那么就需要把內置表中的相關數據刪除定時任務才會停止
ScheduleTriggerServiceImpl
package com.su.quartz02.service;import com.su.quartz02.entity.ScheduleTrigger;
import com.su.quartz02.entity.ScheduleTriggerParam;
import com.su.quartz02.mapper.ScheduleTriggerMapper;
import com.su.quartz02.mapper.ScheduleTriggerParamMapper;
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();}}
}
ScheduleService
package com.su.quartz02.service;import com.su.quartz02.entity.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.su.quartz02.controller;import com.su.quartz02.entity.ScheduleTrigger;
import com.su.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.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
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 mv = new ModelAndView();List<ScheduleTrigger> list = scheduleTriggerService.queryScheduleTriggerLst();mv.addObject("quartzList",list);mv.setViewName("index");return mv;}@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 mv=new ModelAndView();ScheduleTrigger scheduleTrigger = scheduleTriggerService.selectByPrimaryKey(id);mv.addObject("schedule",scheduleTrigger);mv.setViewName("edit");return mv;}}
templates模板
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>
最終效果
總結
以上是生活随笔為你收集整理的SpringBoot整合Quartz的全部內容，希望文章能夠幫你解決所遇到的問題。
如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。
