當前位置：
首頁 >
前端技术
> javascript
>内容正文
javascript
SpringBoot与quartz框架实现分布式定时任务
生活随笔
收集整理的這篇文章主要介紹了
SpringBoot与quartz框架实现分布式定时任务
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
前言
quartz的分布式調度策略是以數據庫為邊界資源的一種異步策略。各個調度器都遵守一個基于數據庫鎖的操作規則從而保證了操作的唯一性。
在quartz的集群解決方案里有張表scheduler_locks，quartz采用了悲觀鎖的方式對triggers表進行行加鎖，以保證任務同步的正確性。一旦某一個節點上面的線程獲取了該鎖，那么這個Job就會在這臺機器上被執行，同時這個鎖就會被這臺機器占用。同時另外一臺機器也會想要觸發這個任務，但是鎖已經被占用了，就只能等待，直到這個鎖被釋放。
一、介紹
1.Quartz 核心概念
我們需要明白 Quartz 的幾個核心概念，這樣理解起 Quartz 的原理就會變得簡單了。
2. 原理圖
二、使用步驟
1. 引入依賴
代碼如下(示例)：
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.wyc</groupId><artifactId>quartz</artifactId><version>1.0-SNAPSHOT</version><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.6.RELEASE</version><!-- <relativePath/> --> <!-- lookup parent from repository --></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-quartz</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.48</version></dependency><!--mybatis--><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>1.3.1</version></dependency><dependency><groupId>com.mchange</groupId><artifactId>c3p0</artifactId><version>0.9.5.2</version></dependency><!-- Druid是阿里巴巴推出的國產數據庫連接池，據網上測試對比，比目前的DBCP或C3P0數據庫連接池性能更好--><dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-starter</artifactId><version>1.1.10</version></dependency><!--google工具類--><dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId><version>23.0</version></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build> </project>2. 在項目中添加quartz.properties文件(不添加該文件該框架會加載自帶的properties文件)
# Default Properties file for use by StdSchedulerFactory # to create a Quartz Scheduler Instance, if a different # properties file is not explicitly specified.#使用自己的配置文件 org.quartz.jobStore.useProperties:true#默認或是自己改名字都行 org.quartz.scheduler.instanceName: DefaultQuartzScheduler#如果使用集群，instanceId必須唯一，設置成AUTO org.quartz.scheduler.instanceId = AUTOorg.quartz.scheduler.rmi.export: false org.quartz.scheduler.rmi.proxy: false org.quartz.scheduler.wrapJobExecutionInUserTransaction: falseorg.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 #============================================================================ #org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore#存儲方式使用JobStoreTX，也就是數據庫 org.quartz.jobStore.class:org.quartz.impl.jdbcjobstore.JobStoreTX org.quartz.jobStore.driverDelegateClass:org.quartz.impl.jdbcjobstore.StdJDBCDelegate #數據庫中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.cbw.quartz02.util.DruidConnectionProvider org.quartz.dataSource.qzDS.driver: com.mysql.jdbc.Driver org.quartz.dataSource.qzDS.URL: jdbc:mysql://localhost:3306/quartz?useUnicode=true&characterEncoding=utf8 org.quartz.dataSource.qzDS.user: root org.quartz.dataSource.qzDS.password: 123 org.quartz.dataSource.qzDS.maxConnection: 10在依賴中可以看到引入了兩種連接池，這兩種連接池是可選擇的。quartz框架默認的選擇C3P0連接池，如果想要更換連接池就需要配置文件，如上進行修改。
3.在數據庫中創建quartz相關的表(建議與業務隔離庫)
1）進入quartz的官網http://www.quartz-scheduler.org/，點擊Downloads，下載后在目錄\docs\dbTables下有常用數據庫創建quartz表的腳本。
例如：“tables_mysql.sql”
tables_mysql.sql 、tables_mysql_innodb.sql
上述兩者所有的數據庫引擎不一樣，根據需要進行選擇。導入之后，數據會出現下列幾張表，但沒有數據。
2）本博客最后項目中包含數據庫腳本。
tables_mysql_innodb.sql
4.項目結構
包名解釋:
5.代碼配置
1) 多數據源配置 - DataSourceConfig：
package com.wyc.demo.config;import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Primary;import javax.sql.DataSource;/*** @author: wangyuanchen* @date: 2020-10-27 14:25* @description:*/ @Configuration public class DataSourceConfig {@Primary@Bean("quartzDataSource")@ConfigurationProperties(prefix = "spring.datasource.druid.quartz")public DataSource quartzDataSource() {return DataSourceBuilder.create().build();}@Bean("demoDataSource")@ConfigurationProperties(prefix = "spring.datasource.druid.demo")public DataSource accountDataSource() {return DataSourceBuilder.create().build();}}2) 配置文件 - application.yml：
server:port: 8080spring: #---------------------kafka配置--------------------- #---------------------數據源---------------------datasource:druid:quartz:driver-class-name: com.mysql.jdbc.Driverjdbc-url: jdbc:mysql://127.0.0.1:3306/quartz?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowMultiQueries=trueusername: wycpassword: 1111type: com.alibaba.druid.pool.DruidDataSourcedruid:initial-size: 20min-idle: 5max-active: 50max-wait: 60000time-between-eviction-runs-millis: 60000min-evictable-idle-time-millis: 300000test-while-idle: truetest-on-borrow: falsetest-on-return: falsepool-prepared-statements: falsemax-pool-prepared-statement-per-connection-size: 20demo:driver-class-name: com.mysql.jdbc.Driverjdbc-url: jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowMultiQueries=trueusername: wycpassword: 1111type: com.alibaba.druid.pool.DruidDataSourcedruid:initial-size: 20min-idle: 5max-active: 50max-wait: 60000time-between-eviction-runs-millis: 60000min-evictable-idle-time-millis: 300000test-while-idle: truetest-on-borrow: falsetest-on-return: falsepool-prepared-statements: falsemax-pool-prepared-statement-per-connection-size: 20#---------------------mybatis--------------------- mybatis:credit:mapper-locations: classpath:mappers/demo/*.xmlquartz:mapper-locations: classpath:mappers/quartz/*.xml#---------------------日志--------------------- logging:level:root: info/src/main/resources/mappers/demo/DemoMapper.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" > <mapper namespace="com.wyc.demo.dao.demo"></mapper>/src/main/resources/mappers/quartz/DemoMapper.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" > <mapper namespace="com.wyc.demo.dao.quartz"></mapper>3) Quartz配置 - QuartzConfig：
@Configuration @ConditionalOnClass(QuartzScheduler.class) @ConditionalOnProperty(prefix = "quartz", name = "enabled", havingValue = "true", matchIfMissing = true) public class QuartzConfig {@Autowired(required = false)private List<CronTrigger> triggers = new ArrayList<>();@Bean@ConditionalOnMissingBean(name = "schedulerFactory")public SchedulerFactoryBean schedulerFactory(DataSource quartzDataSource, JobFactory jobFactory, DataSourceTransactionManager quartzTransactionManager) {SchedulerFactoryBean bean = new SchedulerFactoryBean();bean.setDataSource(quartzDataSource);bean.setTransactionManager(quartzTransactionManager);bean.setApplicationContextSchedulerContextKey("applicationContextKey"); // bean.setConfigLocation(new ClassPathResource("quartz.properties"));bean.setJobFactory(jobFactory);bean.setTriggers(triggers.toArray(new CronTrigger[]{}));return bean;}@Bean@ConditionalOnMissingBean(JobFactory.class)public JobFactory jobFactory() {return new AutowiringSpringBeanJobFactory();}@Bean@ConditionalOnMissingBean(ScheduleJobService.class)public ScheduleJobService scheduleJobService() {return new ScheduleJobService();}@Beanpublic ThreadPoolTaskExecutor threadPoolTaskExecutor() {ThreadPoolTaskExecutor bean = new ThreadPoolTaskExecutor();bean.setCorePoolSize(5);// 核心線程數，默認為1bean.setMaxPoolSize(50);// 最大線程數，默認為Integer.MAX_VALUEbean.setQueueCapacity(1000);// 隊列最大長度，一般需要設置值>=notifyScheduledMainExecutor.maxNum；默認為Integer.MAX_VALUEbean.setKeepAliveSeconds(300);// 線程池維護線程所允許的空閑時間，默認為60s// 線程池對拒絕任務（無線程可用）的處理策略，目前只支持AbortPolicy、CallerRunsPolicy；默認為后者// AbortPolicy:直接拋出java.util.concurrent.RejectedExecutionException異常// CallerRunsPolicy:主線程直接執行該任務，執行完之后嘗試添加下一個任務到線程池中，可以有效降低向線程池內添加任務的速度// DiscardOldestPolicy:拋棄舊的任務、暫不支持；會導致被丟棄的任務無法再次被執行// DiscardPolicy:拋棄當前任務、暫不支持；會導致被丟棄的任務無法再次被執行bean.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());return bean;}}代碼解釋:
4) 多數據源 Mybatis配置(其一) - DemoMybatisConfig：
package com.wyc.demo.config;import org.apache.ibatis.session.SqlSessionFactory; import org.mybatis.spring.SqlSessionFactoryBean; import org.mybatis.spring.SqlSessionTemplate; import org.mybatis.spring.annotation.MapperScan; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.io.Resource; import org.springframework.jdbc.datasource.DataSourceTransactionManager;import javax.sql.DataSource;/*** @author: wangyuanchen* @date: 2020-10-27 14:25* @description:*/ @Configuration @MapperScan(value = "com.wyc.demo.dao.demo", sqlSessionTemplateRef = "demoSqlSessionTemplate") public class DemoMybatisConfig {@Bean(name = "demoTransactionManager")public DataSourceTransactionManager adminTransactionManager(@Qualifier("demoDataSource") DataSource dataSource) {return new DataSourceTransactionManager(dataSource);}@Bean(name = "demoSqlSessionFactory")public SqlSessionFactory adminSqlSessionFactory(@Qualifier("demoDataSource") DataSource dataSource, @Value("${mybatis.demo.mapper-locations}") Resource[] mappers) throws Exception {SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();factoryBean.setDataSource(dataSource);factoryBean.setMapperLocations(mappers);return factoryBean.getObject();}@Bean(name = "demoSqlSessionTemplate")public SqlSessionTemplate adminSqlSessionTemplate(@Qualifier("demoSqlSessionFactory") SqlSessionFactory sqlSessionFactory) throws Exception {return new SqlSessionTemplate(sqlSessionFactory);}}6.開發流程
1) 多數據源配置 - DataSourceConfig：
@Configuration public class DataSourceConfig {@Primary@Bean("quartzDataSource")@ConfigurationProperties(prefix = "spring.datasource.druid.quartz")public DataSource quartzDataSource() {return DataSourceBuilder.create().build();}@Bean("demoDataSource")@ConfigurationProperties(prefix = "spring.datasource.druid.demo")public DataSource accountDataSource() {return DataSourceBuilder.create().build();}}2) 配置文件 - application.yml：
spring: #---------------------kafka配置--------------------- #---------------------數據源---------------------datasource:druid:quartz:driver-class-name: com.mysql.jdbc.Driverjdbc-url: jdbc:mysql://127.0.0.1:3306/quartz?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowMultiQueries=trueusername: wycpassword: 1111type: com.alibaba.druid.pool.DruidDataSourcedruid:initial-size: 20min-idle: 5max-active: 50max-wait: 60000time-between-eviction-runs-millis: 60000min-evictable-idle-time-millis: 300000test-while-idle: truetest-on-borrow: falsetest-on-return: falsepool-prepared-statements: falsemax-pool-prepared-statement-per-connection-size: 20demo:driver-class-name: com.mysql.jdbc.Driverjdbc-url: jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=false&allowMultiQueries=trueusername: wycpassword: 1111type: com.alibaba.druid.pool.DruidDataSourcedruid:initial-size: 20min-idle: 5max-active: 50max-wait: 60000time-between-eviction-runs-millis: 60000min-evictable-idle-time-millis: 300000test-while-idle: truetest-on-borrow: falsetest-on-return: falsepool-prepared-statements: falsemax-pool-prepared-statement-per-connection-size: 203) Quartz配置 - QuartzConfig：
package com.wyc.demo.config;import com.wyc.demo.quartz.support.service.ScheduleJobService; import com.wyc.demo.quartz.support.spring.AutowiringSpringBeanJobFactory; import org.quartz.CronTrigger; import org.quartz.core.QuartzScheduler; import org.quartz.spi.JobFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.jdbc.datasource.DataSourceTransactionManager; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import org.springframework.scheduling.quartz.SchedulerFactoryBean;import javax.sql.DataSource; import java.util.ArrayList; import java.util.List; import java.util.concurrent.ThreadPoolExecutor;/*** @author: wangyuanchen* @date: 2020-10-27 14:25* @description:*/ @Configuration @ConditionalOnClass(QuartzScheduler.class) @ConditionalOnProperty(prefix = "quartz", name = "enabled", havingValue = "true", matchIfMissing = true) public class QuartzConfig {@Autowired(required = false)private List<CronTrigger> triggers = new ArrayList<>();@Bean@ConditionalOnMissingBean(name = "schedulerFactory")public SchedulerFactoryBean schedulerFactory(DataSource quartzDataSource, JobFactory jobFactory, DataSourceTransactionManager quartzTransactionManager) {SchedulerFactoryBean bean = new SchedulerFactoryBean();bean.setDataSource(quartzDataSource);bean.setTransactionManager(quartzTransactionManager);bean.setApplicationContextSchedulerContextKey("applicationContextKey"); // bean.setConfigLocation(new ClassPathResource("quartz.properties"));bean.setJobFactory(jobFactory);bean.setTriggers(triggers.toArray(new CronTrigger[]{}));return bean;}@Bean@ConditionalOnMissingBean(JobFactory.class)public JobFactory jobFactory() {return new AutowiringSpringBeanJobFactory();}@Bean@ConditionalOnMissingBean(ScheduleJobService.class)public ScheduleJobService scheduleJobService() {return new ScheduleJobService();}@Beanpublic ThreadPoolTaskExecutor threadPoolTaskExecutor() {ThreadPoolTaskExecutor bean = new ThreadPoolTaskExecutor();bean.setCorePoolSize(5);// 核心線程數，默認為1bean.setMaxPoolSize(50);// 最大線程數，默認為Integer.MAX_VALUEbean.setQueueCapacity(1000);// 隊列最大長度，一般需要設置值>=notifyScheduledMainExecutor.maxNum；默認為Integer.MAX_VALUEbean.setKeepAliveSeconds(300);// 線程池維護線程所允許的空閑時間，默認為60s// 線程池對拒絕任務（無線程可用）的處理策略，目前只支持AbortPolicy、CallerRunsPolicy；默認為后者// AbortPolicy:直接拋出java.util.concurrent.RejectedExecutionException異常// CallerRunsPolicy:主線程直接執行該任務，執行完之后嘗試添加下一個任務到線程池中，可以有效降低向線程池內添加任務的速度// DiscardOldestPolicy:拋棄舊的任務、暫不支持；會導致被丟棄的任務無法再次被執行// DiscardPolicy:拋棄當前任務、暫不支持；會導致被丟棄的任務無法再次被執行bean.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());return bean;}}代碼解釋:
QuartzMybatisConfig
package com.wyc.demo.config;import org.apache.ibatis.session.SqlSessionFactory; import org.mybatis.spring.SqlSessionFactoryBean; import org.mybatis.spring.SqlSessionTemplate; import org.mybatis.spring.annotation.MapperScan; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.io.Resource; import org.springframework.jdbc.datasource.DataSourceTransactionManager;import javax.sql.DataSource;/*** @author: wangyuanchen* @date: 2020-10-27 14:25* @description:*/ @Configuration @MapperScan(value = "com.aisino.social.credit.quartz.dao", sqlSessionTemplateRef = "quartzSqlSessionTemplate") public class QuartzMybatisConfig {@Bean(name = "quartzTransactionManager")public DataSourceTransactionManager adminTransactionManager(@Qualifier("quartzDataSource") DataSource dataSource) {return new DataSourceTransactionManager(dataSource);}@Bean(name = "quartzSqlSessionFactory")public SqlSessionFactory adminSqlSessionFactory(@Qualifier("quartzDataSource") DataSource dataSource, @Value("${mybatis.quartz.mapper-locations}") Resource[] mappers) throws Exception {SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();factoryBean.setDataSource(dataSource);factoryBean.setMapperLocations(mappers);return factoryBean.getObject();}@Bean(name = "quartzSqlSessionTemplate")public SqlSessionTemplate adminSqlSessionTemplate(@Qualifier("quartzSqlSessionFactory") SqlSessionFactory sqlSessionFactory) throws Exception {return new SqlSessionTemplate(sqlSessionFactory);}}4) 多數據源 Mybatis配置(其一) - DemoMybatisConfig：
@Configuration @MapperScan(value = "com.wyc.demo.dao.demo", sqlSessionTemplateRef = "demoSqlSessionTemplate") public class DemoMybatisConfig {@Bean(name = "demoTransactionManager")public DataSourceTransactionManager adminTransactionManager(@Qualifier("demoDataSource") DataSource dataSource) {return new DataSourceTransactionManager(dataSource);}@Bean(name = "demoSqlSessionFactory")public SqlSessionFactory adminSqlSessionFactory(@Qualifier("demoDataSource") DataSource dataSource, @Value("${mybatis.demo.mapper-locations}") Resource[] mappers) throws Exception {SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();factoryBean.setDataSource(dataSource);factoryBean.setMapperLocations(mappers);return factoryBean.getObject();}@Bean(name = "demoSqlSessionTemplate")public SqlSessionTemplate adminSqlSessionTemplate(@Qualifier("demoSqlSessionFactory") SqlSessionFactory sqlSessionFactory) throws Exception {return new SqlSessionTemplate(sqlSessionFactory);}}6.開發流程
1) JobCommandLine：
package com.wyc.demo.command;import com.wyc.demo.quartz.job.DemoJob; import org.springframework.boot.CommandLineRunner; import org.springframework.stereotype.Component;import javax.annotation.Resource;/*** @author: wangyuanchen* @date: 2020-10-30 08:54* @description:*/ @Component public class JobCommandLine implements CommandLineRunner {@Resourceprivate DemoJob demoJob;@Overridepublic void run(String... args) throws Exception {demoJob.startJob();} }代碼解釋:
2) Job：
public interface Job {void execute(JobExecutionContext var1) throws JobExecutionException; }代碼解釋:
3) CommonAbstractJob：
package com.wyc.demo.quartz.support;import com.wyc.demo.entity.ScheduleJob; import com.wyc.demo.enums.JobGroupType; import com.wyc.demo.quartz.support.service.ScheduleJobService; import org.quartz.Job; import org.quartz.JobDataMap; import org.slf4j.Logger; import org.slf4j.LoggerFactory;import javax.annotation.Resource; import java.text.SimpleDateFormat; import java.util.Date;/*** @author: wangyuanchen* @date: 2020-10-27 14:41* @description:不可直接繼承此類,參考 {@link SimpleAbstractJob}*/ abstract class CommonAbstractJob implements Job {@Resourceprotected ScheduleJobService scheduleJobService;private static final SimpleDateFormat CRON_FORMAT = new SimpleDateFormat("ss mm HH dd MM ? yyyy");protected final Logger logger = LoggerFactory.getLogger(getClass());/*** 獲取JobGroup* @return*/public abstract JobGroupType getJobGroup();/*** 獲取cron表達式 ** @param date* @return*/public String parseCronExpression(Date date) {return CRON_FORMAT.format(date);}protected void enableSchedule(ScheduleJob job, JobDataMap jobDataMap) throws Exception {scheduleJobService.enableSchedule(job, jobDataMap);}public String getJobGroupString(){return getJobGroup().getCode();}}代碼解釋:
這個方法是什么意思呢？進入到ScheduleJobService中看一下便知曉了。
4) ScheduleJobService：
package com.wyc.demo.quartz.support.listener;import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.quartz.JobListener; import org.quartz.SchedulerException;/*** @author: wangyuanchen* @date: 2020-10-27 15:40* @description:用于立即觸發的任務執行后取消定時器*/ public class RemoveAfterRunListener implements JobListener {private int state = 0;@Overridepublic String getName() {return RemoveAfterRunListener.class.getName();}@Overridepublic void jobExecutionVetoed(JobExecutionContext arg0) {}@Overridepublic void jobToBeExecuted(JobExecutionContext arg0) {}@Overridepublic void jobWasExecuted(JobExecutionContext context, JobExecutionException arg1) {try {state = 1;context.getScheduler().deleteJob(context.getJobDetail().getKey());} catch (SchedulerException e) {throw new RuntimeException();}}public int getState() {return state;}} package com.wyc.demo.quartz.support.spring;import org.quartz.spi.TriggerFiredBundle; import org.springframework.beans.BeansException; import org.springframework.beans.factory.config.AutowireCapableBeanFactory; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.scheduling.quartz.SpringBeanJobFactory;/*** @author: wangyuanchen* @date: 2020-10-27 15:38* @description:*/ public class AutowiringSpringBeanJobFactory extends SpringBeanJobFactory implements ApplicationContextAware {private ApplicationContext applicationContext;private AutowireCapableBeanFactory autowireCapableBeanFactory;@Overrideprotected Object createJobInstance(final TriggerFiredBundle bundle) throws Exception {Object job = applicationContext.getBean(bundle.getJobDetail().getJobClass());if (job == null) {job = super.createJobInstance(bundle);autowireCapableBeanFactory.autowireBean(job);}return job;}@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {this.applicationContext = applicationContext;autowireCapableBeanFactory = applicationContext.getAutowireCapableBeanFactory();}} package com.wyc.demo.quartz.support.service;import com.google.common.collect.Sets; import com.wyc.demo.entity.ScheduleJob; import com.wyc.demo.quartz.support.listener.RemoveAfterRunListener; import org.quartz.*; import org.quartz.impl.matchers.KeyMatcher; import org.quartz.impl.triggers.CalendarIntervalTriggerImpl; import org.quartz.impl.triggers.CronTriggerImpl; import org.quartz.impl.triggers.DailyTimeIntervalTriggerImpl; import org.quartz.impl.triggers.SimpleTriggerImpl; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier;/*** @author: wangyuanchen* @date: 2020-10-27 15:42* @description:*/ public class ScheduleJobService {@Autowired@Qualifier("schedulerFactory")private Scheduler scheduler;/*** 啟用定時任務或重設定時任務的觸發時間** @param job* @param jobDataMap* @throws Exception*/public void enableSchedule(ScheduleJob job, JobDataMap jobDataMap) throws Exception {if (job == null) {return;}JobDetail jobDetail = JobBuilder.newJob(job.getJobExecuteClass()).withIdentity(job.getJobName(), job.getJobGroup().getCode()).withDescription(job.getJobGroup().getDesc()).build();if (jobDataMap != null) {jobDetail.getJobDataMap().putAll(jobDataMap);}//表達式調度構建器CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(job.getCronExpression());//按新的cronExpression表達式構建一個新的triggerTrigger trigger = TriggerBuilder.newTrigger().withIdentity(job.getTriggerName(), job.getJobGroup().getCode()).withSchedule(scheduleBuilder).withDescription(job.getJobGroup().getDesc()).build();Trigger exists = scheduler.getTrigger(trigger.getKey());if (exists != null) {if (exists instanceof CronTriggerImpl) {((CronTriggerImpl) trigger).setPreviousFireTime(exists.getPreviousFireTime());} else if (exists instanceof CalendarIntervalTriggerImpl) {((CalendarIntervalTriggerImpl) trigger).setPreviousFireTime(exists.getPreviousFireTime());} else if (exists instanceof DailyTimeIntervalTriggerImpl) {((DailyTimeIntervalTriggerImpl) trigger).setPreviousFireTime(exists.getPreviousFireTime());} else if (exists instanceof SimpleTriggerImpl) {((SimpleTriggerImpl) trigger).setPreviousFireTime(exists.getPreviousFireTime());}}scheduler.scheduleJob(jobDetail, Sets.newHashSet(trigger), true);}/*** 刪除定時任務** @param jobName* @param jobGroup* @throws Exception*/public void removeSchedule(String jobName, String jobGroup) throws Exception {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.pauseJob(jobKey);scheduler.deleteJob(jobKey);}/*** 刪除定時任務** @param keys:jobGroup.jobName* @throws Exception*/public void removeSchedule(String keys) throws Exception {String[] arr = keys.split("[.]");String jobName = arr[1];String jobGroup = arr[0];removeSchedule(jobName, jobGroup);}/*** 立即執行定時任務** @param jobName* @param jobGroup* @param delete* @param block* @throws Exception*/public void execSchedule(String jobName, String jobGroup, JobDataMap jobDataMap, boolean delete, boolean block) throws Exception {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.triggerJob(jobKey, jobDataMap);RemoveAfterRunListener afterExecListener = new RemoveAfterRunListener();if (delete) {//如果要執行完后立即取消定時器scheduler.getListenerManager().addJobListener(afterExecListener, KeyMatcher.keyEquals(jobKey));}if (block) {//如果要阻塞等待回調結果long start = System.currentTimeMillis();int state = afterExecListener.getState();while (state != 1 && (System.currentTimeMillis() - start) < 1000L) {state = afterExecListener.getState();}}}/*** 暫停定時任務** @param jobName* @param jobGroup* @throws Exception*/public void pauseSchedule(String jobName, String jobGroup) throws Exception {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.pauseJob(jobKey);}/*** 恢復定時任務** @param jobName* @param jobGroup* @throws Exception*/public void resumeSchedule(String jobName, String jobGroup) throws Exception {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);scheduler.resumeJob(jobKey);}/*** 根據jobName和jobGroup獲取jobDataMap** @param jobName* @param jobGroup* @return* @throws Exception*/public JobDataMap getJobDataMap(String jobName, String jobGroup) throws Exception {JobKey jobKey = JobKey.jobKey(jobName, jobGroup);JobDetail jobDetail = scheduler.getJobDetail(jobKey);JobDataMap jobDataMap = null;if (jobDetail != null) {jobDataMap = jobDetail.getJobDataMap();}return jobDataMap;}}代碼解釋:
1.在講解enableSchedule方法之前，我想先講解一下Scheduler是怎么被注入的。打開QuartzConfig配置類，如下：
代碼解釋:
代碼解釋:
代碼解釋:
此方法的作用就是使用ScheduleFactory(ScheduleFactory在此類中的initSchedulerFactory方法初始化生成，是StdSchedulerFactory類型的)生成Scheduler。
總結:
下面回過頭來繼續看ScheduleJobService中的enableSchedule方法：
代碼解釋:
Quartz四大概念中的最后二位登場了，它就是JobDetail和Trigger，在這個方法中，將設置JobDetail程序和Trigger觸發器并且將其放入Scheduler容器執行。
5) SimpleAbstractJob：
package com.wyc.demo.quartz.support;import com.wyc.demo.entity.ScheduleJob; import org.quartz.JobDataMap;/*** @author: wangyuanchen* @date: 2020-10-27 14:41* @description:*/ public abstract class SimpleAbstractJob extends CommonAbstractJob {/*** 獲取執行表達式* @return*/public abstract String getCronExpression();/*** 獲取JobDataMap* @return*/public abstract JobDataMap getJobDataMap();/*** 獲取JobName* @return*/public abstract String getJobName();public void startJob() throws Exception {String cronExpression = getCronExpression();//jobName不要包含時間戳,和group不能同時重復ScheduleJob job = new ScheduleJob(getJobName(), getJobGroup(), cronExpression, getClass());enableSchedule(job, getJobDataMap());logger.info("---設置完成:{}---", cronExpression);}/*** 停止定時器 ** @throws Exception*/public void stopJob() throws Exception {scheduleJobService.removeSchedule(getJobName(), getJobGroupString());}/*** 立即運行定時器 ** @param delete* @param block* @throws Exception*/public void runJob(boolean delete, boolean block) throws Exception {scheduleJobService.execSchedule(getJobName(), getJobGroupString(), getJobDataMap(), delete, block);}}代碼解釋:
JobGroupType
package com.wyc.demo.enums; /*** @author: wangyuanchen* @date: 2020-10-27 14:25* @description:*/ public enum JobGroupType {DEMO_JOB("DEMO_JOB", "示例定時任務"),TEST_JOB("TEST_JOB", "測試定時任務");private String code;private String desc;private JobGroupType(String code, String desc) {this.code = code;this.desc = desc;}public String getCode() {return code;}public void setCode(String code) {this.code = code == null ? null : code.trim();}public String getDesc() {return desc;}public void setDesc(String desc) {this.desc = desc == null ? null : desc.trim();} }6) DemoJob：
package com.wyc.demo.quartz.job;import com.wyc.demo.enums.JobGroupType; import com.wyc.demo.quartz.support.SimpleAbstractJob; import org.quartz.JobDataMap; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component;import java.text.SimpleDateFormat; import java.util.Date;/*** @author: wangyuanchen* @date: 2020-10-27 14:41* @description:*/ @Component public class DemoJob extends SimpleAbstractJob {private static Logger logger = LoggerFactory.getLogger(DemoJob.class);private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");private String cronExpression = "0 0/1 * * * ?";@Overridepublic void execute(JobExecutionContext context) throws JobExecutionException {Date nowTime = new Date();logger.info("Demo-定時器===>執行Demo-定時任務開始，當前時間:{}", DATE_FORMAT.format(nowTime));}@Overridepublic String getCronExpression() {return cronExpression;}@Overridepublic JobDataMap getJobDataMap() {return null;}@Overridepublic String getJobName() {return getClass().getSimpleName();}@Overridepublic JobGroupType getJobGroup() {return JobGroupType.DEMO_JOB;}}代碼解釋:
總結：
源碼地址:github_quartz_demo
總結
以上是生活随笔為你收集整理的SpringBoot与quartz框架实现分布式定时任务的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： q为什么叫皮蛋？
- 下一篇： gradle idea java ssm