基于spring quartz的定時(shí)任務(wù) 之 配置篇

數(shù)據(jù)庫(kù)相關(guān)表

1.數(shù)據(jù)庫(kù)表的位置

我在官網(wǎng)的文檔沒有找到，只能下載他的jar.gz包。 在org/quartz/impl/jdbcjobstore文件夾下找到了表
官網(wǎng)資源包下載地址

image.png

注意1：相應(yīng)依賴包版本
注意2：根據(jù)自己的數(shù)據(jù)庫(kù)類型，選擇相應(yīng)腳本就行

2. Quartz將Job保存在數(shù)據(jù)庫(kù)中所需表的說(shuō)明

  • QRTZ_CALENDARS 以 Blob 類型存儲(chǔ) Quartz 的 Calendar 信息

  • QRTZ_CRON_TRIGGERS 存儲(chǔ) Cron Trigger，包括 Cron表達(dá)式和時(shí)區(qū)信息

  • QRTZ_FIRED_TRIGGERS 存儲(chǔ)與已觸發(fā)的 Trigger 相關(guān)的狀態(tài)信息，以及相聯(lián) Job的執(zhí)行信息 QRTZ_PAUSED_TRIGGER_GRPS 存儲(chǔ)已暫停的 Trigger 組的信息

  • QRTZ_SCHEDULER_STATE 存儲(chǔ)少量的有關(guān) Scheduler 的狀態(tài)信息，和別的 Scheduler實(shí)例(假如是用于一個(gè)集群中)

  • QRTZ_LOCKS 存儲(chǔ)程序的悲觀鎖的信息(假如使用了悲觀鎖)

  • QRTZ_JOB_DETAILS 存儲(chǔ)每一個(gè)已配置的 Job 的詳細(xì)信息

  • QRTZ_JOB_LISTENERS 存儲(chǔ)有關(guān)已配置的 JobListener 的信息

  • QRTZ_SIMPLE_TRIGGERS 存儲(chǔ)簡(jiǎn)單的Trigger，包括重復(fù)次數(shù)，間隔，以及已觸的次數(shù)

  • QRTZ_BLOG_TRIGGERS Trigger 作為 Blob 類型存儲(chǔ)(用于 Quartz 用戶用 JDBC創(chuàng)建他們自己定制的 Trigger 類型，JobStore 并不知道如何存儲(chǔ)實(shí)例的時(shí)候)

  • QRTZ_TRIGGER_LISTENERS 存儲(chǔ)已配置的 TriggerListener 的信息

  • QRTZ_TRIGGERS 存儲(chǔ)已配置的 Trigger 的信息

3.quartz 持久化數(shù)據(jù)庫(kù)表格字段解釋

介紹下主要的幾張表：

  • 表qrtz_job_details: 保存job詳細(xì)信息,該表需要用戶根據(jù)實(shí)際情況初始化
    job_name:集群中job的名字,該名字用戶自己可以隨意定制,無(wú)強(qiáng)行要求
    job_group:集群中job的所屬組的名字,該名字用戶自己隨意定制,無(wú)強(qiáng)行要求
    job_class_name:集群中個(gè)note job實(shí)現(xiàn)類的完全包名,quartz就是根據(jù)這個(gè)路徑到classpath找到該job類
    is_durable:是否持久化,把該屬性設(shè)置為1，quartz會(huì)把job持久化到數(shù)據(jù)庫(kù)中
    job_data:一個(gè)blob字段，存放持久化job對(duì)象
  • 表qrtz_triggers: 保存trigger信息
    trigger_name: trigger的名字,該名字用戶自己可以隨意定制,無(wú)強(qiáng)行要求
    trigger_group:trigger所屬組的名字,該名字用戶自己隨意定制,無(wú)強(qiáng)行要求
    job_name: qrtz_job_details表job_name的外鍵
    job_group: qrtz_job_details表job_group的外鍵
    trigger_state:當(dāng)前trigger狀態(tài)，設(shè)置為ACQUIRED,如果設(shè)置為WAITING,則job不會(huì)觸發(fā)
    trigger_cron:觸發(fā)器類型,使用cron表達(dá)式
  • 表qrtz_cron_triggers:存儲(chǔ)cron表達(dá)式表
    trigger_name: qrtz_triggers表trigger_name的外鍵
    trigger_group: qrtz_triggers表trigger_group的外鍵
    cron_expression:cron表達(dá)式
  • 表qrtz_scheduler_state:存儲(chǔ)集群中note實(shí)例信息，quartz會(huì)定時(shí)讀取該表的信息判斷集群中每個(gè)實(shí)例的當(dāng)前狀態(tài)
    instance_name:之前配置文件中org.quartz.scheduler.instanceId配置的名字，就會(huì)寫入該字段，如果設(shè)置為AUTO,quartz會(huì)根據(jù)物理機(jī)名和當(dāng)前時(shí)間產(chǎn)生一個(gè)名字
    last_checkin_time:上次檢查時(shí)間
    checkin_interval:檢查間隔時(shí)間

