定时任务

说明

在产品的的需求中，有存在一类需求，是需要去定时执行的，此时就需要使用到定时任务。例如说，每小时清理一次日志文件，每天统计前一天的数据并生成报表，每个月月初的报表的推送等等

初始化

初始化附录里面的数据库脚本

直接复制对应业务系统数据库类型的脚本执行

菜单

将xml目录文件JOB-MENU.xml (opens new window),导入到业务系统权限平台,具体子菜单根据业务实际实际需求开放

菜单说明

菜单	说明	地址
定时任务	/appTiangong/TgJob/TgJob/TgJobList	管理和配置定时任务
任务日志	/appTiangong/TgJob/TgJobLog/TgJobLogList	定时任务日志

配置

application.yml

spring:  
  # Quartz 配置项，对应 QuartzProperties 配置类  
  quartz:  
    auto-startup: true # 本地开发环境，尽量不要开启 Job    scheduler-name: schedulerName # Scheduler 名字。默认为 schedulerName    job-store-type: jdbc # Job 存储器类型。默认为 memory 表示内存，可选 jdbc 使用数据库。  
    wait-for-jobs-to-complete-on-shutdown: true # 应用关闭时，是否等待定时任务执行完成。默认为 false ，建议设置为 true    properties: # 添加 Quartz Scheduler 附加属性，更多可以看 http://www.quartz-scheduler.org/documentation/2.4.0-SNAPSHOT/configuration.html 文档  
      org:  
        quartz:  
          # Scheduler 相关配置  
          scheduler:  
            instanceName: schedulerName  
            instanceId: AUTO # 自动生成 instance ID          # JobStore 相关配置  
          jobStore:  
            # JobStore 实现类。可见博客：https://blog.csdn.net/weixin_42458219/article/details/122247162  
            class: org.springframework.scheduling.quartz.LocalDataSourceJobStore  
            isClustered: true # 是集群模式  
            clusterCheckinInterval: 15000 # 集群检查频率，单位：毫秒。默认为 15000，即 15 秒  
            misfireThreshold: 60000 # misfire 阀值，单位：毫秒。  
          # 线程池相关配置  
          threadPool:  
            threadCount: 25 # 线程池大小。默认为 10 。  
            threadPriority: 5 # 线程优先级  
            class: org.quartz.simpl.SimpleThreadPool # 线程池类型  
    jdbc: # 使用 JDBC 的 JobStore 的时候，JDBC 的配置  
      initialize-schema: NEVER # 是否自动使用 SQL 初始化 Quartz 表结构。这里设置成 never ，我们手动创建表结构。

使用

1. 实现JobHandler接口

1. 新建一个类继承接口JobHandler
2. 实现接口方法

@Component  
public class AppGenJob implements JobHandler {  
    @Override  
    public String execute(String param)  {  
        System.out.println("AppGenJob 定时任务被执行了：" + new Date());  
  
        return "AppGenJob 定时任务被执行了：" + new Date();  
    }  
}

2. 新增定时任务

1. 在定时任务菜单新增一个定时任务
2. 处理器的名字为实现JobHandler接口的类,注意首字母小写
3. 注意用户信息无法通过userinfo类获取,需要手动传入

附录

初始化表结构 如果已有则无需新建 这里只提供mysql,其他数据库请从后端框架->开发脚本中获取

表信息

表名	说明
TG_JOB	定时任务
TG_JOB_LOG	定时任务日志
QRTZ_*	定时任务执行表

mysql

-- ECI_TG.TG_JOB definition  
DROP TABLE IF EXISTS `TG_JOB`;  
  
