SpringBoot - 集成Quartz框架之常用配置

骑猪看日落 2023-10-12 21:03 14阅读 0赞

Quartz是一款Java编写的**开源任务调度框架**，同时它也是Spring默认的任务调度框架。它的作用其实类似于Java中的Timer定时器以及JUC中的ScheduledExecutorService调度线程池，当然Quartz作为一个独立的任务调度框架无疑在这方面表现的更为出色，功能更强大，能够定义更为复杂的执行规则。Quartz中主要用到了：Builder建造者模式、Factory工厂模式以及组件模式，我们要知道Quartz是如何调度的，需要知道三个概念：**任务（Job，我们需要将具体的业务逻辑写到实现了Job接口的实现类中）、触发器（Trigger，它定义了任务的执行规则），最后是调度器（Scheduler，通过传入的任务Job和触发器Trigger，以指定的规则执行任务）。**

一、配置说明(quartz.properties)

#============================================================================
    # 1. 基本配置
    #============================================================================
    
    # 调度标识名，集群中每一个实例都必须使用相同的名称。
    # 可以为任意字符串，对于scheduler来说此值没有任何意义，但是可以区分同一系统中多个不同的实例。
    # 如果使用了集群的功能，就必须对每一个实例使用相同的名称，这样使这些实例“逻辑上”是同一个scheduler。
    org.quartz.scheduler.instanceName = SERVICEX-SCHEDULER-INSTANCE
    
    # ID设置为自动获取，每一个实例不能相同。
    # 可以为任意字符串，如果使用了集群的功能，SCHEDULER实例的值必须唯一，可以使用AUTO自动生成。
    org.quartz.scheduler.instanceId = AUTO
    
    # 默认值为false
    org.quartz.scheduler.rmi.export = false
    
    # 默认值为false
    org.quartz.scheduler.rmi.proxy = false
    
    # 默认false，若是在执行Job之前Quartz开启UserTransaction，此属性应该为true。Job执行完毕，JobDataMap更新完（如果是StatefulJob）事务就会提交。
    # 可以在JOB类上使用 @ExecuteInJTATransaction注解，以便在各自的JOB上决定是否开启JTA事务。
    org.quartz.scheduler.wrapJobExecutionInUserTransaction = false
    
    # 一个SCHEDULER节点允许接收的TRIGGER的最大数，默认是1。值越大定时任务执行的越多，代价是集群节点之间的不均衡。
    org.quartz.scheduler.batchTriggerAcquisitionMaxCount=1
    
    #============================================================================
    # 2. 调度器线程池配置
    #============================================================================
    
    # 线程池的实现类，一般使用SimpleThreadPool即可满足需求
    org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
    
    # 指定线程数无默认值，至少为1，指定该值后线程数量不会动态增加。
    org.quartz.threadPool.threadCount = 20
    
    # 线程的优先级(最大为java.lang.Thread.MAX_PRIORITY 10，最小为Thread.MIN_PRIORITY 1，默认为5)
    org.quartz.threadPool.threadPriority = 5
    
    # 加载任务代码的ClassLoader是否从外部继承
    org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true
    
    # 是否设置调度器线程为守护线程
    org.quartz.scheduler.makeSchedulerThreadDaemon = true
    
    
    #============================================================================
    # 3. 作业存储配置
    #============================================================================
    
    # JDBC的存储方式
    org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
    
    # 数据库驱动，类似于Hibernate的dialect，用于处理DB之间的差异，StdJDBCDelegate能满足大部分的DB的使用。
    org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
    
    # 是否加入集群，当有多个Quartz实例在用同一套数据库时，必须设置为true。
    org.quartz.jobStore.isClustered = true
    
    # 检查集群节点状态的频率, 默认值是 15000(即15秒)
    # 只用于设置了isClustered为true的时，才需要设置该项，用于实例上报信息给集群中的其他实例，这个值的大小会影响到侦测失败实例的敏捷度。
    org.quartz.jobStore.clusterCheckinInterval = 15000
    
    # 这是JobStore能处理的错过触发的TRIGGER的最大数量。处理太多则很快就会导致数据库中的表被锁定够长的时间，这样则会妨碍别的（还未错过触发）TRIGGER执行的性能。
    org.quartz.jobStore.maxMisfiresToHandleAtATime = 1
    org.quartz.jobStore.txIsolationLevelSerializable = true
    
    # 设置这个参数为true会告诉Quartz从数据源获取连接后不要调用它的setAutoCommit(false)方法，大部分情况下驱动都要求调用setAutoCommit(false)。
    org.quartz.jobStore.dontSetAutoCommitFalse = false
    # 这必须是一个从LOCKS表查询一行并对这行记录加锁的SQL。假设没有设置，默认值如下。{
        0}会在运行期间被配置的TABLE_PREFIX所代替。
    org.quartz.jobStore.selectWithLockSQL=SELECT * FROM {
        0}LOCKS WHERE LOCK_NAME = ? FOR UPDATE
    
    # 设置调度引擎对触发器超时的忍耐时间 (单位毫秒)
    org.quartz.jobStore.misfireThreshold = 12000
    # 表的前缀，默认QRTZ_
    org.quartz.jobStore.tablePrefix = QRTZ_

