12.SpringBoot2 整合Quartz2(一)

Love The Way You Lie 2022-02-20 08:36 253阅读 0赞

Springboot 是当下最流行的一个java框架了, 它大大降低了开发人员集成框架的时间, 提升了开发效率. 但是springboot 集成quartz时却没有想象地那么简单, 而且网上文章集成方式各种各样, 笔者在浏览数篇整合博客之后, 感觉整合方式并不符合笔者的开发习惯, 因此便决定自己进行整合. 整合过程也时一波三折, 笔者将用两篇博客分享.

**整合目标:**

*  任意springbean中的方法均可配置为定时任务
 *  定时任务注册方式统一, 无需冗余
 *  定时任务是否可并发, 可配置
 *  定时任务可以覆盖更新

**整合步骤:**

1. 初始化数据库, 初始化quartz相关表
    2. 创建spring boot项目
        2.1 添加项目依赖: springboot, quartz, mysql, log等
        2.2 创建application.yml: 配置数据源, 应用名称, 端口号等
        2.3 创建logback.xml: 自定义日志输出
        2.4 创建quartz.properties: 配置quartz相关属性
        2.5 创建获取Spring bean的工具类: 用于获取spring容器的bean
    
    3. spring整合quartz
        3.1 创建Quartz配置类: 整合spring与quartz
        3.2 参考spring补丁程序, 自定义整合相关类
        3.3 创建spring容器初始化监听器, 统一注册定时任务
    
    4. 开发定时任务
        4.1 创建普通类, 并注册为spring的组件
        4.2 将spring bean的方法注册作为定时任务: JobDeail 与 Trigger 成对出现
    5. 运行结果
        5.1 允许并发时
        5.2 禁止并发时

## 1. 初始化数据库 ##

笔者数据库采用mysql, 所以实现导入mysql 的初始化sql 语句. sql 文件位于从quartz官方下载的jar包的docs/dbTables目录. 笔者不修改默认的表前缀