CREATE TABLE `TG_JOB`  
(  
    `ID`              bigint(20)                                                   NOT NULL AUTO_INCREMENT COMMENT '任务编号',  
    `NAME`            varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '任务名称',  
    `STATUS`          varchar(10) COLLATE utf8mb4_unicode_ci                       NOT NULL COMMENT '任务状态',  
    `HANDLER_NAME`    varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '处理器的名字',  
    `HANDLER_PARAM`   varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci         DEFAULT NULL COMMENT '处理器的参数',  
    `CRON_EXPRESSION` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'CRON 表达式',  
    `RETRY_COUNT`     int(11)                                                      NOT NULL DEFAULT '0' COMMENT '重试次数',  
    `RETRY_INTERVAL`  int(11)                                                      NOT NULL DEFAULT '0' COMMENT '重试间隔',  
    `MONITOR_TIMEOUT` int(11)                                                      NOT NULL DEFAULT '0' COMMENT '监控超时时间',  
    `CREATOR`         varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci          DEFAULT '' COMMENT '创建者',  
    `CREATE_TIME`     datetime                                                     NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',  
    `UPDATER`         varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci          DEFAULT '' COMMENT '更新者',  
    `UPDATE_TIME`     datetime                                                     NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',  
    `DELETED`         int(11)                                                      NOT NULL DEFAULT '0' COMMENT '是否删除',  
    PRIMARY KEY (`ID`) USING BTREE  
) ENGINE = InnoDB  
  AUTO_INCREMENT = 1401217497055233  
  DEFAULT CHARSET = utf8mb4  
  COLLATE = utf8mb4_unicode_ci COMMENT ='定时任务表';  
  
  
-- ECI_TG.TG_JOB_LOG definition  
DROP TABLE IF EXISTS `TG_JOB_LOG`;  
  
CREATE TABLE `TG_JOB_LOG`  
(  
    `ID`            bigint(20)                                                   NOT NULL AUTO_INCREMENT COMMENT '日志编号',  
    `JOB_ID`        bigint(20)                                                   NOT NULL COMMENT '任务编号',  
    `HANDLER_NAME`  varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '处理器的名字',  
    `HANDLER_PARAM` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci         DEFAULT NULL COMMENT '处理器的参数',  
    `EXECUTE_INDEX` bigint(20)                                                   NOT NULL DEFAULT '1' COMMENT '第几次执行',  
    `BEGIN_TIME`    datetime                                                     NOT NULL COMMENT '开始执行时间',  
    `END_TIME`      datetime                                                              DEFAULT NULL COMMENT '结束执行时间',  
    `DURATION`      int(11)                                                               DEFAULT NULL COMMENT '执行时长',  
    `STATUS`        varchar(10) COLLATE utf8mb4_unicode_ci                       NOT NULL COMMENT '任务状态',  
    `RESULT`        varchar(4000) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci        DEFAULT '' COMMENT '结果数据',  
    `CREATOR`       varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci          DEFAULT '' COMMENT '创建者',  
    `CREATE_TIME`   datetime                                                     NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',  
    `UPDATER`       varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci          DEFAULT '' COMMENT '更新者',  
    `UPDATE_TIME`   datetime                                                     NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',  
    `DELETED`       int(11)                                                      NOT NULL DEFAULT '0' COMMENT '是否删除',  
    PRIMARY KEY (`ID`) USING BTREE  
) ENGINE = InnoDB  
  AUTO_INCREMENT = 1401236819329025  
  DEFAULT CHARSET = utf8mb4  
  COLLATE = utf8mb4_unicode_ci COMMENT ='定时任务日志表';  
  
  
-- ECI_TG.QRTZ_CALENDARS definition  
DROP TABLE IF EXISTS `QRTZ_CALENDARS`;  
CREATE TABLE `QRTZ_CALENDARS`  
(  
    `SCHED_NAME`    varchar(120) NOT NULL,  
    `CALENDAR_NAME` varchar(190) NOT NULL,  
    `CALENDAR`      blob         NOT NULL,  
    PRIMARY KEY (`SCHED_NAME`, `CALENDAR_NAME`)  
) ENGINE = InnoDB  
  DEFAULT CHARSET = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_CRON_TRIGGERS definition  
