阿丹:
作为任务调度的使用,xxl_job是经常使用的,可以帮助程序员或者其他业务的定时任务变的可控。但是很多教程都是通过压缩包来进行运行和部署的,但是现在更多的都是将模块容器化。本文章一次性整理。
XXL-Job是一款开源的分布式任务调度框架,它主要用于解决大规模分布式系统中任务调度和执行的需求。该框架的核心设计目标是追求学习简单、快速开发、轻量级以及易于扩展,适用于需要处理定时任务、异步处理或批量数据处理等场景的分布式系统。
XXL-Job的主要组成部分包括:
-
调度中心(xxl-job-admin):这是一个独立运行的系统平台,负责管理调度信息,按照配置触发调度请求。调度中心不直接执行业务逻辑,而是将调度指令发送给执行器,实现了调度系统与任务执行的解耦,提高了系统的稳定性和可扩展性。调度中心还提供任务管理界面,用于任务的增删改查、调度状态监控及日志查看等功能。
-
执行器(xxl-job-executor):部署在业务服务器上,负责接收调度中心的请求并执行具体的任务逻辑。执行器可以是Java应用,也可以通过适配器支持其他语言环境。XXL-Job支持两种任务开发模式,即BEAN模式和GLUE模式。BEAN模式下,开发者在业务系统中编写任务类或方法;GLUE模式则提供了WebIDE,允许在线编写和维护任务脚本,支持Java、Shell、Python等多种语言。
-
任务管理:支持定时任务的配置,如cron表达式定义执行周期,以及任务的参数配置、失败重试策略等。
-
监控与告警:提供实时的任务执行状态监控,以及失败任务的告警通知功能。
-
分布式特性:由于支持多执行器部署,XXL-Job能够轻松应对高并发、大流量的调度需求,保证系统的稳定运行。
XXL-Job因其易用性和灵活性,在众多企业中得到了广泛应用,成为处理分布式任务调度的一个流行选择。
项目地址:
Releases · xuxueli/xxl-job · GitHub
文档地址:
分布式任务调度平台XXL-JOB
(一)tar.gz方式安装
环境准备:
jdk、maven、mysql
安装jdk(如果本地没有java环境的话)
#没有源的需要先配置jdk源
cd /etc/yum.repos.d/
mv CentOS-Base.repo CentOS-Base.repo.backup
wget -O /etc/yum.repos.d/CentOS-Base.repo http://mirrors.aliyun.com/repo/Centos-7.repoyum clean all
yum makecache#有jdk源跳过上面yum -y install jdk*
yum list installed |grep java
yum list installed |grep jdk
yum search java | grep -i --color jdk
yum install -y java-1.8.0-openjdk java-1.8.0-openjdk-devel
java -version
下载准备源码:
Releases · xuxueli/xxl-job · GitHub
我们这里选择tar.gz包
上传到服务器上
进入目标文件夹(根据具体上传路径):
cd /usr/local/work
解压文件(在目标路径下):
tar -zxvf xxl-job-2.3.1.tar.gz
注意:这里的版本号按照具体版本来。
执行xxl_job的数据sql文件,路径在解压文件夹下的/xxl-job-2.4.1/doc/db/下,可以具体观察一下文件的位置。
补充:xxl-job是需要链接mysql数据库的,该sql执行后要将配置文件中的数据源指向执行了sql的服务器ip。
执行sql语句:
我这里使用了navicat来执行sql文件。
新建数据库、执行查询文件
修改xxl-job配置文件
xxl-job-admin配置文件application.properties
文件位置:
解压文件路径+/xxl-job-2.4.1/xxl-job-admin/src/main/resources
数字指向位置说明:
1、访问xxl_job网页端的端口号(默认8080,如果要部署其他项目的时候要注意这个预留端口)
2、xxl_job数据库地址
3、数据库登录用户名:root
4、数据库连接密码
这几个地方要注意修改!
xxl-job-admin配置文件logback.xml
说明:这里为日志输入地址,改为需要的地址就可以了
xxl-job-executor-sample-springboot配置文件application.properties
路径:
解压文件夹+/xxl-job-2.4.1/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources
执行位置说明:
1、该项目的被访问地址
2、第二个指向的位置要保证和admin那个项目的值保持一致。我上面的项目地址改为了7070所以这里也做修改。
这里就修改完毕了。
修改xxl-job-executor-sample-springboot配置文件logback.xml
日志输入的地方:
打包准备运行
在解压目录下执行
mvn package
如果没有maven环境的根据下面的文章安装一下maven就行:
http://t.csdnimg.cn/UiIzH
运行打包代码:
mvn package
开始打包
Success表示打包完成
运行:
1-地址:
解压位置+/xxl-job-2.4.1/xxl-job-admin/target
运行
nohup java -jar /usr/local/work/xxl-job-2.4.1/xxl-job-admin/target/xxl-job-admin-2.4.1.jar > /dev/null 2> /dev/null &
已启动
2-地址:
解压地址+/xxl-job-2.4.1/xxl-job-executor-samples/xxl-job-executor-sample-springboot/target
运行
nohup java -jar /usr/local/work/xxl-job-2.4.1/xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/xxl-job-executor-sample-springboot-2.4.1.jar > /dev/null 2> /dev/null &
已启动
尝试访问:
ip+7070/xxl-job-admin/toLogin
进入登录页面
用户admin 密码123456
登录成功
启动脚本
当然,你可以创建一个名为runxxl_job.sh
的shell脚本文件,将这两个命令包含进去以便更方便地启动XXL-Job的Admin和Executor服务。下面是这个脚本的基本内容:
#!/bin/bash# 启动XXL-Job Admin
echo "Starting XXL-Job Admin..."
nohup java -jar /usr/local/work/xxl-job-2.4.1/xxl-job-admin/target/xxl-job-admin-2.4.1.jar > /dev/null 2> /dev/null &# 确保XXL-Job Admin启动后再启动Executor(这里简单等待5秒,实际可根据需要调整)
echo "Waiting for XXL-Job Admin to start..."
sleep 5s# 启动XXL-Job Executor (Spring Boot 示例)
echo "Starting XXL-Job Executor (Spring Boot Sample)..."
nohup java -jar /usr/local/work/xxl-job-2.4.1/xxl-job-executor-samples/xxl-job-executor-sample-springboot/target/xxl-job-executor-sample-springboot-2.4.1.jar > /dev/null 2> /dev/null &echo "Both XXL-Job Admin and Executor have been started in the background."
使用说明:
1、进入目标文件夹
cd /usr/local/work
2、运行脚本文件
./runxxl_job.sh
关闭xxl_job:
当然,为了方便地关闭之前由runxxl_job.sh
脚本启动的XXL-Job Admin和Executor服务,你可以创建另一个脚本文件,我们称之为stopxxl_job.sh
。这个脚本将使用进程名称来查找并终止相关进程,这样就不需要手动记录或查找进程ID了。以下是示例脚本内容:
#!/bin/bash# 定义进程名称用于查找
admin_process_name="xxl-job-admin"
executor_process_name="xxl-job-executor-sample-springboot"# 关闭XXL-Job Admin
echo "Stopping XXL-Job Admin..."
pkill -f "$admin_process_name"
echo "XXL-Job Admin has been stopped."# 关闭XXL-Job Executor
echo "Stopping XXL-Job Executor..."
pkill -f "$executor_process_name"
echo "XXL-Job Executor has been stopped."
使用说明:
-
创建脚本文件:使用文本编辑器创建一个新的文件,将上述脚本内容粘贴进去,并保存为
stopxxl_job.sh
。 -
赋予执行权限:与之前一样,需要给这个脚本文件赋予执行权限:
1chmod +x stopxxl_job.sh
- 执行脚本:当你需要关闭XXL-Job服务时,只需运行:
1./stopxxl_job.sh
Docker容器化部署
拉去xxl-job镜像
这里我们选取的镜像版本为2.4.0,可根据自己需求改动
docker pull xuxueli/xxl-job-admin:2.4.0
创建xxl-job的sql数据库-和上面的步骤是一样的
在xxl-job的源码中提供了需要的库的sql代码,直接复制执行即可
地址直接给到大家。
doc/db/tables_xxl_job.sql · 许雪里/xxl-job - Gitee.com
也可以直接复制粘贴
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;
启动镜像
docker run -di -e PARAMS="--spring.datasource.url=jdbc:mysql://124.41.100.206:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=bing0707 --xxl.job.accessToken=pingzhuyan.test" \
-p 7070:8080 \
-v /usr/local/src/docker/xxl-job:/data/applogs \
--name xxl-job \
--privileged=true \
xuxueli/xxl-job-admin:2.4.0
--privileged=true 给予容器Root权限
-v 目录挂载 :左边为宿主机目录,右边为容器内目录
以下几个配置非常重要,请根据自己情况修改
–xxl.job.accessToken=pingzhuyan.test 这行配置指定accessToken,当你在程序中引入xxl-job时,需要用到accessToken
--spring.datasource.username=root xxl-job数据源的登录用户名
--spring.datasource.password=bing0707 xxl-job数据源的登录密码
--spring.datasource.url Sql数据库的url
访问web管理界面
http://ip:7070/xxl-job-admin
账号:admin
密码:123456
两种部署的方式完全结束。快去自己尝试一下吧!!!!