JB4-9-任务调度
Java道经第4卷 - 第9阶 - 任务调度
文章目录
- S01. XXL-JOB
- E01. 基础入门概念
- 1. 单机调度
- 2. 分布式调度
- 3. xxl-job
- E02. 基础环境搭建
- 1. 初始化数据库
- 2. 安装调度中心
- 3. 搭建测试项目
- E03. 配置定时任务
- 1. 添加执行器
- 2. 添加定时任务
- 3. 测试任务调度
- 4. 启动任务调度
心法:本章使用 Maven 父子结构项目进行练习
练习项目结构如下:
|_ v4-9-micro-job|_ 14901 sale-service-01|_ 14902 sale-service-02
武技:搭建练习项目结构
- 创建父项目 v4-9-micro-job,删除 src 目录。
- 在父项目中管理依赖:
<properties><maven.compiler.source>17</maven.compiler.source><maven.compiler.target>17</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><spring-boot.version>3.2.5</spring-boot.version><junit.version>4.13.2</junit.version><lombok.version>1.18.24</lombok.version><hutool-all.version>5.8.25</hutool-all.version><xxl-job-core.version>2.4.2</xxl-job-core.version>
</properties><dependencyManagement><dependencies><!--spring-boot-starter-parent--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>${spring-boot.version}</version><type>pom</type><scope>import</scope></dependency></dependencies>
</dependencyManagement>
- 在父项目中添加依赖:
<dependencies><!--junit--><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>${junit.version}</version><scope>test</scope></dependency><!--lombok--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>${lombok.version}</version><scope>provided</scope></dependency><!--hutool-all--><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>${hutool-all.version}</version></dependency>
</dependencies>
S01. XXL-JOB
E01. 基础入门概念
心法:定时任务是指按照预先设定的时间或时间间隔来自动执行特定操作的任务,常出现于营销系统中定时发送优惠卷,定时发送营销短信,或订单系统中每天清算对账等场景。
1. 单机调度
心法:单机调度是指在非集群模式下的定时任务调度,在集群环境下存在重复调度风险,虽然可以通过加锁解决,但徒增很多非业务逻辑,且单机调度不支持统计,不支持分片处理,不支持高可用,没有管理平台,没有告警和监控等。
单机调度产品 | 描述 |
---|---|
Timer | 来自 JDK,基于单线程,有时间延迟 BUG 和单点异常 BUG |
ScheduledExecutorService | 来自 JDK,基于线程池,无时间延迟 BUG 和单点异常 BUG |
@Scheduled | 基于 ScheduledExecutorService 实现 |
2. 分布式调度
心法:分布式调度将任务接入统一的管理平台并进行管理和统一调度,在集群环境下可配置调度方式,如一致性哈希,轮询,LRU,LFU 等,支持统计,支持分片处理,支持高可用,自带管理平台,支持告警和监控等。
分布式调度产品 | 描述 |
---|---|
Quartz | 支持集群,但缺少并行调度功能,不支持分片,无管理界面。 |
TBSchedule | 基于 timer 工具,有 BUG,作业类型单一,文档缺失严重,官网目前也 404 了 |
Schedulex | 目前阿里内部使用,阿里云也有对应的商业化版本 |
Elastic-job | 基于 zookeeper 实现,支持集群和分片,20 年 6 月加入 Apache 仓库 |
XXL-job | 大众点评的员工许雪里在 15 年发布的分布式任务调度平台,推荐使用 |
3. xxl-job
心法:xxl-job 是一个 开源 的分布式任务调度平台,开发迅速,学习简单,轻量级,易扩展,文档齐全,核心组件是调度中心和执行器,二者需要双向连接,所以在搭建时均需要配置各自的端口号。
组件 | 描述 |
---|---|
调度中心 | 负责管理调度的信息,按照调度的配置来发出调度请求,支持高可用 |
执行器 | 负责接收请求并且执行项目中的 JobHandler 任务,支持高可用 |
XXL-JOB 流程图:
E02. 基础环境搭建
1. 初始化数据库
心法:xxl-job 相关数据库表
表名 | 描述 |
---|---|
xxl_job_group | 记录任务执行器的信息 |
xxl_job_info | 记录调度任务的扩展信息,如任务分组,任务名,机器地址等 |
xxl_job_lock | 记录任务调度的锁信息 |
xxl_job_log | 记录任务调度日志,如调度结果,执行结果,调度入参等 |
xxl_job_log_report | 记录任务调度日志报表,主要用于在调度中心进行报表展示 |
xxl_job_logglue | 记录任务的 GLUE 日志,用于支持 GLUE 版本的回溯功能 |
xxl_job_registry | 记录执行器的注册信息,如在线的执行器与调度中心的地址信息 |
xxl_job_user | 记录系统的用户信息 |
武技:下载项目源码并解压,获取 “tables_xxl_job.sql” 并执行即可。
#
# XXL-JOB
# Copyright (c) 2015-present, xuxueli.CREATE database if NOT EXISTS `xxl_job` default character set utf8mb4 collate utf8mb4_unicode_ci;
use `xxl_job`;SET NAMES utf8mb4;CREATE TABLE `xxl_job_info` (`id` int(11) NOT NULL AUTO_INCREMENT,`job_group` int(11) NOT NULL COMMENT '执行器主键ID',`job_desc` varchar(255) NOT NULL,`add_time` datetime DEFAULT NULL,`update_time` datetime DEFAULT NULL,`author` varchar(64) DEFAULT NULL COMMENT '作者',`alarm_email` varchar(255) DEFAULT NULL COMMENT '报警邮件',`schedule_type` varchar(50) NOT NULL DEFAULT 'NONE' COMMENT '调度类型',`schedule_conf` varchar(128) DEFAULT NULL COMMENT '调度配置,值含义取决于调度类型',`misfire_strategy` varchar(50) NOT NULL DEFAULT 'DO_NOTHING' COMMENT '调度过期策略',`executor_route_strategy` varchar(50) DEFAULT NULL COMMENT '执行器路由策略',`executor_handler` varchar(255) DEFAULT NULL COMMENT '执行器任务handler',`executor_param` varchar(512) DEFAULT NULL COMMENT '执行器任务参数',`executor_block_strategy` varchar(50) DEFAULT NULL COMMENT '阻塞处理策略',`executor_timeout` int(11) NOT NULL DEFAULT '0' COMMENT '任务执行超时时间,单位秒',`executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失败重试次数',`glue_type` varchar(50) NOT NULL COMMENT 'GLUE类型',`glue_source` mediumtext COMMENT 'GLUE源代码',`glue_remark` varchar(128) DEFAULT NULL COMMENT 'GLUE备注',`glue_updatetime` datetime DEFAULT NULL COMMENT 'GLUE更新时间',`child_jobid` varchar(255) DEFAULT NULL COMMENT '子任务ID,多个逗号分隔',`trigger_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '调度状态:0-停止,1-运行',`trigger_last_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '上次调度时间',`trigger_next_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '下次调度时间',PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE `xxl_job_log` (`id` bigint(20) NOT NULL AUTO_INCREMENT,`job_group` int(11) NOT NULL COMMENT '执行器主键ID',`job_id` int(11) NOT NULL COMMENT '任务,主键ID',`executor_address` varchar(255) DEFAULT NULL COMMENT '执行器地址,本次执行的地址',`executor_handler` varchar(255) DEFAULT NULL COMMENT '执行器任务handler',`executor_param` varchar(512) DEFAULT NULL COMMENT '执行器任务参数',`executor_sharding_param` varchar(20) DEFAULT NULL COMMENT '执行器任务分片参数,格式如 1/2',`executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失败重试次数',`trigger_time` datetime DEFAULT NULL COMMENT '调度-时间',`trigger_code` int(11) NOT NULL COMMENT '调度-结果',`trigger_msg` text COMMENT '调度-日志',`handle_time` datetime DEFAULT NULL COMMENT '执行-时间',`handle_code` int(11) NOT NULL COMMENT '执行-状态',`handle_msg` text COMMENT '执行-日志',`alarm_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '告警状态:0-默认、1-无需告警、2-告警成功、3-告警失败',PRIMARY KEY (`id`),KEY `I_trigger_time` (`trigger_time`),KEY `I_handle_code` (`handle_code`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE `xxl_job_log_report` (`id` int(11) NOT NULL AUTO_INCREMENT,`trigger_day` datetime DEFAULT NULL COMMENT '调度-时间',`running_count` int(11) NOT NULL DEFAULT '0' COMMENT '运行中-日志数量',`suc_count` int(11) NOT NULL DEFAULT '0' COMMENT '执行成功-日志数量',`fail_count` int(11) NOT NULL DEFAULT '0' COMMENT '执行失败-日志数量',`update_time` datetime DEFAULT NULL,PRIMARY KEY (`id`),UNIQUE KEY `i_trigger_day` (`trigger_day`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE `xxl_job_logglue` (`id` int(11) NOT NULL AUTO_INCREMENT,`job_id` int(11) NOT NULL COMMENT '任务,主键ID',`glue_type` varchar(50) DEFAULT NULL COMMENT 'GLUE类型',`glue_source` mediumtext COMMENT 'GLUE源代码',`glue_remark` varchar(128) NOT NULL COMMENT 'GLUE备注',`add_time` datetime DEFAULT NULL,`update_time` datetime DEFAULT NULL,PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE `xxl_job_registry` (`id` int(11) NOT NULL AUTO_INCREMENT,`registry_group` varchar(50) NOT NULL,`registry_key` varchar(255) NOT NULL,`registry_value` varchar(255) NOT NULL,`update_time` datetime DEFAULT NULL,PRIMARY KEY (`id`),KEY `i_g_k_v` (`registry_group`,`registry_key`,`registry_value`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE `xxl_job_group` (`id` int(11) NOT NULL AUTO_INCREMENT,`app_name` varchar(64) NOT NULL COMMENT '执行器AppName',`title` varchar(12) NOT NULL COMMENT '执行器名称',`address_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '执行器地址类型:0=自动注册、1=手动录入',`address_list` text COMMENT '执行器地址列表,多地址逗号分隔',`update_time` datetime DEFAULT NULL,PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE `xxl_job_user` (`id` int(11) NOT NULL AUTO_INCREMENT,`username` varchar(50) NOT NULL COMMENT '账号',`password` varchar(50) NOT NULL COMMENT '密码',`role` tinyint(4) NOT NULL COMMENT '角色:0-普通用户、1-管理员',`permission` varchar(255) DEFAULT NULL COMMENT '权限:执行器ID列表,多个逗号分割',PRIMARY KEY (`id`),UNIQUE KEY `i_username` (`username`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;CREATE TABLE `xxl_job_lock` (`lock_name` varchar(50) NOT NULL COMMENT '锁名称',PRIMARY KEY (`lock_name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;INSERT INTO `xxl_job_group`(`id`, `app_name`, `title`, `address_type`, `address_list`, `update_time`) VALUES (1, 'xxl-job-executor-sample', '示例执行器', 0, NULL, '2018-11-03 22:21:31' );
INSERT INTO `xxl_job_info`(`id`, `job_group`, `job_desc`, `add_time`, `update_time`, `author`, `alarm_email`, `schedule_type`, `schedule_conf`, `misfire_strategy`, `executor_route_strategy`, `executor_handler`, `executor_param`, `executor_block_strategy`, `executor_timeout`, `executor_fail_retry_count`, `glue_type`, `glue_source`, `glue_remark`, `glue_updatetime`, `child_jobid`) VALUES (1, 1, '测试任务1', '2018-11-03 22:21:31', '2018-11-03 22:21:31', 'XXL', '', 'CRON', '0 0 0 * * ? *', 'DO_NOTHING', 'FIRST', 'demoJobHandler', '', 'SERIAL_EXECUTION', 0, 0, 'BEAN', '', 'GLUE代码初始化', '2018-11-03 22:21:31', '');
INSERT INTO `xxl_job_user`(`id`, `username`, `password`, `role`, `permission`) VALUES (1, 'admin', 'e10adc3949ba59abbe56e057f20f883e', 1, NULL);
INSERT INTO `xxl_job_lock` ( `lock_name`) VALUES ( 'schedule_lock');commit;
2. 安装调度中心
- 创建准备目录:
# 创建目录
mkdir -p /opt/xxl-job/log;
chmod -R 777 /opt/xxl-job;
- 安装调度中心容器:
# 拉取镜像,2选1
docker pull xuxueli/xxl-job-admin:2.4.2;
docker pull registry.cn-hangzhou.aliyuncs.com/joezhou/xxl-job-admin:2.4.2;# 运行容器
docker run -itd --name xxl-job-admin \--network my-net -p 9527:8080 \-v /opt/xxl-job/log:/data/applogs \-e PARAMS="--spring.datasource.url=jdbc:mysql://192.168.40.77:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=root --xxl.job.accessToken=twgdh" \registry.cn-hangzhou.aliyuncs.com/joezhou/xxl-job-admin:2.4.2;# 查看容器
docker ps -a --format "table {{.ID}}\t{{.Names}}\t{{.Ports}}"
docker logs xxl-job-admin --tail 30# 开放端口
firewall-cmd --add-port=9527/tcp --permanent
firewall-cmd --reload
- 访问 XXL-JOB 调度中心 http://192.168.40.77:9527/xxl-job-admin:使用 admin/123456 登录。
3. 搭建测试项目
武技:创建 sale-service-01 和 sale-service-02 子项目,模拟集群。
- 分别在两个子项目中添加三方依赖:
<dependencies><!--xxl-job-core--><dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>${xxl-job-core.version}</version></dependency><!--spring-boot-starter-web--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--spring-boot-starter-test--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId></dependency>
</dependencies>
- 在 sale-service-01 子项目中开发主配文件:
server:port: 14901 # 端口号xxl:job:admin:addresses: http://192.168.40.77:9527/xxl-job-admin # 调度中心地址,集群逗号分割accessToken: twgdh # 与调度中心的接头暗号(需要和调度中心服务器保持一致)executor:appName: sale-executor # 执行器名称port: 14911 # 执行器端口,默认 9999,单机部署多个执行器时需要配置不同的执行器端口logPath: ./log/xxl-job # 执行器日志存储位置logRetentionDays: 30 # 执行器日志保存天数
- 在 sale-service-02 子项目中开发主配文件:
server:port: 14902 # 端口号xxl:job:admin:addresses: http://192.168.40.77:9527/xxl-job-admin # 调度中心地址,集群逗号分割accessToken: twgdh # 与调度中心的接头暗号(需要和调度中心服务器保持一致)executor:appName: sale-executor # 执行器名称port: 14922 # 执行器端口,默认 9999,单机部署多个执行器时需要配置不同的执行器端口logPath: ./log/xxl-job # 执行器日志存储位置logRetentionDays: 30 # 执行器日志保存天数
- 分别在两个子项目中开发 xxl-job 配置类,该配置类主要用于读取主配文件中的属性并管理一个 XxlJobSpringExecutor 执行器的 Bean 实例:
package com.joezhou.config;/** @author xuxueli 2017-04-28 */
@Slf4j
@Configuration
public class XxlJobConfig {@Value("${xxl.job.admin.addresses}")private String adminAddresses;@Value("${xxl.job.accessToken}")private String accessToken;@Value("${xxl.job.executor.appName}")private String appName;@Value("${xxl.job.executor.port}")private int port;@Value("${xxl.job.executor.logPath}")private String logPath;@Value("${xxl.job.executor.logRetentionDays}")private int logRetentionDays;@Beanpublic XxlJobSpringExecutor xxlJobExecutor() {log.info(">>>>>>>>>>> xxl-job config init.");XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();xxlJobSpringExecutor.setAdminAddresses(adminAddresses);xxlJobSpringExecutor.setAppname(appName);xxlJobSpringExecutor.setAddress("");xxlJobSpringExecutor.setIp("");xxlJobSpringExecutor.setPort(port);xxlJobSpringExecutor.setAccessToken(accessToken);xxlJobSpringExecutor.setLogPath(logPath);xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);return xxlJobSpringExecutor;}
}
- 在 sale-service-01 项目中开发启动类:
package com.joezhou;/** @author 周航宇 */
@SpringBootApplication
public class SaleService01App {public static void main(String[] args) {SpringApplication.run(SaleService01App.class, args);}
}
- 在 sale-service-02 项目中开发启动类:
package com.joezhou;/** @author 周航宇 */
@SpringBootApplication
public class SaleService02App {public static void main(String[] args) {SpringApplication.run(SaleService02App.class, args);}
}
- 分别在两个子项目中开发任务类:
package com.joezhou.job;/** @author 周航宇 */
@Slf4j
@Component
public class SaleMessageJob {/** 向指定用户发送一条广告营销短信 */@XxlJob(value = "sendMessage", init = "init", destroy = "destroy")public void sendMessage() throws Exception {// 发送执行日志XxlJobHelper.log("我是一条执行日志!");// 获取参数,并转为 int 类型int userId = Integer.parseInt(XxlJobHelper.getJobParam());// 假设只有10个用户if (userId > 0 && userId < 10) {String msg = "访问成功!向" + userId + "号用户发送一条广告营销短信";log.info(msg);XxlJobHelper.handleSuccess(msg);} else {String msg = "访问失败!" + userId + "号用户不存在";log.warn(msg);XxlJobHelper.handleFail(msg);}}/** 初始化方法,任务方法执行开始前执行,且仅会执行一次 */private void init() {log.info("init()");}/** 销毁方法,任务方法执行完毕后执行,且仅会执行一次 */private void destroy() {log.info("destroy()");}
}
E03. 配置定时任务
1. 添加执行器
心法:先在调度中心添加执行器,然后再启动项目。
- 在调度中心添加执行器:
配置项 | 值 | 描述 |
---|---|---|
AppName | sale-executor | 每个执行器的唯一标识 |
名称 | 营销微服务01节点 | 执行器名称,支持中文,提高可读性 |
注册方式 | 自动注册 | 自动注册时可以自动发现项目地址,手动注册时需要手动输入项目地址 |
机器地址 | - | 注册方式为手动录入时才可使用,用于输入地址 |
- 点击保存后,大概需要 30 秒才能回显机器的地址:
- 启动项目,30 秒后会将项目注册到任务调度中心,可在执行器管理页面查看注册节点:
2. 添加定时任务
武技:在调度中心添加定时任务
配置项 | 值 | 描述 |
---|---|---|
运行模式 | CRON | CRON 表达式 |
JobHandler | sendMessage | 填写项目中的 @XxlJob 注解中配置的 value 值 |
路由策略 | 第一个 |
3. 测试任务调度
- 选择
任务管理 -> 操作 -> 执行一次
,该操作用于测试:
- 查看
XxlJobHelper.handleSuccess/handleFail()
对应的调度日志结果备注:
- 查看
XxlJobHelper.log()
对应的执行日志:
- 查看控制台日志:
4. 启动任务调度
- 选择
任务管理 -> 操作 -> 启动
:
Java道经第4卷 - 第9阶 - 任务调度