DROP TABLE IF EXISTS `QRTZ_SIMPROP_TRIGGERS`;  
CREATE TABLE `QRTZ_CRON_TRIGGERS`  
(  
    `SCHED_NAME`      varchar(120) NOT NULL,  
    `TRIGGER_NAME`    varchar(190) NOT NULL,  
    `TRIGGER_GROUP`   varchar(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_FIRED_TRIGGERS definition  
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(190) NOT NULL,  
    `TRIGGER_GROUP`     varchar(190) NOT NULL,  
    `INSTANCE_NAME`     varchar(190) 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(190) DEFAULT NULL,  
    `JOB_GROUP`         varchar(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_JOB_DETAILS definition  
DROP TABLE IF EXISTS `QRTZ_JOB_DETAILS`;  
CREATE TABLE `QRTZ_JOB_DETAILS`  
(  
    `SCHED_NAME`        varchar(120) NOT NULL,  
    `JOB_NAME`          varchar(190) NOT NULL,  
    `JOB_GROUP`         varchar(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_LOCKS definition  
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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_PAUSED_TRIGGER_GRPS definition  
DROP TABLE IF EXISTS `QRTZ_PAUSED_TRIGGER_GRPS`;  
CREATE TABLE `QRTZ_PAUSED_TRIGGER_GRPS`  
(  
    `SCHED_NAME`    varchar(120) NOT NULL,  
    `TRIGGER_GROUP` varchar(190) NOT NULL,  
    PRIMARY KEY (`SCHED_NAME`, `TRIGGER_GROUP`)  
) ENGINE = InnoDB  
  DEFAULT CHARSET = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_SCHEDULER_STATE definition  
DROP TABLE IF EXISTS `QRTZ_SCHEDULER_STATE`;  
CREATE TABLE `QRTZ_SCHEDULER_STATE`  
(  
    `SCHED_NAME`        varchar(120) NOT NULL,  
    `INSTANCE_NAME`     varchar(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_TRIGGERS definition  
DROP TABLE IF EXISTS `QRTZ_TRIGGERS`;  
CREATE TABLE `QRTZ_TRIGGERS`  
(  
    `SCHED_NAME`     varchar(120) NOT NULL,  
    `TRIGGER_NAME`   varchar(190) NOT NULL,  
    `TRIGGER_GROUP`  varchar(190) NOT NULL,  
    `JOB_NAME`       varchar(190) NOT NULL,  
    `JOB_GROUP`      varchar(190) 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(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_BLOB_TRIGGERS definition  
DROP TABLE IF EXISTS `QRTZ_BLOB_TRIGGERS`;  
CREATE TABLE `QRTZ_BLOB_TRIGGERS`  
(  
    `SCHED_NAME`    varchar(120) NOT NULL,  
    `TRIGGER_NAME`  varchar(190) NOT NULL,  
    `TRIGGER_GROUP` varchar(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_SIMPLE_TRIGGERS definition  
DROP TABLE IF EXISTS `QRTZ_SIMPLE_TRIGGERS`;  
CREATE TABLE `QRTZ_SIMPLE_TRIGGERS`  
(  
    `SCHED_NAME`      varchar(120) NOT NULL,  
    `TRIGGER_NAME`    varchar(190) NOT NULL,  
    `TRIGGER_GROUP`   varchar(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;  
  
  
-- ECI_TG.QRTZ_SIMPROP_TRIGGERS definition  
DROP TABLE IF EXISTS `QRTZ_SIMPROP_TRIGGERS`;  
CREATE TABLE `QRTZ_SIMPROP_TRIGGERS`  
(  
    `SCHED_NAME`    varchar(120) NOT NULL,  
    `TRIGGER_NAME`  varchar(190) NOT NULL,  
    `TRIGGER_GROUP` varchar(190) 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 = utf8mb4  
  COLLATE = utf8mb4_0900_ai_ci;