概要
XXL-Job 是一个分布式任务调度平台,用于管理和调度定时任务和分布式任务。它是一个开源的项目,主要用于解决分布式系统中的任务调度问题。以下是一些关于 XXL-Job 的主要特点和功能:
-
分布式任务调度:XXL-Job 支持分布式任务调度,可以在多台服务器上同时执行定时任务和分布式任务,确保任务的高可用性和负载均衡。
-
定时任务管理:用户可以通过 XXL-Job 的管理界面轻松创建、编辑和删除定时任务,设置任务的执行时间和频率。
-
分布式任务管理:XXL-Job 提供了分布式任务的管理功能,用户可以将任务分发到多台服务器上执行,支持动态添加和删除任务执行器。
-
任务调度监控:XXL-Job 提供了任务执行情况的监控和日志查看功能,用户可以实时监控任务的执行状态和结果。
-
任务执行器管理:用户可以管理任务执行器的注册和下线,确保任务能够在可用的执行器上执行。
-
报警机制:XXL-Job 支持任务执行失败时的报警机制,可以通过邮件、短信等方式通知用户。
-
多语言支持:XXL-Job 提供了多种编程语言的客户端库,支持 Java、Python、Node.js、Go 等语言,方便开发者集成任务调度功能到自己的应用中。
总的来说,XXL-Job 是一个功能丰富的分布式任务调度平台,适用于各种需要定时任务和分布式任务调度的应用场景,帮助用户管理和监控任务的执行,提高系统的稳定性和可维护性。
本文主要介绍在centos中利用docker运行xxl-job容器
整体安装流程
1:第一步在idea中打开xxl-job项目(gitee地址)
2:执行sql脚本文件
#
# XXL-JOB v2.4.1-SNAPSHOT
# 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;
将其添加在你的数据库中
3:修改application.properties配置文件
# web port:应用程序的Web端口号。这是您的应用程序在部署时使用的端口号,用于提供Web服务。
server.port=9011
# no web
#spring.main.web-environment=false
# log config
logging.config=classpath:logback.xml
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://192.168.61.135:9010/xxl-job-admin
### xxl-job, access token
xxl.job.accessToken=default_token
### xxl-job executor appname
xxl.job.executor.appname=xxl-job-executor-sample
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
xxl.job.executor.ip=
#xxl-job执行器的端口号。xxl-job是一个分布式任务调度平台,该端口号用于与xxl-job admin进行通信,以接收和执行任务。
xxl.job.executor.port=9998
### xxl-job executor log-path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30
端口号说明:
9011:是excutor中的应用程序的Web端口号。
9010:是对应的客户端端口号
9998:是执行器的端口号。xxl-job是一个分布式任务调度平台,该端口号用于与xxl-job admin进行通信,以接收和执行任务。
4:开始打包xxl-job-excutor.jar
打包完成后,开始编写Dockerfile文件
FROM openjdk:8-jre-slim
MAINTAINER javacc
VOLUME /tmp
ADD xxl-job-executor-sample-springboot-2.4.0.jar xxl-job-executor.jar
RUN bash -c 'touch /xxl-job-executor.jar'
ENTRYPOINT ["java", "-Dfile.encoding=utf-8", "-jar", "/xxl-job-executor.jar"]
其中
xxl-job-executor-sample-springboot-2.4.0.jar是我打包后的在tatget中的打包后的名字。
在宿主机(虚拟机、服务器)创建文件夹
mkdir -p /home/docker/diy-APP/
然后上传上面的Dockerfile和打包好的jar
然后开始制作docker镜像
切换到创建的这个目录下
cd /home/docker/diy-APP/
利用docker构建镜像(项目jar与dockerfile文件所在目录执行)。***.必须加上; 表示使用当前路径作为构建的上下文,Docker 在构建镜像时会查找当前路径下的 Dockerfile 文件,并根据 Dockerfile 文件的指令来构建镜像。
docker build -t xxl-job-executor:1.0 .
到现在为止前置要求都准备好了;下面开始操作docker
1:首先拉取xxl-job镜像
docker pull xuxueli/xxl-job-admin:2.3.0
2:创建挂载目录
mkdir -p /home/docker /xxl-job/admin/logs
3:运行xxl-admin
docker create --name xxl-job-admin -p 9010:8080 \
-e PARAMS="\
--spring.datasource.url=jdbc:mysql://192.168.61.135:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 \
--spring.datasource.username=root \
--spring.datasource.password=root" \
-v /home/docker/xxl-job/admin/logs:/data/applogs \
--privileged=true \
--restart always \
xuxueli/xxl-job-admin:2.3.0
部分参数说明::将xxl-job容器内部的8080端口号映射到宿主机(虚拟机、服务器)的9010端口号。这样做是为了安装完成后可以通过 主机ip:9010/xxl-job-admin 进行访问xxl-job的管理界面
运行xxl-job-excutor执行器镜像(也就是上面我们制作的镜像)
docker run -d --name xxl-job-executor-01 -p 9998:9998 -p 9011:9011 -e --xxl.job.admin.addresses=http://192.168.61.135:9010/xxl-job-admin -e --xxl.job.executor.address=http://192.168.61.135:9011 xxl-job-executor:1.0
这个命令用于在Docker中启动一个容器,并运行镜像 app-xxl-job-executor:1.0 。下面是命令中各个参数的含义:
- docker run :启动一个新的容器。
- -d :在后台运行容器。
- --name xxl-job-executor-01 :为容器指定一个名称,这里是 xxl-job-executor-01 。
- -p 9998:9998 :将容器内部的 9998 端口映射到宿主机的 9998 端口。
- -p 9011:9011 :将容器内部的 9011 端口映射到宿主机的 9011 端口。
- -e --xxl.job.admin.addresses=http://192.168.61.135:9010/xxl-job-admin> :设置环境变量 xxl.job.admin.addresses ,指定xxl-job-admin的地址。
- -e --xxl.job.executor.address=http://192.168.61.135:9011> :设置环境变量 xxl.job.executor.address ,指定xxl-job-executor的地址。
- app-xxl-job-executor:1.0 :指定要运行的镜像名称和版本号。
查看容器是否运行成功
docker ps -a
docker logs 容器id
当出现spring图标时就说明运行成功了!!!
小结
后续补充文中的端口说明