spring-boot-quartz-demo

Spring boot Quartz Demo

  1. 配置pom.xml (建议看上gitee里看我的源码)

    
      org.springframework.boot
      spring-boot-starter-quartz
    
    
      org.springframework.boot
      spring-boot-starter-data-jpa
    
    
      mysql
      mysql-connector-java
    
    
  2. 初始化quartz sql 脚本

    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)
    )
        ENGINE = InnoDB;
    
    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)
    )
        ENGINE = InnoDB;
    
    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)
    )
        ENGINE = InnoDB;
    
    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),
        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)
    )
        ENGINE = InnoDB;
    
    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)
    )
        ENGINE = InnoDB;
    
    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),
        INDEX (SCHED_NAME, TRIGGER_NAME, TRIGGER_GROUP),
        FOREIGN KEY (SCHED_NAME, TRIGGER_NAME, TRIGGER_GROUP)
            REFERENCES QRTZ_TRIGGERS (SCHED_NAME, TRIGGER_NAME, TRIGGER_GROUP)
    )
        ENGINE = InnoDB;
    
    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;
    
    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;
    
    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)
    )
        ENGINE = InnoDB;
    
    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;
    
    CREATE TABLE QRTZ_LOCKS
    (
        SCHED_NAME VARCHAR(120) NOT NULL,
        LOCK_NAME  VARCHAR(40)  NOT NULL,
        PRIMARY KEY (SCHED_NAME, LOCK_NAME)
    )
        ENGINE = InnoDB;
    
    CREATE INDEX IDX_QRTZ_J_REQ_RECOVERY ON QRTZ_JOB_DETAILS (SCHED_NAME, REQUESTS_RECOVERY);
    CREATE INDEX IDX_QRTZ_J_GRP ON QRTZ_JOB_DETAILS (SCHED_NAME, JOB_GROUP);
    
    CREATE INDEX IDX_QRTZ_T_J ON QRTZ_TRIGGERS (SCHED_NAME, JOB_NAME, JOB_GROUP);
    CREATE INDEX IDX_QRTZ_T_JG ON QRTZ_TRIGGERS (SCHED_NAME, JOB_GROUP);
    CREATE INDEX IDX_QRTZ_T_C ON QRTZ_TRIGGERS (SCHED_NAME, CALENDAR_NAME);
    CREATE INDEX IDX_QRTZ_T_G ON QRTZ_TRIGGERS (SCHED_NAME, TRIGGER_GROUP);
    CREATE INDEX IDX_QRTZ_T_STATE ON QRTZ_TRIGGERS (SCHED_NAME, TRIGGER_STATE);
    CREATE INDEX IDX_QRTZ_T_N_STATE ON QRTZ_TRIGGERS (SCHED_NAME, TRIGGER_NAME, TRIGGER_GROUP, TRIGGER_STATE);
    CREATE INDEX IDX_QRTZ_T_N_G_STATE ON QRTZ_TRIGGERS (SCHED_NAME, TRIGGER_GROUP, TRIGGER_STATE);
    CREATE INDEX IDX_QRTZ_T_NEXT_FIRE_TIME ON QRTZ_TRIGGERS (SCHED_NAME, NEXT_FIRE_TIME);
    CREATE INDEX IDX_QRTZ_T_NFT_ST ON QRTZ_TRIGGERS (SCHED_NAME, TRIGGER_STATE, NEXT_FIRE_TIME);
    CREATE INDEX IDX_QRTZ_T_NFT_MISFIRE ON QRTZ_TRIGGERS (SCHED_NAME, MISFIRE_INSTR, NEXT_FIRE_TIME);
    CREATE INDEX IDX_QRTZ_T_NFT_ST_MISFIRE ON QRTZ_TRIGGERS (SCHED_NAME, MISFIRE_INSTR, NEXT_FIRE_TIME, TRIGGER_STATE);
    CREATE INDEX IDX_QRTZ_T_NFT_ST_MISFIRE_GRP ON QRTZ_TRIGGERS (SCHED_NAME, MISFIRE_INSTR, NEXT_FIRE_TIME, TRIGGER_GROUP,
                                                                 TRIGGER_STATE);
    
    CREATE INDEX IDX_QRTZ_FT_TRIG_INST_NAME ON QRTZ_FIRED_TRIGGERS (SCHED_NAME, INSTANCE_NAME);
    CREATE INDEX IDX_QRTZ_FT_INST_JOB_REQ_RCVRY ON QRTZ_FIRED_TRIGGERS (SCHED_NAME, INSTANCE_NAME, REQUESTS_RECOVERY);
    CREATE INDEX IDX_QRTZ_FT_J_G ON QRTZ_FIRED_TRIGGERS (SCHED_NAME, JOB_NAME, JOB_GROUP);
    CREATE INDEX IDX_QRTZ_FT_JG ON QRTZ_FIRED_TRIGGERS (SCHED_NAME, JOB_GROUP);
    CREATE INDEX IDX_QRTZ_FT_T_G ON QRTZ_FIRED_TRIGGERS (SCHED_NAME, TRIGGER_NAME, TRIGGER_GROUP);
    CREATE INDEX IDX_QRTZ_FT_TG ON QRTZ_FIRED_TRIGGERS (SCHED_NAME, TRIGGER_GROUP);
    
    commit;
    
  3. 编写Job

    @Component
    @Slf4j
    @DisallowConcurrentExecution
    @PersistJobDataAfterExecution
    public class TestJob extends QuartzJobBean {
    
      @Override
      protected void executeInternal(JobExecutionContext jobExecutionContext)
          throws JobExecutionException {
        log.info("test quartz");
      }
    }
    
  4. 编写Scheduler配置类

    @Configuration
    public class SchedulerConfig {
    
      @Bean
      public Scheduler scheduler(SchedulerFactoryBean schedulerFactory) throws SchedulerException {
        Scheduler scheduler = schedulerFactory.getScheduler();
        // start()一定要加,否则不生效
        scheduler.start();
        return scheduler;
      }
    
    }
    
  5. 编写Job,Trigger配置类

    @Configuration
    @Import(SchedulerConfig.class)
    public class QuartzJobConfig {
    
      @Value("${spring.quartz.job.cron}")
      private String cron;
    
      @Autowired private Scheduler scheduler;
    
      @PostConstruct
      public void initDemoJob() throws Exception {
        JobDetail job =
            newJob(TestJob.class)
                .withIdentity(TestJob.class.getName() + "_job", "test_job")
                .storeDurably()
                .build();
        Trigger trigger =
            newTrigger()
                .withIdentity(TestJob.class.getName() + "_trigger", "test_trigger")
                .withSchedule(CronScheduleBuilder.cronSchedule(cron))
                .forJob(job)
                .build();
        scheduler.scheduleJob(job, trigger);
      }
    }
    
  6. 编写yaml配置文件

    spring.datasource.url: jdbc:mysql://127.0.0.1:3306/quartz_demo?useUnicode=true&characterEncoding=UTF-8&useSSL=false&autoReconnect=true&failOverReadOnly=false&serverTimezone=GMT%2B8
    spring.datasource.username: root
    spring.datasource.password: 11111
    spring.datasource.driver-class-name: com.mysql.cj.jdbc.Driver
    
    spring.quartz.job-store-type: jdbc
    spring.quartz.auto-startup: true
    spring.quartz.jdbc.initialize-schema: always # 每次都初始化表
    spring.quartz.properties.org.quartz.scheduler.instanceName: MINI-RUMTIME-QUARTZ-SCHEDULER
    spring.quartz.properties.org.quartz.scheduler.instanceId: AUTO
    spring.quartz.properties.org.quartz.scheduler.rmi.export: false
    spring.quartz.properties.org.quartz.scheduler.rmi.proxy: false
    spring.quartz.properties.org.quartz.scheduler.xaTransacted: false
    spring.quartz.properties.org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
    spring.quartz.properties.org.quartz.threadPool.threadCount: 8
    
    spring.quartz.properties.org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX
    spring.quartz.properties.org.quartz.jobStore.driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate
    spring.quartz.properties.org.quartz.jobStore.tablePrefix: QRTZ_
    spring.quartz.properties.org.quartz.jobStore.isClustered: true # 开启集群模式
    spring.quartz.properties.org.quartz.jobStore.clusterCheckinInterval: 20000
    spring.quartz.properties.org.quartz.jobStore.useProperties: false
    spring.quartz.properties.org.quartz.jobStore.txIsolationLevelSerializable: false
    spring.quartz.properties.org.quartz.jobStore.acquireTriggersWithinLock: true
    
    spring.quartz.job.cron: 0/3 * * * * ? *
    
  7. 编写测试类

    @SpringBootApplication
    public class QuartzJobApplication {
    
      public static void main(String[] args) {
        SpringApplication.run(QuartzJobApplication.class, args);
      }
    }
    
  8. 执行结果(查看控制台,查看数据库表)

  9. 常见问题:

    • 为什么scheduler不生效?

      建议查看是否有显示的声明scheduler.start()

    • 为什么数据库里没有job或者trigger?

      建议查看配置文件里

      spring.quartz.job-store-type: jdbc

      spring.quartz.properties.org.quartz.jobStore.class: org.quartz.impl.jdbcjobstore.JobStoreTX spring.quartz.properties.org.quartz.jobStore.driverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegate

      另外可查看SchedulerFactoryBean是否注入了上面的属性

      @Bean
      public SchedulerFactoryBean schedulerFactory() {
       SchedulerFactoryBean schedulerFactory = new SchedulerFactoryBean();
       // 因为有可能有人会将quartz的配置独立出来,导致内置的SchedulerFactoryBean 无法获取到ConfigLocation,所以可通过此方法注入这些属性
       schedulerFactory.setConfigLocation(new ClassPathResource("quartz.properties"));
       // 省略其他配置
       return schedulerFactory;
      }
      
    • 如何初始化表数据?

      spring.quartz.jdbc.initialize-schema: always

    • 如何配置集群模式?

      spring.quartz.properties.org.quartz.scheduler.instanceName: MINI-RUMTIME-QUARTZ-SCHEDULER
      spring.quartz.properties.org.quartz.scheduler.instanceId: AUTO # 记录在QRTZ_SCHEDULER_STATE

      spring.quartz.properties.org.quartz.jobStore.isClustered: true
      spring.quartz.properties.org.quartz.jobStore.clusterCheckinInterval: 20000

    • 如何确保不会并发执行多个实例?

      @DisallowConcurrentExecution
      @PersistJobDataAfterExecution

    • 为什么trigger_status刚调用了schedule就为error

      1. 看执行的job是否出错了。
      2. 看集群模式下,多个实例是否都有该job运行的逻辑。(本人开发环境和测试环境连的同一个数据库,在开发job的时候,代码没有问题。但就是不执行job,看数据表QRTZ_TRIGGERS中的字段TRIGGER_STATUS的值为error。主要原因是因为开发环境的job还没部署在测试环境,每次都是测试环境跑的job,导致该问题)

源码

你可能感兴趣的:(spring-boot-quartz-demo)