DROP TABLE IF EXISTS QRTZ_FIRED_TRIGGERS;
    DROP TABLE IF EXISTS QRTZ_PAUSED_TRIGGER_GRPS;
    DROP TABLE IF EXISTS QRTZ_SCHEDULER_STATE;
    DROP TABLE IF EXISTS QRTZ_LOCKS;
    DROP TABLE IF EXISTS QRTZ_SIMPLE_TRIGGERS;
    DROP TABLE IF EXISTS QRTZ_SIMPROP_TRIGGERS;
    DROP TABLE IF EXISTS QRTZ_CRON_TRIGGERS;
    DROP TABLE IF EXISTS QRTZ_BLOB_TRIGGERS;
    DROP TABLE IF EXISTS QRTZ_TRIGGERS;
    DROP TABLE IF EXISTS QRTZ_JOB_DETAILS;
    DROP TABLE IF EXISTS QRTZ_CALENDARS;
    
    CREATE TABLE QRTZ_JOB_DETAILS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        JOB_NAME  VARCHAR(200) NOT NULL,
        JOB_GROUP VARCHAR(200) NOT NULL,
        DESCRIPTION VARCHAR(250) NULL,
        JOB_CLASS_NAME   VARCHAR(250) NOT NULL,
        IS_DURABLE VARCHAR(1) NOT NULL,
        IS_NONCONCURRENT VARCHAR(1) NOT NULL,
        IS_UPDATE_DATA VARCHAR(1) NOT NULL,
        REQUESTS_RECOVERY VARCHAR(1) NOT NULL,
        JOB_DATA BLOB NULL,
        PRIMARY KEY (SCHED_NAME,JOB_NAME,JOB_GROUP)
    );
    
    CREATE TABLE QRTZ_TRIGGERS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        TRIGGER_NAME VARCHAR(200) NOT NULL,
        TRIGGER_GROUP VARCHAR(200) NOT NULL,
        JOB_NAME  VARCHAR(200) NOT NULL,
        JOB_GROUP VARCHAR(200) NOT NULL,
        DESCRIPTION VARCHAR(250) NULL,
        NEXT_FIRE_TIME BIGINT(13) NULL,
        PREV_FIRE_TIME BIGINT(13) NULL,
        PRIORITY INTEGER NULL,
        TRIGGER_STATE VARCHAR(16) NOT NULL,
        TRIGGER_TYPE VARCHAR(8) NOT NULL,
        START_TIME BIGINT(13) NOT NULL,
        END_TIME BIGINT(13) NULL,
        CALENDAR_NAME VARCHAR(200) NULL,
        MISFIRE_INSTR SMALLINT(2) NULL,
        JOB_DATA BLOB NULL,
        PRIMARY KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP),
        FOREIGN KEY (SCHED_NAME,JOB_NAME,JOB_GROUP)
            REFERENCES QRTZ_JOB_DETAILS(SCHED_NAME,JOB_NAME,JOB_GROUP)
    );
    
    CREATE TABLE QRTZ_SIMPLE_TRIGGERS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        TRIGGER_NAME VARCHAR(200) NOT NULL,
        TRIGGER_GROUP VARCHAR(200) NOT NULL,
        REPEAT_COUNT BIGINT(7) NOT NULL,
        REPEAT_INTERVAL BIGINT(12) NOT NULL,
        TIMES_TRIGGERED BIGINT(10) NOT NULL,
        PRIMARY KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP),
        FOREIGN KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
            REFERENCES QRTZ_TRIGGERS(SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
    );
    
    CREATE TABLE QRTZ_CRON_TRIGGERS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        TRIGGER_NAME VARCHAR(200) NOT NULL,
        TRIGGER_GROUP VARCHAR(200) NOT NULL,
        CRON_EXPRESSION VARCHAR(200) NOT NULL,
        TIME_ZONE_ID VARCHAR(80),
        PRIMARY KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP),
        FOREIGN KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
            REFERENCES QRTZ_TRIGGERS(SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
    );
    
    CREATE TABLE QRTZ_SIMPROP_TRIGGERS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        TRIGGER_NAME VARCHAR(200) NOT NULL,
        TRIGGER_GROUP VARCHAR(200) NOT NULL,
        STR_PROP_1 VARCHAR(512) NULL,
        STR_PROP_2 VARCHAR(512) NULL,
        STR_PROP_3 VARCHAR(512) NULL,
        INT_PROP_1 INT NULL,
        INT_PROP_2 INT NULL,
        LONG_PROP_1 BIGINT NULL,
        LONG_PROP_2 BIGINT NULL,
        DEC_PROP_1 NUMERIC(13,4) NULL,
        DEC_PROP_2 NUMERIC(13,4) NULL,
        BOOL_PROP_1 VARCHAR(1) NULL,
        BOOL_PROP_2 VARCHAR(1) NULL,
        PRIMARY KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP),
        FOREIGN KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
        REFERENCES QRTZ_TRIGGERS(SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
    );
    
    CREATE TABLE QRTZ_BLOB_TRIGGERS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        TRIGGER_NAME VARCHAR(200) NOT NULL,
        TRIGGER_GROUP VARCHAR(200) NOT NULL,
        BLOB_DATA BLOB NULL,
        PRIMARY KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP),
        FOREIGN KEY (SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
            REFERENCES QRTZ_TRIGGERS(SCHED_NAME,TRIGGER_NAME,TRIGGER_GROUP)
    );
    
    CREATE TABLE QRTZ_CALENDARS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        CALENDAR_NAME  VARCHAR(200) NOT NULL,
        CALENDAR BLOB NOT NULL,
        PRIMARY KEY (SCHED_NAME,CALENDAR_NAME)
    );
    
    CREATE TABLE QRTZ_PAUSED_TRIGGER_GRPS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        TRIGGER_GROUP  VARCHAR(200) NOT NULL,
        PRIMARY KEY (SCHED_NAME,TRIGGER_GROUP)
    );
    
    CREATE TABLE QRTZ_FIRED_TRIGGERS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        ENTRY_ID VARCHAR(95) NOT NULL,
        TRIGGER_NAME VARCHAR(200) NOT NULL,
        TRIGGER_GROUP VARCHAR(200) NOT NULL,
        INSTANCE_NAME VARCHAR(200) NOT NULL,
        FIRED_TIME BIGINT(13) NOT NULL,
        SCHED_TIME BIGINT(13) NOT NULL,
        PRIORITY INTEGER NOT NULL,
        STATE VARCHAR(16) NOT NULL,
        JOB_NAME VARCHAR(200) NULL,
        JOB_GROUP VARCHAR(200) NULL,
        IS_NONCONCURRENT VARCHAR(1) NULL,
        REQUESTS_RECOVERY VARCHAR(1) NULL,
        PRIMARY KEY (SCHED_NAME,ENTRY_ID)
    );
    
    CREATE TABLE QRTZ_SCHEDULER_STATE
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        INSTANCE_NAME VARCHAR(200) NOT NULL,
        LAST_CHECKIN_TIME BIGINT(13) NOT NULL,
        CHECKIN_INTERVAL BIGINT(13) NOT NULL,
        PRIMARY KEY (SCHED_NAME,INSTANCE_NAME)
    );
    
    CREATE TABLE QRTZ_LOCKS
      (
        SCHED_NAME VARCHAR(120) NOT NULL,
        LOCK_NAME  VARCHAR(40) NOT NULL,
        PRIMARY KEY (SCHED_NAME,LOCK_NAME)
    );
    
    
    commit;

