1、简述
XXL-JOB 是一个分布式任务调度平台,提供简单易用的任务调度功能。它支持分布式调度、失败重试、任务监控和报警等功能。XXL-JOB 采用了服务端与执行器的架构,任务调度在服务端进行,而任务的实际执行则由各个执行器完成。
XXL-JOB 的核心功能包括:
- 支持分布式任务调度和多执行器集群。
- 支持动态管理任务,定时调度和 CRON 表达式调度。
- 提供失败重试机制和任务日志监控。
- 支持多种报警方式。
2、安装
为了方便启动 XXL-JOB,可以使用 Docker Compose 来管理调度中心和数据库服务。首先,创建一个 docker-compose.yml 文件,内容如下:
version: "3"
services:xxl-job-mysql:image: mysql:5.7.35restart: always container_name: xxl-job-mysql environment:#设置root的密码MYSQL_ROOT_PASSWORD: nPnam2mYb82Dpf6N TZ: Asia/Shanghai# 初始化数据库(后续的初始化sql会在这个库执行)MYSQL_DATABASE: xxl_job# 初始化用户(不能是root 会报错, 后续需要给新用户赋予权限)MYSQL_USER: xxlJob# 用户密码MYSQL_PASSWORD: xxlJob123ports:- 3307:3306 volumes: # 数据挂载 data 文件夹是数据存储目录 (如果mysql初始化错误 需要将文件夹内部全部删除)- mysql_data:/var/lib/mysql/# 初始化目录挂载 init 文件夹可以放置 .sh .sql 文件 在初始化容器时会执行- ./mysql_init:/docker-entrypoint-initdb.d#加入指定网络networks: - xxl_jobxxl-job-admin:restart: always# docker 镜像image: xuxueli/xxl-job-admin:2.4.0# 容器名称container_name: xxl-job-adminvolumes:# 日志目录映射到主机目录- /xxl_job_log:/data/applogsports:# 端口映射- 8800:8080environment:# 设置启动参数PARAMS: '--server.port=8080--server.servlet.context-path=/xxl-job-admin--spring.datasource.url=jdbc:mysql://xxl-job-mysql/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai--spring.datasource.username=root--spring.datasource.password=nPnam2mYb82Dpf6N'depends_on:- xxl-job-mysqllinks:- xxl-job-mysql#加入指定网络networks: - xxl_job # 其他配置 网络/卷、全局规则
volumes:# 如果有xxx_data这个卷就会直接使用它,否则会创建一个新的卷并使用xxl_job_log: { }mysql_data: { }# 虚拟局域网
networks:xxl_job:driver: bridge
在当前目录下,新建mysql_init文件夹;然后新建一个xxx.sql文件(初始化数据库用到):
CREATE database if NOT EXISTS `xxl_job` default character set utf8mb4 collate utf8mb4_general_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;
执行以下命令启动 XXL-JOB 和 MySQL 服务:
docker-compose up -d
此命令会启动 MySQL 和 XXL-JOB 管理端,管理端将运行在 http://localhost:8800/xxl-job-admin。默认登录用户名和密码均为 admin/123456。
3、集成 XXL-JOB 示例
3.1 Maven 项目依赖
在你的 Java 项目中,添加 XXL-JOB 的依赖。假设项目使用的是 Maven,可以在 pom.xml 中添加以下依赖:
<dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.3.0</version>
</dependency>
3.2 编写执行器配置
首先,需要在项目中配置 XXL-JOB 的执行器。下面是一个简单的 Spring Boot 配置类:
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class XxlJobConfig {@Beanpublic XxlJobSpringExecutor xxlJobExecutor() {XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();xxlJobSpringExecutor.setAdminAddresses("http://192.168.157.129:8800/xxl-job-admin");xxlJobSpringExecutor.setAppname("xxl-job-executor-sample");xxlJobSpringExecutor.setIp(null); // 自动获取本机IPxxlJobSpringExecutor.setPort(9999); // 设置执行器端口xxlJobSpringExecutor.setAccessToken("default_token"); // 设置访问令牌xxlJobSpringExecutor.setLogPath("/data/applogs/xxl-job/jobhandler");xxlJobSpringExecutor.setLogRetentionDays(30);return xxlJobSpringExecutor;}
}
此配置类将执行器注册到 XXL-JOB 调度中心,并指定执行器的名称、端口及日志保存路径。
3.3 编写任务处理器
XXL-JOB 使用任务处理器(JobHandler)来定义任务的具体逻辑。可以通过注解 @XxlJob 来声明任务,以下是一个简单的任务示例:
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;@Component
public class SampleJob {@XxlJob("sampleJobHandler")public void sampleJobHandler() {System.out.println("XXL-JOB 执行成功!");}
}
3.4 配置调度任务
接下来,可以在 XXL-JOB 管理后台为执行器添加任务调度。在左侧菜单中选择 “任务管理 -> 新增任务”:
- 执行器名称:选择你注册的执行器。
- 任务描述:例如 测试任务。
- 调度类型:CRON。
- 调度配置:例如 0/30 * * * * ?(每 30 秒执行一次)。
- 任务处理器:填写 sampleJobHandler(对应 Java 中定义的任务处理器名称)。
4、应用场景
XXL-JOB 作为一款轻量级的分布式任务调度平台,在以下场景下非常适用:
- 定时任务调度:替代传统的单机定时任务调度方案,能够支持多机部署和任务动态管理。
- 分布式任务:多个执行器节点协同工作,支持任务的分片调度和负载均衡。
- 失败重试和监控:内置失败重试机制和任务日志监控,确保任务执行的高可靠性。
- 调度任务的动态扩展:通过 Web 管理界面动态管理任务的增删和调度规则的更新。
4.1 优点
- 轻量易用:配置简单,提供开箱即用的 Web 控制台。
- 分布式调度支持:支持多执行器分布式调度,能够根据实际需求进行水平扩展。
- 任务监控与报警:内置任务执行日志和报警机制,方便任务监控与问题定位。
- 灵活的 CRON 表达式:支持基于 CRON 表达式的灵活调度。
4.2 缺点
- 执行器需集成:需要在 Java 应用中集成 XXL-JOB 执行器,非 Java 语言的支持较弱。
- 依赖 MySQL:调度中心需要依赖 MySQL 作为任务元数据存储。
- 扩展性有限:相比一些功能更全面的调度框架(如 Quartz),XXL-JOB 更适合中小型项目。
5、总结
XXL-JOB 是一个轻量级的分布式任务调度平台,适合中小型应用的定时任务调度。通过 Docker 安装和配置,开发者可以快速上手并使用它进行任务调度。本文展示了如何通过 Docker 安装 XXL-JOB 管理端,并提供了 Java 项目中如何集成 XXL-JOB 执行器的完整示例。XXL-JOB 的易用性和分布式支持使其在任务调度领域拥有广泛的应用场景。