docker 部署 xxl-job & SpringBoot 整合 xxl-job 执行任务

概述

XXL-JOB是一个轻量级的分布式任务调度平台，具有以下特点：

• 调度模块：负责管理调度信息，发出调度请求，支持可视化和动态的操作，监控调度结果和日志，支持执行器Failover

• 执行模块：负责接收调度请求并执行任务逻辑，支持多种方式定义执行器

• 高性能：基于 Quartz 和 Netty 实现高效的调度和通信

• 高可用：支持集群部署，自动注册和发现，故障转移和重试

• 易扩展：支持自定义任务类型，路由策略，报警方式等

• 开源：基于 Apache License 2.0 协议，源码完全开放

官网地址：https://www.xuxueli.com/xxl-job/

github 地址：https://github.com/xuxueli/xxl-job

打不开 github 可以访问 githubfast

https://githubfast.com/xuxueli/xxl-job

docker 部署

环境

docker 环境

使用 docker 安装部署到服务器上

相关 Linux 操作以及 docker 部署可查看：http://t.csdnimg.cn/cbfa6

mysql 环境

部署参考：在 CentOs7 中安装宝塔面板和 Docker（包括MySQL，Redis）

新建数据库 xxl-job，运行 sql

sql 在 github 项目上 /xxl-job/doc/db/tables_xxl_job.sql

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;

这里演示在 Navicat 中新建查询，直接运行 sql 即可导入

导入成功就可以看到 xxl-job 表

运行命令

先 docker 运行 mysql 容器，再根据实际情况修改 mysql 连接参数信息

镜像是 xuxueli/xxl-job-admin:2.4.0，没有镜像会自动拉取，手动拉取则运行 docker pull xuxueli/xxl-job-admin:2.4.0

docker run -di -e PARAMS="--spring.datasource.url=jdbc:mysql://192.168.101.3:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=mysql --xxl.job.accessToken=herbal-tea" \
-p 9111:8080 \
-v /usr/local/src/docker/xxl-job:/data/applogs \
--name xxl-job \
--privileged=true \
xuxueli/xxl-job-admin:2.4.0

参数解释

• -di：在后台运行容器，并分配一个伪终端。
• -e PARAMS="--spring.datasource.url=jdbc:mysql://192.168.1.29:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=pzy123 --xxl.job.accessToken=herbal-tea"：设置环境变量，其中 PARAMS 是一个字符串，包含了多个参数，如数据库连接信息、访问令牌等。数据库等连接信息请根据实际情况修改
• -p 9111:8080：将容器的 8080 端口映射到主机的 9111 端口（主机端口可自行修改）
• -v /usr/local/src/docker/xxl-job:/data/applogs：将主机的 /usr/local/src/docker/xxl-job 目录挂载到容器的 /data/applogs 目录
• --name xxl-job：指定容器的名称为 xxl-job
• --privileged=true：授予容器特权
• xuxueli/xxl-job-admin:2.4.0：指定要运行的镜像名称和版本号

访问

访问地址（账号：admin，密码：123456）：

http://192.168.101.3:9111/xxl-job-admin

如果无法访问，请检查防火墙是否开启，或者云服务的安全组是否开放 9100 端口

相关命令：

查看已开启的端口

firewall-cmd --list-ports

开启指定端口（要重新加载防火墙）

firewall-cmd --zone=public --add-port=9111/tcp --permanent

重新加载防火墙

firewall-cmd --reload

输入账号密码进入

SpringBoot 整合 xxl-job

引入依赖

<dependency>
    <groupId>com.xuxueligroupId>
    <artifactId>xxl-job-coreartifactId>
    <version>2.4.0version>
dependency>

配置文件

xxl:
  job:
    admin:
      addresses: http://192.168.101.3:9100/xxl-job-admin
    accessToken: herbal-tea
    executor:
      appname: xxl-job-test-demo
      # 为空时使用 ip:port 作为注册地址
      address:
      # 为空表示自动获取 IP
      ip:
      # 小于等于0则自动获取；默认端口为 9999
      port: 9999
      ### 执行器运行日志文件存储磁盘路径，为空则使用默认路径
      logpath:
      # 执行器日志文件保存天数
      logretentiondays: 30

配置执行器

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @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.address}")
    private String address;

    @Value("${xxl.job.executor.ip}")
    private String ip;

    @Value("${xxl.job.executor.port}")
    private int port;

    @Value("${xxl.job.executor.logpath}")
    private String logPath;

    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;


    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppname(appname);
        xxlJobSpringExecutor.setAddress(address);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);

        return xxlJobSpringExecutor;
    }
}

在 xxl-job 中配置执行器

输入 AppName，名称 ，注册方式选择 自动注册 ，点击保存

AppName 和 application.yml 中的 executor.appname 要对应

在 xxl-job 中添加任务管理

点击菜单栏任务管理，选择执行器（刚才创建的测试 demo 执行器），点击新增

填写相关信息，Cron 是定时规则

了解 Cron 规则可以看一下这篇文章：SpringBoot 定时任务

每个任务都由一个或多个 JobHandler 组成。当调度中心触发任务时，执行器会根据任务的配置信息调用相应的JobHandler 来执行任务逻辑

编写执行任务

@XxlJob("TestJobHandle") 是XXL-JOB中的一个注解，用于标识一个Java方法为一个可被调度的任务。

该注解包含一个字符串参数，用于指定任务的名称，其中 TestJobHandle 为上述新增任务的 JobHandler

@Service
public class TestXxlJobService {

    @XxlJob("TestJobHandle")
    public void executeXxlJOb() {
        System.out.println("执行了");
    }
}

运行

启动 SpringBoot 项目

选择测试 demo 的执行器，在任务管理中执行任务

在 SpringBoot 控制可以看到任务执行了，也可以在任务管理-操作中查看日志了解执行情况

同时，自动注册也自动配置了机器地址