quartz屬性配置

文件位置：


image.png
# 固定前綴org.quartz
# 主要分為scheduler、threadPool、jobStore、plugin等部分
#
#
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

# threadCount和threadPriority將以setter的形式注入ThreadPool實(shí)例
# 并發(fā)個(gè)數(shù)
org.quartz.threadPool.threadCount=5
# 優(yōu)先級(jí)
org.quartz.threadPool.threadPriority=5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread=true
org.quartz.jobStore.misfireThreshold=5000

# 默認(rèn)存儲(chǔ)在內(nèi)存中
#org.quartz.jobStore.class=org.quartz.simpl.RAMJobStore

#持久化
org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.tablePrefix=QRTZ_
#此處注釋掉數(shù)據(jù)庫(kù)配置，改為和項(xiàng)目公用 dataSource
#org.quartz.jobStore.dataSource=qzDS
#org.quartz.dataSource.qzDS.driver=com.mysql.jdbc.Driver
#org.quartz.dataSource.qzDS.URL=jdbc:mysql://192.168.1.197:3306/zaodaomessage?useUnicode=true&characterEncoding=UTF-8
#org.quartz.dataSource.qzDS.user=zaodaomessage
#org.quartz.dataSource.qzDS.password=zaodaomessage
#org.quartz.dataSource.qzDS.maxConnections=10

# Cluster
org.quartz.jobStore.isClustered=true
org.quartz.scheduler.instanceId=AUTO
org.quartz.jobStore.clusterCheckinInterval=2000

數(shù)據(jù)源及相關(guān)配置

集成Liquibase，初始化數(shù)據(jù)庫(kù)

image.png
<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog/1.7"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog/1.7
         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-1.7.xsd">
    <changeSet id="quartz_tables_mysql" author="evgeny" dbms="mysql">
        <sqlFile encoding="utf8"
                 path="db/changelog/sql/quartz_tables_mysql.sql"
                 splitStatements="true"
                 stripComments="true"/>
    </changeSet>
</databaseChangeLog>

詳情參見：
https://blog.csdn.net/liubowin/article/details/80419497
http://www.tianshouzhi.com/api/tutorials/springboot/366
http://www.quartz-scheduler.org/documentation/quartz-2.3.0/configuration/

配置spring的dataSource

image.png

創(chuàng)建Job工廠類

創(chuàng)建job 實(shí)例工廠，解決spring注入問題，如果使用默認(rèn)會(huì)導(dǎo)致spring的@Autowired 無(wú)法注入問題

import org.quartz.spi.TriggerFiredBundle;
import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.scheduling.quartz.SpringBeanJobFactory;

/**
 * Adds autowiring support to quartz jobs.
 *
 * @see https://gist.github.com/jelies/5085593
 */
