SpringBoot 整合Quartz实现分布式集群定时任务

系统管理员 2022-10-23 12:53 242阅读 0赞

# Quartz 中集群工作原理 #

一个 Quartz 集群中的每个节点是一个独立的 Quartz 应用，它又管理着其他的节点。意思是你必须对每个节点分别启动或停止。不像许多应用服务器的集群，独立的 Quartz 节点并不与另一其的节点或是管理节点通信。Quartz 应用是通过数据库表来感知到另一应用的。离开了db将无法感知。  
![在这里插入图片描述][20210305174937867.png]

# 建表语句 #

quartz使用了数据库锁保证定时任务只有在一台机器上触发。在quartz的集群解决方案里有张表scheduler\_locks，quartz采用了悲观锁的方式对triggers表进行行加锁，以保证任务同步的正确性,所以我们需要导入quartz持久化所需的一些表：  
可有去官网查找quartz版本对应数据库建表语句：[quartz官网][quartz]

![在这里插入图片描述][20210305164341819.png]  
本文使用的是建表语句（springboot2.1.0对应的是quartz2.3.0）

SET FOREIGN_KEY_CHECKS=0;
     
    -- ----------------------------
    -- Table structure for QRTZ_BLOB_TRIGGERS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_BLOB_TRIGGERS`;
    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,
      PRIMARY KEY (`SCHED_NAME`,`TRIGGER_NAME`,`TRIGGER_GROUP`),
      KEY `SCHED_NAME` (`SCHED_NAME`,`TRIGGER_NAME`,`TRIGGER_GROUP`),
      CONSTRAINT `qrtz_blob_triggers_ibfk_1` FOREIGN KEY (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`) REFERENCES `QRTZ_TRIGGERS` (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_CALENDARS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_CALENDARS`;
    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`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_CRON_TRIGGERS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_CRON_TRIGGERS`;
    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(120) NOT NULL,
      `TIME_ZONE_ID` varchar(80) DEFAULT NULL,
      PRIMARY KEY (`SCHED_NAME`,`TRIGGER_NAME`,`TRIGGER_GROUP`),
      CONSTRAINT `qrtz_cron_triggers_ibfk_1` FOREIGN KEY (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`) REFERENCES `QRTZ_TRIGGERS` (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_FIRED_TRIGGERS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_FIRED_TRIGGERS`;
    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` int(11) NOT NULL,
      `STATE` varchar(16) NOT NULL,
      `JOB_NAME` varchar(200) DEFAULT NULL,
      `JOB_GROUP` varchar(200) DEFAULT NULL,
      `IS_NONCONCURRENT` varchar(1) DEFAULT NULL,
      `REQUESTS_RECOVERY` varchar(1) DEFAULT NULL,
      PRIMARY KEY (`SCHED_NAME`,`ENTRY_ID`),
      KEY `IDX_QRTZ_FT_TRIG_INST_NAME` (`SCHED_NAME`,`INSTANCE_NAME`),
      KEY `IDX_QRTZ_FT_INST_JOB_REQ_RCVRY` (`SCHED_NAME`,`INSTANCE_NAME`,`REQUESTS_RECOVERY`),
      KEY `IDX_QRTZ_FT_J_G` (`SCHED_NAME`,`JOB_NAME`,`JOB_GROUP`),
      KEY `IDX_QRTZ_FT_JG` (`SCHED_NAME`,`JOB_GROUP`),
      KEY `IDX_QRTZ_FT_T_G` (`SCHED_NAME`,`TRIGGER_NAME`,`TRIGGER_GROUP`),
      KEY `IDX_QRTZ_FT_TG` (`SCHED_NAME`,`TRIGGER_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_JOB_DETAILS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_JOB_DETAILS`;
    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) DEFAULT 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,
      PRIMARY KEY (`SCHED_NAME`,`JOB_NAME`,`JOB_GROUP`),
      KEY `IDX_QRTZ_J_REQ_RECOVERY` (`SCHED_NAME`,`REQUESTS_RECOVERY`),
      KEY `IDX_QRTZ_J_GRP` (`SCHED_NAME`,`JOB_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_LOCKS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_LOCKS`;
    CREATE TABLE `QRTZ_LOCKS` (
      `SCHED_NAME` varchar(120) NOT NULL,
      `LOCK_NAME` varchar(40) NOT NULL,
      PRIMARY KEY (`SCHED_NAME`,`LOCK_NAME`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_PAUSED_TRIGGER_GRPS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_PAUSED_TRIGGER_GRPS`;
    CREATE TABLE `QRTZ_PAUSED_TRIGGER_GRPS` (
      `SCHED_NAME` varchar(120) NOT NULL,
      `TRIGGER_GROUP` varchar(200) NOT NULL,
      PRIMARY KEY (`SCHED_NAME`,`TRIGGER_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_SCHEDULER_STATE
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_SCHEDULER_STATE`;
    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`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_SIMPLE_TRIGGERS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_SIMPLE_TRIGGERS`;
    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`),
      CONSTRAINT `qrtz_simple_triggers_ibfk_1` FOREIGN KEY (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`) REFERENCES `QRTZ_TRIGGERS` (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_SIMPROP_TRIGGERS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_SIMPROP_TRIGGERS`;
    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) DEFAULT NULL,
      `STR_PROP_2` varchar(512) DEFAULT NULL,
      `STR_PROP_3` varchar(512) DEFAULT NULL,
      `INT_PROP_1` int(11) DEFAULT NULL,
      `INT_PROP_2` int(11) DEFAULT NULL,
      `LONG_PROP_1` bigint(20) DEFAULT NULL,
      `LONG_PROP_2` bigint(20) DEFAULT NULL,
      `DEC_PROP_1` decimal(13,4) DEFAULT NULL,
      `DEC_PROP_2` decimal(13,4) DEFAULT NULL,
      `BOOL_PROP_1` varchar(1) DEFAULT NULL,
      `BOOL_PROP_2` varchar(1) DEFAULT NULL,
      PRIMARY KEY (`SCHED_NAME`,`TRIGGER_NAME`,`TRIGGER_GROUP`),
      CONSTRAINT `qrtz_simprop_triggers_ibfk_1` FOREIGN KEY (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`) REFERENCES `QRTZ_TRIGGERS` (`SCHED_NAME`, `TRIGGER_NAME`, `TRIGGER_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
     
    -- ----------------------------
    -- Table structure for QRTZ_TRIGGERS
    -- ----------------------------
    DROP TABLE IF EXISTS `QRTZ_TRIGGERS`;
    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) DEFAULT NULL,
      `NEXT_FIRE_TIME` bigint(13) DEFAULT NULL,
      `PREV_FIRE_TIME` bigint(13) DEFAULT NULL,
      `PRIORITY` int(11) DEFAULT NULL,
      `TRIGGER_STATE` varchar(16) NOT NULL,
      `TRIGGER_TYPE` varchar(8) NOT NULL,
      `START_TIME` bigint(13) NOT NULL,
      `END_TIME` bigint(13) DEFAULT NULL,
      `CALENDAR_NAME` varchar(200) DEFAULT NULL,
      `MISFIRE_INSTR` smallint(2) DEFAULT NULL,
      `JOB_DATA` blob,
      PRIMARY KEY (`SCHED_NAME`,`TRIGGER_NAME`,`TRIGGER_GROUP`),
      KEY `IDX_QRTZ_T_J` (`SCHED_NAME`,`JOB_NAME`,`JOB_GROUP`),
      KEY `IDX_QRTZ_T_JG` (`SCHED_NAME`,`JOB_GROUP`),
      KEY `IDX_QRTZ_T_C` (`SCHED_NAME`,`CALENDAR_NAME`),
      KEY `IDX_QRTZ_T_G` (`SCHED_NAME`,`TRIGGER_GROUP`),
      KEY `IDX_QRTZ_T_STATE` (`SCHED_NAME`,`TRIGGER_STATE`),
      KEY `IDX_QRTZ_T_N_STATE` (`SCHED_NAME`,`TRIGGER_NAME`,`TRIGGER_GROUP`,`TRIGGER_STATE`),
      KEY `IDX_QRTZ_T_N_G_STATE` (`SCHED_NAME`,`TRIGGER_GROUP`,`TRIGGER_STATE`),
      KEY `IDX_QRTZ_T_NEXT_FIRE_TIME` (`SCHED_NAME`,`NEXT_FIRE_TIME`),
      KEY `IDX_QRTZ_T_NFT_ST` (`SCHED_NAME`,`TRIGGER_STATE`,`NEXT_FIRE_TIME`),
      KEY `IDX_QRTZ_T_NFT_MISFIRE` (`SCHED_NAME`,`MISFIRE_INSTR`,`NEXT_FIRE_TIME`),
      KEY `IDX_QRTZ_T_NFT_ST_MISFIRE` (`SCHED_NAME`,`MISFIRE_INSTR`,`NEXT_FIRE_TIME`,`TRIGGER_STATE`),
      KEY `IDX_QRTZ_T_NFT_ST_MISFIRE_GRP` (`SCHED_NAME`,`MISFIRE_INSTR`,`NEXT_FIRE_TIME`,`TRIGGER_GROUP`,`TRIGGER_STATE`),
      CONSTRAINT `qrtz_triggers_ibfk_1` FOREIGN KEY (`SCHED_NAME`, `JOB_NAME`, `JOB_GROUP`) REFERENCES `QRTZ_JOB_DETAILS` (`SCHED_NAME`, `JOB_NAME`, `JOB_GROUP`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

# pom依赖 #

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-quartz</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
                    <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>

# application.yml #

spring:
      #分布式定时任务相关属性配置
      quartz:
        properties:
          org:
            quartz:
              scheduler:
                instanceName: clusteredScheduler
                instanceId: AUTO
              jobStore:
                class: org.quartz.impl.jdbcjobstore.JobStoreTX
                driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate
                tablePrefix: QRTZ_
                isClustered: true
                clusterCheckinInterval: 10000
                useProperties: false
              threadPool:
                class: org.quartz.simpl.SimpleThreadPool
                threadCount: 10
                threadPriority: 5
                threadsInheritContextClassLoaderOfInitializingThread: true
        #数据库方式
        job-store-type: jdbc
        #初始化表结构
        jdbc:
          initialize-schema: always
      #数据库配置 根据实际修改ip 库 用户名 密码等
      datasource:
        url: jdbc:mysql://10.139.12.111:3306/quick?useSSL=false&useUnicode=true&amp&characterEncoding=utf-8
        username: root
        password: xxxxx

编写定时任务  
定时任务需要实现job接口,但是quartz已经有了一个简单的抽象实现,简化了代码量.只需要直接继承即可.

定时任务1

import org.quartz.JobExecutionContext;
    import org.quartz.JobExecutionException;
    import org.springframework.scheduling.quartz.QuartzJobBean;
    import org.springframework.stereotype.Component;
    
    import java.util.Date;
    
    @Component
    public class SimpleJob extends QuartzJobBean { 
        @Override
        protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException { 
            JobDetail jobDetail = context.getJobDetail();
            //获取定时任务名字
            String  jobName  = jobDetail.getKey().getName();
            //获取定时任务组
            String  jobGroup  = jobDetail.getKey().getGroup();
            //获取定时任务的具体实现类
            String  jobClass =jobDetail.getJobClass().getName();
            System.out.println("=========SimpleJob中的executeInternal方法执行了===="+new Date()+
                    ", taskName: " + jobName + ", jobGroup: "+jobGroup+ ", jobClass: "+jobClass);
        }
    }

定时任务2

import org.quartz.JobExecutionContext;
    import org.quartz.JobExecutionException;
    import org.springframework.scheduling.quartz.QuartzJobBean;
    import org.springframework.stereotype.Component;
    
    import java.util.Date;
    
    @Component
    public class SimpleJobTwo extends QuartzJobBean { 
        @Override
        protected void executeInternal(JobExecutionContext context) throws JobExecutionException { 
            JobDetail jobDetail = context.getJobDetail();
            //获取定时任务名字
            String  jobName  = jobDetail.getKey().getName();
            //获取定时任务组
            String  jobGroup  = jobDetail.getKey().getGroup();
            //获取定时任务的具体实现类
            String  jobClass =jobDetail.getJobClass().getName();
            System.out.println("=========SimpleJob中的executeInternal方法执行了===="+new Date()+
                    ", taskName: " + jobName + ", jobGroup: "+jobGroup+ ", jobClass: "+jobClass);
        }
    }

定时任务配置类

@Configuration
    public class TaskConfig { 
    
    
    
        //配置定时任务1
        @Bean
        public JobDetailFactoryBean job1() { 
            JobDetailFactoryBean jobDetail = new JobDetailFactoryBean();
            //配置任务的具体实现
            jobDetail.setJobClass(SimpleJob.class);
            //是否持久化
            jobDetail.setDurability(true);
            //出现异常是否重新执行
            jobDetail.setRequestsRecovery(true);
            //配置定时任务信息
            jobDetail.setName("job1111------");
            jobDetail.setGroup("quartzTest--------");
            jobDetail.setDescription("这是job1111");
            return jobDetail;
        }
    
        //配置定时任务2
        @Bean
        public JobDetailFactoryBean job2() { 
            JobDetailFactoryBean jobDetail = new JobDetailFactoryBean();
            jobDetail.setJobClass(SimpleJobTwo.class);
            jobDetail.setDurability(true);
            jobDetail.setRequestsRecovery(true);
            jobDetail.setName("job22222------");
            jobDetail.setGroup("quartzTest--------");
            jobDetail.setDescription("这是job2222");
            return jobDetail;
        }
    
        //配置任务定时规则1
        @Bean
        public CronTriggerFactoryBean trigger1() { 
            CronTriggerFactoryBean cronTrigger = new CronTriggerFactoryBean();
            //定时规则的分组
            cronTrigger.setGroup("TriggerTest11111");
            cronTrigger.setName("trigger1");
            //配置执行的任务jobdetail
            cronTrigger.setJobDetail(job1().getObject());
            //配置执行规则 每5秒执行一次
            cronTrigger.setCronExpression("0/5 * * * * ?");
            return cronTrigger;
        }
    
        //配置任务定时规则2
        @Bean
        public CronTriggerFactoryBean trigger2() { 
            CronTriggerFactoryBean cronTrigger = new CronTriggerFactoryBean();
            cronTrigger.setGroup("TriggerTest2222");
            cronTrigger.setName("trigger2");
            cronTrigger.setJobDetail(job2().getObject());
            cronTrigger.setCronExpression("0/8 * * * * ?");
            return cronTrigger;
        }
    }

直接运行即可  
再拷贝一份项目用IDEA打开，运行，可以看到两运行的项目会间隔执行任务，可以单独一个执行任务，主要看谁能获取数据锁谁就可以执行。如果一直是单独一个执行，停掉正在打印的即可看到下一次打印执行的就是另一个。

注意：

第一次执行成功的后的定时任务类路径会记录在quartz的数据库中，即使下次启动项目不去配置相应的定时任务，如果执行类存在定时任务也是会执行的。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGVuZ3dlaTIzMDYxMg_size_16_color_FFFFFF_t_70]

参考：

[SpringBoot2.1.0整合Quartz实现分布式集群定时任务][SpringBoot2.1.0_Quartz]

[quartz官网][quartz]

[springboot整合quartz实现分布式定时任务集群][springboot_quartz]

[Spring+Quartz框架实现定时任务（集群，分布式）][Spring_Quartz]

[springboot整合Quartz实现定时任务][springboot_Quartz]

删除更新任务：

[使用quartz动态加载和删除定时任务][quartz 1]

[Quartz集群模式的定时任务][Quartz]

配置单独的数据库

[Quartz Spring分布式集群搭建Demo][Quartz Spring_Demo]

[20210305174937867.png]: /images/20221023/ca89e2ab07994da4b06a077c1cbec9cd.png
[quartz]: http://www.quartz-scheduler.org/
[20210305164341819.png]: /images/20221023/ff659ea02e2d4106884ed91f2cb71103.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGVuZ3dlaTIzMDYxMg_size_16_color_FFFFFF_t_70]: /images/20221023/07e90652d74f4a44b969a2715edbccd8.png
[SpringBoot2.1.0_Quartz]: https://blog.csdn.net/success_123/article/details/99626442
[springboot_quartz]: https://blog.csdn.net/sqlgao22/article/details/100669377
[Spring_Quartz]: https://www.cnblogs.com/luohero/p/8602306.html
[springboot_Quartz]: https://blog.csdn.net/xiaoxiangzi520/article/details/80895009?utm_source=blogxgwz9
[quartz 1]: https://blog.csdn.net/DWL0208/article/details/81775912
[Quartz]: https://blog.csdn.net/qq_26440803/article/details/83066238
[Quartz Spring_Demo]: https://www.cnblogs.com/dzpykj/p/9117716.htmll