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

ゝ一纸荒年。 2023-10-08 16:59 24阅读 0赞

#### 文件约定 ####

在Quartz发布的JAR包的org.quartz包下，包含了一个命名为quartz.properties的配置文件并提供了默认属性，如果需要调整默认配置，则可以在类路径下建立一个新的quartz.properties，它将自动被Quartz加载并覆盖默认值。如果使用yml格式的配置，由于配置文件加载优先级的原因会导致quartz.properties里面的配置失效。

[QUARTZ官网-配置说明文档][QUARTZ_-]

#### ① 配置说明(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_

#### ② 配置说明(application-dev.yml) ####

spring:
      datasource:
        name: SERVICEX-DS
        type: com.alibaba.druid.pool.DruidDataSource
        #druid相关配置
        druid:
          #监控统计拦截的filters
          filter: stat,config
    #      driver-class-name: com.mysql.cj.jdbc.Driver
          #基本属性
          url: jdbc:mysql://localhost:3306/servicex
          username: root
          password: 123456
          #初始化连接数
          initial-size: 10
          #最小活跃连接数
          min-size: 5
          #最大活跃连接数
          max-active: 20
          #获取连接的等待时间
          max-wait: 60000
          #间隔多久进行一次检查，检查需要关闭的空闲连接
          time-between-eviction-runs-millis: 60000
          #一个连接在池中最小的生存时间(5分钟)
          min-evictable-idle-time-millis: 300000
          validation-query: SELECT 'X'
          # 验证空闲的连接，若无法验证，则删除连接
          test-while-idle: true
          # 不检测池中连接的可用性（默认false）
          # 导致的问题是，若项目作为服务端，数据库连接被关闭时，客户端调用就会出现大量的timeout
          test-on-borrow: false
          #在返回连接池之前是否验证对象
          test-on-return: false
          #打开PSCache，并指定每个连接上PSCache的大小。oracle设为true，mysql设为false。分库分表较多推荐设置为false
          #第三发连接池在使用的时候，获取到Connection后，使用完毕，调用关闭方法，并没有将Connection关闭，只是放回到连接池中
          #如果调用这个方法，而没有手动关闭PreparedStatement，就可能造成内存溢出，但是JDK1.7实现了AutoCloseable接口，就不需要关闭了
          pool-prepared-statements: false
          max-pool-prepared-statement-per-connection-size: 20
          # connection-properties:
          use-unfair-lock: true
      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

#### ③ 如何加载？ ####

在“org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration”中我们可以看到SpringBoot加载QUARTZ配置信息的相关方法，根据QuartzProperties.java的定义我们知道，如何在application.yml中配置相关的属性信息。如下：  
![在这里插入图片描述][56819cc7b70e4837a4e89e51c0a46cf3.png]  
![在这里插入图片描述][48d6e7f507dc49ef95cd8fc01b301bc8.png]

#### 其他文章 ####

[SpringBoot - 集成Quartz框架之CRON表达式][SpringBoot - _Quartz_CRON]  
[SpringBoot - 集成Quartz框架之Quartz简介(一)][SpringBoot - _Quartz_Quartz]  
[SpringBoot - 集成Quartz框架之常用配置(二)][SpringBoot - _Quartz]  
[SpringBoot - 集成Quartz框架之具体步骤(三)][SpringBoot - _Quartz 1]  
[SpringBoot - 集成Quartz框架之独立数据源(四)][SpringBoot - _Quartz 2]  
[SpringBoot - 集成Quartz框架之常见问题(五)][SpringBoot - _Quartz 3]  
[SpringBoot - 集成Quartz框架之@DisallowConcurrentExecution注解详解(六)][SpringBoot - _Quartz_DisallowConcurrentExecution]

[QUARTZ_-]: http://www.quartz-scheduler.org/documentation/2.4.0-SNAPSHOT/configuration.html
[56819cc7b70e4837a4e89e51c0a46cf3.png]: https://img-blog.csdnimg.cn/56819cc7b70e4837a4e89e51c0a46cf3.png
[48d6e7f507dc49ef95cd8fc01b301bc8.png]: https://img-blog.csdnimg.cn/48d6e7f507dc49ef95cd8fc01b301bc8.png
[SpringBoot - _Quartz_CRON]: https://blog.csdn.net/goodjava2007/article/details/126705060
[SpringBoot - _Quartz_Quartz]: https://blog.csdn.net/goodjava2007/article/details/126843315
[SpringBoot - _Quartz]: https://blog.csdn.net/goodjava2007/article/details/126912467
[SpringBoot - _Quartz 1]: https://blog.csdn.net/goodjava2007/article/details/126982771
[SpringBoot - _Quartz 2]: https://blog.csdn.net/goodjava2007/article/details/126982657
[SpringBoot - _Quartz 3]: https://blog.csdn.net/goodjava2007/article/details/126868728
[SpringBoot - _Quartz_DisallowConcurrentExecution]: https://blog.csdn.net/goodjava2007/article/details/126850472