springboot+quartz如何實(shí)現(xiàn)定時(shí)任務(wù)

發(fā)布時(shí)間：2020-07-30 10:57:44 來源：億速云閱讀：222 作者：小豬欄目：開發(fā)技術(shù)

這篇文章主要為大家展示了springboot+quartz如何實(shí)現(xiàn)定時(shí)任務(wù)，內(nèi)容簡(jiǎn)而易懂，希望大家可以學(xué)習(xí)一下，學(xué)習(xí)完之后肯定會(huì)有收獲的，下面讓小編帶大家一起來看看吧。

首先

在springboot項(xiàng)目里做定時(shí)任務(wù)是比較簡(jiǎn)單的，最簡(jiǎn)單的實(shí)現(xiàn)方式是使用**@Scheduled注解，然后在application啟動(dòng)類上使用@EnableScheduling**開啟定時(shí)任務(wù)。

示例

@SpringBootApplication
@EnableScheduling
public class Application {

 public static void main(String[] args) {
 SpringApplication.run(Application.class, args);
 }
 // cron為每秒執(zhí)行一次
 @Scheduled(cron = "* * * * * &#63;")
 public void print(){
 System.out.println("執(zhí)行定時(shí)任務(wù)");
 }

}

######結(jié)果

執(zhí)行定時(shí)任務(wù)
執(zhí)行定時(shí)任務(wù)
執(zhí)行定時(shí)任務(wù)
執(zhí)行定時(shí)任務(wù)
執(zhí)行定時(shí)任務(wù)
執(zhí)行定時(shí)任務(wù)
執(zhí)行定時(shí)任務(wù)
執(zhí)行定時(shí)任務(wù)

簡(jiǎn)單的定時(shí)任務(wù)就可以用這種方式來做，cron表達(dá)式的結(jié)果為任務(wù)執(zhí)行的間隔時(shí)間。

然而

實(shí)際開發(fā)中，我們的任務(wù)可能有很多，且需要手動(dòng)操作單個(gè)/全部的任務(wù)，比如添加、開啟、停止、繼續(xù)等等操作。那么伴隨著(千牛B類。。。)的BGM有請(qǐng)quartz登場(chǎng)。

quartz

整合

 <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-quartz</artifactId>
 </dependency>

quartz的三要素

調(diào)度器Scheduler
啟動(dòng)觸發(fā)器去執(zhí)行任務(wù)
觸發(fā)器Trigger

用來定義Job（任務(wù)）觸發(fā)條件、觸發(fā)時(shí)間，觸發(fā)間隔，終止時(shí)間等

任務(wù)job

具體要執(zhí)行的任務(wù)內(nèi)容

使用

使用quartz是需要配置文件的，quartz.properties在quartz的jar包的org.quartz包下可以找到默認(rèn)的配置文件quartz.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.scheduler.instanceName: DefaultQuartzScheduler
org.quartz.scheduler.rmi.export: false
org.quartz.scheduler.rmi.proxy: false
org.quartz.scheduler.wrapJobExecutionInUserTransaction: false
# 實(shí)例化ThreadPool時(shí)，使用的線程類為SimpleThreadPool
org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
# 線程總個(gè)數(shù)
org.quartz.threadPool.threadCount: 10
# 線程的優(yōu)先級(jí)
org.quartz.threadPool.threadPriority: 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true

org.quartz.jobStore.misfireThreshold: 60000
# 持久化方式，默認(rèn)持久化在內(nèi)存中，后面我們使用db的方式
org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore

quartz任務(wù)持久化到db則需要一些官方定義的數(shù)據(jù)庫表，表的sql文件可以在quartz的jar包里找到

坐標(biāo)org.quartz.impl.jdbcjobstore，可以看到里面有很多sql文件，有各種數(shù)據(jù)庫的，咱們用MySQL的，咱們不需要手動(dòng)執(zhí)行sql語句，后面咱們?cè)趩?dòng)項(xiàng)目的時(shí)候自動(dòng)初始化。

創(chuàng)建我們自己的properties文件

