一、quartz的基本認識

1. 什么是quartz

從quartz的官網(wǎng)可首頁可以看到對quartz的簡單介紹，下面翻譯成中文，大概就是這樣：        

Quartz是一個功能豐富的開源作業(yè)調(diào)度庫，幾乎可以集成到任何Java應(yīng)用程序中——從最小的獨立應(yīng)用程序到最大的電子商務(wù)系統(tǒng)。

Quartz可用于創(chuàng)建簡單或復(fù)雜的時間表，以執(zhí)行數(shù)十個、數(shù)百個甚至數(shù)萬個作業(yè)；其任務(wù)被定義為標準Java組件的作業(yè)，這些組件可以執(zhí)行幾乎任何您可以對其進行編程的操作。

Quartz調(diào)度器包括許多企業(yè)級功能，例如支持JTA事務(wù)和集群。

2. quartz的基本組件

從上圖可以看出，quartz主要包含了3個基本組件：Scheduler、Job和Trigger，其中， Job部分包含了組件Job、JobDetail和JobBuilder，Trigger部分包含了Trigger和TriggerBuilder。

一個設(shè)計良好的組件或者框架，必然會遵守組件的職責(zé)區(qū)分，單一職責(zé)原則是面向?qū)ο蟮囊粋€重要特性，不僅在編碼中需要注意，在組件或者框架的設(shè)計中也必然需要考慮到這一點。

首先是Job。

• Job從字面意思上理解，就是一項工作或者任務(wù)，也就是定時任務(wù)的“任務(wù)”具體需要做什么，在quartz中，Job是一個接口，且只定義了一個方法execut()，把任務(wù)需要處理的邏輯寫在execute方法中。
• 同時我們需要注意的一點是，Job是無狀態(tài)的，也就是Job是可以復(fù)用的，那么Job需要的信息從哪里來呢？
• 答案是從JobDetail中獲取，JobDetail有一個重要的方法getJobDataMap()，調(diào)用這個方法可以獲取到任務(wù)需要的相關(guān)信息，當(dāng)然這些信息一般是創(chuàng)建Job的時候設(shè)定的。
• 現(xiàn)在引申出另外一個問題，那就是如何創(chuàng)建一個Job？
• 一想到創(chuàng)建，我們肯定會想到建造者模式，quartz就使用JobBuilder來創(chuàng)建Job，并設(shè)定Job需要的相關(guān)信息。

然后看Trigger。

• 我們定義完任務(wù)之后，那么什么時候觸發(fā)呢？
• 所以我們需要一個“任務(wù)觸發(fā)器”，來定時觸發(fā)Job。
• 比如：每多少分鐘執(zhí)行一次，或者根據(jù)cron表達式來定時執(zhí)行等等。
• 那么TriggerBuilder就是用來協(xié)助創(chuàng)建Trigger的類。

最后是Scheduler。

• 現(xiàn)在任務(wù)和觸發(fā)器都有了，那么誰來調(diào)度呢？
• 這時候就需要一個調(diào)度器了，調(diào)度器負責(zé)協(xié)調(diào)任務(wù)和觸發(fā)器，當(dāng)觸發(fā)任務(wù)時，把上下文傳遞給具體的任務(wù)，任務(wù)拿到上下文，執(zhí)行任務(wù)。

二、quartz實戰(zhàn)

1. quartz的基本使用

public class SimpleQuartzTest {
 
    public static void main(String[] args) throws Exception{
        Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
        scheduler.start();
 
        JobDetail jobDetail = JobBuilder.newJob(MySimpleJob.class)
                .withIdentity("myJob", "myGroup")
                .usingJobData("customJobData", "Hello world!")
                .build();
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("myTrigger", "myGroup")
                .startNow()
                .withSchedule(SimpleScheduleBuilder.repeatSecondlyForever(10))
                .build();
 
        scheduler.scheduleJob(jobDetail, trigger);
    }
}

public class MySimpleJob implements Job {
    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println(">>>>>>>>>>>>>>>>");
        System.out.println("當(dāng)前時間是：" + LocalDateTime.now().toString());
        System.out.println("MySimpleJob開始運行了");
        JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
        System.out.println("從上下文中獲取到的數(shù)據(jù)：customJobData: " + jobDataMap.getString("customJobData") );
        System.out.println(">>>>>>>>>>>>>>>>");
        System.out.println();
        System.out.println();
    }
}

quartz的基本使用還是比較簡單的，此時任務(wù)信息是保存在內(nèi)存中的，如上面截圖所示。在實際項目中，我們基本不會使用這種保存在內(nèi)存中的方式，一個很簡單的原因是：如果服務(wù)down掉，任務(wù)執(zhí)行情況就消失了，這是不允許的。

所以接下來看使用使用數(shù)據(jù)庫保存任務(wù)信息的實現(xiàn)方式。

2. SpringBoot使用quartz

SpringBoot使用quartz方式實現(xiàn)也不復(fù)雜，我們使用的SpringBoot版本是2.6.3。