二、yml的配置说明

spring:
      quartz:
        #相关属性配置
        properties:
          org:
            quartz:
              scheduler:
                # 集群名，区分同一系统的不同实例，若使用集群功能，则每一个实例都要使用相同的名字
                instanceName: SERVICEX-SCHEDULER-INSTANCE
                # 若是集群下，每个instanceId必须唯一
                instanceId: AUTO
              threadPool:
                #一般使用这个便可
                class: org.quartz.simpl.SimpleThreadPool
                #线程数量，不会动态增加
                threadCount: 20
                threadPriority: 5
                threadsInheritContextClassLoaderOfInitializingThread: true
              jobStore:
                #选择JDBC的存储方式
                class: org.quartz.impl.jdbcjobstore.JobStoreTX
                driverDelegateClass: org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
                tablePrefix: QRTZ_
                useProperties: false
                isClustered: true
                clusterCheckinInterval: 15000
        job-store-type: jdbc
        # 默认为false， 用于设定是否等待任务执行完毕后容器才会关闭。
        wait-for-jobs-to-complete-on-shutdown: false
        # 默认为false， 配置的JOB是否覆盖已经存在的JOB信息
        overwrite-existing-jobs: false

### 三、如何使用 ###

以quartz.properties为参考案例：

1、将quartz.properties放在resources下

![在这里插入图片描述][de20171796764dd495ddc7d1833d158f.png]  
2、创建SchedulerConfig类

package com.wonders.configuration;
    import org.quartz.Scheduler;
    import org.quartz.SchedulerException;
    import org.quartz.ee.servlet.QuartzInitializerListener;
    import org.quartz.impl.StdSchedulerFactory;
    import org.springframework.beans.factory.config.PropertiesFactoryBean;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnResource;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.io.ClassPathResource;
    import java.io.IOException;
    import java.util.Properties;
    
    
    @Configuration
    public class SchedulerConfig {
        
        // 配置文件路径
        private static final String SERVICEX_QUARTZ_CONFIG_PATH = "/quartz.properties";
    
    //    // 控制器工厂类
    //    @Bean(name="schedulerFactoryBean")
    //    public SchedulerFactoryBean schedulerFactoryBean() {
        
    //        SchedulerFactoryBean factory = new SchedulerFactoryBean();
    //        factory.setQuartzProperties(quartzProperties());
    //        factory.setStartupDelay(1);
    //        factory.setApplicationContextSchedulerContextKey("SERVICEX-APPLICATION-CONTEXT-KEY");
    //        factory.setOverwriteExistingJobs(true);
    //        factory.setAutoStartup(true);
    //        return factory;
    //    }
        @Bean(name="stdSchedulerFactory")
        public  StdSchedulerFactory stdSchedulerFactory() throws SchedulerException {
        
            StdSchedulerFactory stdSchedulerFactory=new StdSchedulerFactory(quartzProperties());
            return stdSchedulerFactory;
        }
    
        @Bean
        @ConditionalOnResource(resources = SERVICEX_QUARTZ_CONFIG_PATH)
        Properties quartzProperties() {
        
            try {
        
                PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean();
                propertiesFactoryBean.setLocation(new ClassPathResource(SERVICEX_QUARTZ_CONFIG_PATH));
                propertiesFactoryBean.afterPropertiesSet();
                Properties properties = propertiesFactoryBean.getObject();
                return properties;
            } catch (IOException e) {
        
                System.out.println("QUARTZ相关的配置文件不存在.");
                e.printStackTrace();
            }
            return null;
        }
    
        /**
         * 初始化Quartz监听器,让Spring boot启动时初始化Quartz
         *
         */
        @Bean
        public QuartzInitializerListener executorListener() {
        
            return new QuartzInitializerListener();
        }
    
        /**
         * 通过StdSchedulerFactory获取Scheduler的实例
         */
        @Bean(name="scheduler")
        public Scheduler scheduler() throws Exception {
        
            return stdSchedulerFactory().getScheduler();
        }
    }

3、使用

/注入scheduler
    @Autowired
    private Scheduler scheduler;
    
    //调用方法
    // 绑定触发器和调度任务
    scheduler.scheduleJob(jobDetail, trigger);
    // 启动
    scheduler.start();

4、启动验收配置是否生效  
![在这里插入图片描述][c890c7f67fe344ddb25f76119f015f88.png]

[de20171796764dd495ddc7d1833d158f.png]: https://img-blog.csdnimg.cn/de20171796764dd495ddc7d1833d158f.png
[c890c7f67fe344ddb25f76119f015f88.png]: https://img-blog.csdnimg.cn/c890c7f67fe344ddb25f76119f015f88.png