spring-boot-quartz-demo

Spring boot Quartz Demo

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

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-quartz</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
    </dependency>
    
  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,导致该问题)

源码

最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,172评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,346评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,788评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,299评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,409评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,467评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,476评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,262评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,699评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,994评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,167评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,827评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,499评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,149评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,387评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,028评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,055评论 2 352