public final class AutowiringSpringBeanJobFactory extends SpringBeanJobFactory implements ApplicationContextAware {

    /**
     * AutowireCapableBeanFactory
     */
    private transient AutowireCapableBeanFactory beanFactory;

    @Override
    public void setApplicationContext(final ApplicationContext context) {
        beanFactory = context.getAutowireCapableBeanFactory();
    }

    @Override
    protected Object createJobInstance(final TriggerFiredBundle bundle) throws Exception {
        final Object job = super.createJobInstance(bundle);
        beanFactory.autowireBean(job);
        return job;
    }
}

SpringBoot項(xiàng)目中quartz的配置

讓quartz.properties配置生效的開關(guān)

文件位置：src/main/resources/application.properties

# Sample Job Config begin
quartz.enabled=true
samplejob.enabled=true
samplejob.replace=false
samplejob.repeatInterval=10
samplejob.frequency=2000
liquibase.changeLog=classpath:/db/changelog/db.changelog-master.xml
# Sample Job Config end

quartz的具體配置

在這里的配置若在quartz.properties配置文件中已經(jīng)存在，則這里的會(huì)生效。

import com.projects.springboot.messagecenter.task.job.SampleJob;
import com.projects.springboot.messagecenter.task.spring.AutowiringSpringBeanJobFactory;
import liquibase.integration.spring.SpringLiquibase;
import org.quartz.JobDetail;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.spi.JobFactory;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.beans.factory.config.PropertiesFactoryBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.scheduling.quartz.CronTriggerFactoryBean;
import org.springframework.scheduling.quartz.JobDetailFactoryBean;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.scheduling.quartz.SimpleTriggerFactoryBean;

import javax.sql.DataSource;
import java.io.IOException;
import java.util.Properties;

/**
 * 定時(shí)任務(wù)配置類
 */
@Configuration
@ConditionalOnProperty(name = "quartz.enabled", havingValue = "true")
public class SchedulerConfig {

    /**
     * injecting SpringLiquibase to ensure liquibase is already initialized and created the quartz tables:
     *
     * @param applicationContext ApplicationContext
     * @param springLiquibase    springLiquibase
     * @return JobFactory
     */
    @Bean
    public JobFactory jobFactory(ApplicationContext applicationContext, SpringLiquibase springLiquibase) {
        AutowiringSpringBeanJobFactory jobFactory = new AutowiringSpringBeanJobFactory();
        jobFactory.setApplicationContext(applicationContext);
        return jobFactory;
    }

    /**
     * schedulerFactoryBean
     *
     * @param dataSource       DataSource
     * @param jobFactory       JobFactory
     * @param sampleJobTrigger Trigger
     * @return SchedulerFactoryBean
     * @throws IOException IOException
     */
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean(DataSource dataSource, JobFactory jobFactory,
                                                     @Qualifier("sampleJobTrigger") Trigger sampleJobTrigger)
        throws IOException {
        SchedulerFactoryBean factory = new SchedulerFactoryBean();
        // this allows to update triggers in DB when updating settings in config file:
        factory.setOverwriteExistingJobs(true);
        factory.setDataSource(dataSource);
        factory.setJobFactory(jobFactory);
        factory.setQuartzProperties(quartzProperties());

        return factory;
    }

    /**
     * quartzProperties
     *
     * @return Properties
     * @throws IOException IOException
     */
    @Bean
    public Properties quartzProperties() throws IOException {
        PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean();
        propertiesFactoryBean.setLocation(new ClassPathResource("/quartz.properties"));
        propertiesFactoryBean.afterPropertiesSet();
        return propertiesFactoryBean.getObject();
    }

    /**
     * sampleJobDetail
     *
     * @return JobDetailFactoryBean
     */
    @Bean
    public JobDetailFactoryBean sampleJobDetail() {
        return createJobDetail(SampleJob.class);
    }