# 實(shí)例化ThreadPool時(shí)，使用的線程類為SimpleThreadPool
org.quartz.threadPool.class=org.quartz.simpl.SimpleThreadPool
# threadCount和threadPriority將以setter的形式注入ThreadPool實(shí)例
# 并發(fā)個(gè)數(shù)
org.quartz.threadPool.threadCount=10
# 優(yōu)先級(jí)
org.quartz.threadPool.threadPriority=5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread=true
org.quartz.jobStore.misfireThreshold=5000
#持久化使用的類
org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX
#數(shù)據(jù)庫中表的前綴
org.quartz.jobStore.tablePrefix=QRTZ_
#數(shù)據(jù)源命名
org.quartz.jobStore.dataSource=qzDS
#qzDS 數(shù)據(jù)源，我們使用hikaricp，默認(rèn)的是c3p0
org.quartz.dataSource.qzDS.provider=hikaricp
org.quartz.dataSource.qzDS.driver=com.mysql.cj.jdbc.Driver
org.quartz.dataSource.qzDS.URL=jdbc:mysql://localhost:3306/quartz&#63;useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
org.quartz.dataSource.qzDS.user=root
org.quartz.dataSource.qzDS.password=123456
org.quartz.dataSource.qzDS.maxConnections=10

既然我們沒有使用默認(rèn)的連接池，那么就探索一下，上源碼！在這個(gè)包下：org.quartz.utils，有一個(gè)PoolingConnectionProvider，顧名思義，連接池提供者部分源碼

public interface PoolingConnectionProvider extends ConnectionProvider {

 /** The pooling provider. */
 String POOLING_PROVIDER = "provider";

 /** The c3p0 pooling provider. */
 String POOLING_PROVIDER_C3P0 = "c3p0";

 /** The Hikari pooling provider. */
 String POOLING_PROVIDER_HIKARICP = "hikaricp";

}

然后HikariCpPoolingConnectionProvider這個(gè)類實(shí)現(xiàn)了PoolingConnectionProvider，自行查看。我們可以在org.quartz.impl下的StdSchedulerFactory中搜索c3p0找到

if(poolingProvider != null && poolingProvider.equals(PoolingConnectionProvider.POOLING_PROVIDER_HIKARICP)) {
   cpClass = "org.quartz.utils.HikariCpPoolingConnectionProvider";
   }
   else {
   cpClass = "org.quartz.utils.C3p0PoolingConnectionProvider";
   }

剩下的自己多看看吧，起始源碼研究起來沒有想象中那么難那么乏味(我也不喜歡看源碼)，但是這個(gè)源碼看起來確實(shí)小有成就感。

回到正題頻道，配置application.yml

spring:
 datasource:
 driver-class-name: com.mysql.cj.jdbc.Driver
 password: 123456
 url: jdbc:mysql://localhost:3306/quartz&#63;characterEncoding=UTF8&useSSL=false&serverTimezone=GMT%2B8
 username: root
 quartz:
 jdbc:
 initialize-schema: always
 job-store-type: jdbc

initialize-schema: always每次啟動(dòng)項(xiàng)目，總是初始化數(shù)據(jù)庫表自動(dòng)創(chuàng)建表的關(guān)鍵地方，流程是先刪除數(shù)據(jù)庫表，再創(chuàng)建，如果表不存在，則拋異常，但是不會(huì)影響后面的生成表，下次再啟動(dòng)項(xiàng)目的時(shí)候，由于表已經(jīng)存在了，所以不會(huì)再拋異常了job-store-type: jdbc就是任務(wù)持久化類型，我們用jdbc

我們可能要在job里注入spring對(duì)象，不做配置，是無法注入的。

/**
 * @author: taoym
 * @date: 2020/6/4 11:32
 * @desc: 一定要自定義JobFactory重寫SpringBeanJobFactory的createJobInstance方法，否則在job中是獲取不到spring容器中的bean的
 */
@Component
public class JobFactory extends SpringBeanJobFactory {

 @Autowired
 private AutowireCapableBeanFactory beanFactory;

 /**
 * 這里覆蓋了super的createJobInstance方法，對(duì)其創(chuàng)建出來的類再進(jìn)行autowire
 */
 @Override
 protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
 Object jobInstance = super.createJobInstance(bundle);
 beanFactory.autowireBean(jobInstance);
 return jobInstance;
 }
}

創(chuàng)建quartz的配置文件

@Configuration
public class QuartzConfig {

 @Autowired
 private JobFactory jobFactory;

 /**
 * 讀取quartz.properties 文件
 * 將值初始化
 *
 * @return
 */
 @Bean
 public Properties quartzProperties() 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.setJobFactory(jobFactory);
 schedulerFactoryBean.setQuartzProperties(quartzProperties());
 return schedulerFactoryBean;
 }

 /**
 * 初始化監(jiān)聽器
 *
 * @return
 */
 @Bean
 public QuartzInitializerListener executorListener() {
 return new QuartzInitializerListener();
 }


 @Bean(name = "scheduler")
 public Scheduler scheduler() throws IOException {
 return schedulerFactoryBean().getScheduler();
 }
}

創(chuàng)建觸發(fā)器組件