首先引入依賴：

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

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/quartz_test?useSSL=false&defualtTimeZone=UTC
spring.datasource.username=root
spring.datasource.password=root
 
spring.quartz.job-store-type=jdbc
spring.quartz.auto-startup=true
spring.quartz.jdbc.initialize-schema=embedded
spring.quartz.properties.org.quartz.scheduler.instanceName=MyScheduler
spring.quartz.properties.org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX
spring.quartz.properties.org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
spring.quartz.properties.org.quartz.jobStore.isClustered=true
spring.quartz.properties.org.quartz.jobStore.useProperties=false

啟動項目，發(fā)現(xiàn)報錯：

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'quartzScheduler' defined in class path resource [org/springframework/boot/autoconfigure/quartz/QuartzAutoConfiguration.class]: Invocation of init method failed; nested exception is org.quartz.SchedulerConfigException: DataSource name not set.
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1804) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:620) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:542) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:335) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:234) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:333) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:934) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:918) ~[spring-context-5.3.15.jar:5.3.15]
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:583) ~[spring-context-5.3.15.jar:5.3.15]
    at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:145) ~[spring-boot-2.6.3.jar:2.6.3]
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:732) ~[spring-boot-2.6.3.jar:2.6.3]
    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:414) ~[spring-boot-2.6.3.jar:2.6.3]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:302) ~[spring-boot-2.6.3.jar:2.6.3]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1303) ~[spring-boot-2.6.3.jar:2.6.3]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1292) ~[spring-boot-2.6.3.jar:2.6.3]
    at com.example.springbootdemo.SpringbootdemoApplication.main(SpringbootdemoApplication.java:10) ~[classes/:na]
Caused by: org.quartz.SchedulerConfigException: DataSource name not set.
    at org.quartz.impl.jdbcjobstore.JobStoreSupport.initialize(JobStoreSupport.java:643) ~[quartz-2.3.2.jar:na]
    at org.quartz.impl.jdbcjobstore.JobStoreTX.initialize(JobStoreTX.java:57) ~[quartz-2.3.2.jar:na]
    at org.quartz.impl.StdSchedulerFactory.instantiate(StdSchedulerFactory.java:1368) ~[quartz-2.3.2.jar:na]
    at org.quartz.impl.StdSchedulerFactory.getScheduler(StdSchedulerFactory.java:1579) ~[quartz-2.3.2.jar:na]
    at org.springframework.scheduling.quartz.SchedulerFactoryBean.createScheduler(SchedulerFactoryBean.java:679) ~[spring-context-support-5.3.15.jar:5.3.15]
    at org.springframework.scheduling.quartz.SchedulerFactoryBean.prepareScheduler(SchedulerFactoryBean.java:616) ~[spring-context-support-5.3.15.jar:5.3.15]
    at org.springframework.scheduling.quartz.SchedulerFactoryBean.afterPropertiesSet(SchedulerFactoryBean.java:504) ~[spring-context-support-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1863) ~[spring-beans-5.3.15.jar:5.3.15]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1800) ~[spring-beans-5.3.15.jar:5.3.15]
    ... 16 common frames omitted

實際上在較舊版本的SpringBoot同樣的配置是不會出現(xiàn)這樣的問題的，根據(jù)出錯信息查看相關(guān)的源碼，發(fā)現(xiàn)問題出在這里：

當(dāng)我們設(shè)置了屬性org.quartz.jobStore.class之后，即使我們配置了本地數(shù)據(jù)源，也不會使用本地數(shù)據(jù)源，而是我們之前配置的 org.quartz.impl.jdbcjobstore.JobStoreTX，在舊版本的SpringBoot是直接put，所以配置org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX并不會產(chǎn)生問題。

那么解決問題就很簡單了，在application.properties文件中把這一行刪除就可以了。

重新啟動項目，發(fā)現(xiàn)現(xiàn)在quartz已經(jīng)使用了本地數(shù)據(jù)源了。

3. SpringBoot使用自定義數(shù)據(jù)源時，集成quartz 

在實際項目中，我們很可能是使用自定義的數(shù)據(jù)源，而不是SpringBoot自動生成的，那么在這種情況下，我們又應(yīng)該如何實現(xiàn)呢？

首先，我們不能引入spring-boot-starter-quartz依賴，但是以下依賴我們需要引入：

		<dependency>
			<groupId>org.quartz-scheduler</groupId>
			<artifactId>quartz</artifactId>
			<version>2.3.2</version>
		</dependency>
 
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context-support</artifactId>
			<version>5.3.15</version>
		</dependency>

接下來就是寫一個配置類，來生成一個SchedulerFactoryBean：

@Configuration
public class QuartzConfig {
 
    @Autowired
    private DataSource dataSource;
 
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean () {
        SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();
        schedulerFactoryBean.setDataSource(dataSource);
        schedulerFactoryBean.setConfigLocation(new ClassPathResource("quartz.properties"));
        return schedulerFactoryBean;
    }
}

劃重點：

不要在quartz.properties文件中配置：org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX

然后啟動項目，就可以啦。

總結(jié)

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論