    /**
     * sampleJobTrigger
     *
     * @param jobDetail JobDetail
     * @param frequency long
     * @return SimpleTriggerFactoryBean
     */
    @Bean(name = "sampleJobTrigger")
    public SimpleTriggerFactoryBean sampleJobTrigger(@Qualifier("sampleJobDetail") JobDetail jobDetail,
                                                     @Value("${samplejob.frequency}") long frequency) {
        return createTrigger(jobDetail, frequency);
    }

    /**
     * createJobDetail
     *
     * @param jobClass Class
     * @return JobDetailFactoryBean
     */
    private static JobDetailFactoryBean createJobDetail(Class jobClass) {
        JobDetailFactoryBean factoryBean = new JobDetailFactoryBean();
        factoryBean.setJobClass(jobClass);
        // job has to be durable to be stored in DB:
        factoryBean.setDurability(true);
        return factoryBean;
    }

    /**
     * createTrigger
     *
     * @param jobDetail       JobDetail
     * @param pollFrequencyMs long
     * @return SimpleTriggerFactoryBean
     */
    private static SimpleTriggerFactoryBean createTrigger(JobDetail jobDetail, long pollFrequencyMs) {
        SimpleTriggerFactoryBean factoryBean = new SimpleTriggerFactoryBean();
        factoryBean.setJobDetail(jobDetail);
        factoryBean.setStartDelay(0L);
        factoryBean.setRepeatInterval(pollFrequencyMs);
        factoryBean.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
        // in case of misfire, ignore all missed triggers and continue :
        factoryBean.setMisfireInstruction(SimpleTrigger.MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT);
        return factoryBean;
    }

    /**
     * createCronTrigger
     * Use this method for creating cron triggers instead of simple triggers:
     *
     * @param jobDetail      JobDetail
     * @param cronExpression String
     * @return CronTriggerFactoryBean
     */
    private static CronTriggerFactoryBean createCronTrigger(JobDetail jobDetail, String cronExpression) {
        CronTriggerFactoryBean factoryBean = new CronTriggerFactoryBean();
        factoryBean.setJobDetail(jobDetail);
        factoryBean.setCronExpression(cronExpression);
        factoryBean.setMisfireInstruction(SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW);
        return factoryBean;
    }

}

ps：關(guān)于springboot的@ConditionalOnProperty注解

發(fā)現(xiàn)了Spring boot中有個(gè)注解@ConditionalOnProperty，這個(gè)注解能夠控制某個(gè)configuration是否生效。具體操作是通過其兩個(gè)屬性name以及havingValue來(lái)實(shí)現(xiàn)的，其中name用來(lái)從application.properties中讀取某個(gè)屬性值，如果該值為空，則返回false;如果值不為空，則將該值與havingValue指定的值進(jìn)行比較，如果一樣則返回true;否則返回false。如果返回值為false，則該configuration不生效；為true則生效。

詳見：
https://blog.csdn.net/gottst0113/article/details/80978966

創(chuàng)建Job類

要執(zhí)行的任務(wù)直接實(shí)現(xiàn)Job類，重寫execute方法，這個(gè)類加入Job的調(diào)度之后，就會(huì)自動(dòng)執(zhí)行execute中的具體業(yè)務(wù)。

@Component
@DisallowConcurrentExecution // 有狀態(tài)的JOB，防止同一時(shí)間重復(fù)執(zhí)行
public class SampleJob implements Job {

    @Autowired
    SchedulerFactoryBean scheduler;
    @Autowired
    JobExecuteService jobExecuteService;

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        String nowDate = DateUtils.getNowDate();
        String jobKey = jobExecutionContext.getJobDetail().getKey().getName();
        try {
            jobExecuteService.doRealTimeJob();
        } catch (Exception e) {
            logger.error("時(shí)間："+ nowDate + ",執(zhí)行任務(wù)出現(xiàn)異常...", e);
        }
    }
}

參考：https://blog.csdn.net/syp_24/article/details/80182088

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容