public class TriggerComponent {

 /**
 * @author: taoym
 * @date: 2020/6/1 10:35
 * @desc: 構(gòu)建cron觸發(fā)器
 */
 public static Trigger cronTrigger(String cron) {
 CronTrigger cronTrigger = TriggerBuilder.newTrigger()
  .withSchedule(CronScheduleBuilder.cronSchedule(cron).withMisfireHandlingInstructionDoNothing())
  .build();
 return cronTrigger;
 }

 public static Trigger cronTrigger(String cron, JobDataMap jobDataMap) {
 CronTrigger cronTrigger = TriggerBuilder.newTrigger()
  .withSchedule(CronScheduleBuilder.cronSchedule(cron).withMisfireHandlingInstructionDoNothing())
  .usingJobData(jobDataMap)
  .build();
 return cronTrigger;
 }
}

觸發(fā)器就用這個(gè)組件來獲取就行了。

創(chuàng)建任務(wù)

@DisallowConcurrentExecution
public class TestJob extends QuartzJobBean {
 @Override
 protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
 
 }
}

jobExecutionContext這里面可以獲取任務(wù)組、任務(wù)名、觸發(fā)器組、觸發(fā)器名、jobdetail等信息。那個(gè)注解是為了讓同一個(gè)實(shí)例(jobdetail)只能單線程執(zhí)行?？梢赃@么理解，job為接口，jobdetail為實(shí)現(xiàn)類，a是其中一個(gè)實(shí)現(xiàn)類，a需要花費(fèi)100s執(zhí)行一定的操作，而你給的定時(shí)器是沒50s就執(zhí)行一次操作，a在執(zhí)行到一半的時(shí)候又需要開啟一個(gè)線程來執(zhí)行。使用了DisallowConcurrentExecution就相當(dāng)于a沒有把操作執(zhí)行完的時(shí)候，a不允許開啟線程再執(zhí)行當(dāng)前操作。不知道我的描述是否易懂！

按需創(chuàng)建自己的任務(wù)表，我是用定時(shí)任務(wù)做爬蟲的(小爬蟲)

CREATE TABLE `quartz_job` (
 `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '編號(hào)',
 `job_name` varchar(50) DEFAULT '' COMMENT '任務(wù)名',
 `job_group` varchar(50) DEFAULT '' COMMENT '任務(wù)組名稱',
 `job_desc` varchar(255) DEFAULT '' COMMENT 'job描述',
 `cron` varchar(50) DEFAULT '' COMMENT 'cron表達(dá)式',
 `status` tinyint(1) DEFAULT '0' COMMENT '狀態(tài)',
 `url` varchar(255) DEFAULT '' COMMENT '請(qǐng)求地址',
 `param` varchar(255) DEFAULT '' COMMENT '參數(shù)',
 PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=31 DEFAULT CHARSET=utf8;

我們添加任務(wù)的時(shí)候不和quartz打交道，把任務(wù)放到數(shù)據(jù)庫即可。別慌，后面有用到他的地方。這個(gè)表需要有增刪改查操作，我們會(huì)在系統(tǒng)中查詢?nèi)蝿?wù)列表選擇單個(gè)或者所有任務(wù)開始執(zhí)行

執(zhí)行任務(wù)

@Resource
 private QuartzJobMapper quartzJobMapper;
 @Autowired
 private Scheduler scheduler;
 
 
 @Override
 public String start(Integer id) {
 
		JobDataMap jobDataMap = new JobDataMap();
 jobDataMap.put(k,v);
 
 QuartzJob quartzJob = quartzJobMapper.selectByPrimaryKey(id);
 
 JobKey jobKey = JobKey.jobKey(quartzJob.getJobName(), quartzJob.getJobGroup());
 
 jobDetail = JobBuilder.newJob(TestJob.class).withIdentity(jobKey).storeDurably().build();
 
 Trigger trigger = TriggerComponent.cronTrigger(quartzJob.getCron(), jobDataMap);
 try {
  scheduler.scheduleJob(jobDetail, trigger);
  quartzJobMapper.updateStatus(true, id);
  return "開始任務(wù)執(zhí)行成功";
 } catch (SchedulerException se) {
  log.info("開始任務(wù)的時(shí)候發(fā)生了錯(cuò)誤");
 }
 return "開始任務(wù)的時(shí)候發(fā)生了錯(cuò)誤,請(qǐng)檢查日志";
 }

最后我又按照此教程上的內(nèi)容粘貼了一遍代碼，可以正常運(yùn)行。

springboot+quartz如何實(shí)現(xiàn)定時(shí)任務(wù)