## 2. 创建spring boot项目 ##

新建sboot项目, 笔者采用springboot 2.1.3.

### 2.1 添加项目依赖 ###

<dependencies>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.38</version>
        </dependency>
    
        
        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.2.3</version>
        </dependency>
    </dependencies>

### 2.2 创建application.yml ###

*  笔者习惯于使用yuml方式配置springboot项目, yuml方式看起来更简洁,层次更清晰.
 *  笔者只配置数据源和web应用的基础信息

server:
      port: 8181
    spring:
      application:
        name: learn-quartz-l021
      datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://localhost:3306/learn-quart-sboot?serverTimezone=UTC
        username: root
        password: root
        hikari:
          maximum-pool-size: 3
          minimum-idle: 10
          idle-timeout: 30

### 2.3 创建logback.xml, 配置日志 ###

<?xml version="1.0"?>
    <configuration debug="false">
    
        
        <contextName>learn-sboot-quartz</contextName>
    
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                
                <pattern>[%d{yyyy-MM-dd HH:mm:ss:SSS}][%thread][%-5level][%logger{36}]- %msg%n</pattern>
            </encoder>
        </appender>
    
        
        <root level="INFO">
            <appender-ref ref="STDOUT"/>
        </root>
    </configuration>

### 2.4 配置quartz.properties ###

笔者采用数据库存放方式, 直接配置支持集群.

org.quartz.scheduler.instanceName = MyScheduler
    
    # 集群配置节点实例id
    org.quartz.scheduler.instanceId = AUTO
    
    # quartz 线程池配置
    org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
    org.quartz.threadPool.threadCount = 25
    org.quartz.threadPool.threadPriority = 5
    
    # 采用数据库存储方式
    org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
    org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate
    org.quartz.jobStore.isClustered = true
    org.quartz.jobStore.clusterCheckinInterval = 20000
    
    # 自定义表前缀
    org.quartz.jobStore.tablePrefix = QRTZ_

### 2.5 创建获取Spring bean的工具类 ###

/** * @Description: Spring 上下文工具, 可用于获取spring 容器中的Bean * @author: zongf * @date: 2018-12-26 10:34 */
    @Component
    public class ApplicationUtil implements ApplicationContextAware { 
    
        private static ApplicationContext applicationContext;
    
        @Override
        public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { 
            ApplicationUtil.applicationContext = applicationContext;
        }
    
        /** * @Description: 获取spring容器中的bean,通过bean名称获取 * @param beanName bean名称 * @return: Object 返回Object,需要做强制类型转换 * @author: zongf * @time: 2018-12-26 10:45:07 */
        public static Object getBean(String beanName){ 
            return applicationContext.getBean(beanName);
        }
    
        /** * @Description: 获取spring容器中的bean, 通过bean类型获取 * @param beanClass bean 类型 * @return: T 返回指定类型的bean实例 * @author: zongf * @time: 2018-12-26 10:46:31 */
        public static <T> T getBean(Class<T> beanClass) { 
            return applicationContext.getBean(beanClass);
        }
    
        /** * @Description: 获取spring容器中的bean, 通过bean名称和bean类型精确获取 * @param beanName bean 名称 * @param beanClass bean 类型 * @return: T 返回指定类型的bean实例 * @author: zongf * @time: 2018-12-26 10:47:45 */
        public static <T> T getBean(String beanName, Class<T> beanClass){ 
            return applicationContext.getBean(beanName,beanClass);
        }
    }

> 第一部分结束, 请看笔者下一篇博客