tianyi1994/xxl-job

xxl-job Docker镜像文档

概述

xxl-job是一个分布式任务调度平台，其Docker镜像提供了便捷的部署方式，用于实现分布式环境下的任务调度和管理。该镜像基于官方xxl-job项目构建，包含了调度中心和执行器组件，可快速部署和集成到各类应用系统中。

核心功能和特性

• 分布式任务调度：支持分布式环境下的任务统一调度和管理
• 任务监控：提供任务执行状态监控、失败重试、日志查看等功能
• 灵活的任务配置：支持CRON表达式、任务参数、执行策略等多种配置
• 高可用设计：支持集群部署，保证调度中心的高可用性
• 丰富的任务类型：支持Bean模式、GLUE模式(Java/Shell/Python/PHP/NodeJS)等多种任务类型
• 失败处理：提供失败重试、失败告警等机制
• 任务依赖：支持任务间的依赖关系配置

使用场景和适用范围

• 微服务架构下的定时任务调度
• 分布式系统中的任务协调和执行
• 需要高可靠性和可扩展性的任务调度场景
• 大规模任务分发和执行
• 定时数据处理和报表生成
• 系统监控和告警任务

使用方法和配置说明

环境准备

• Docker环境
• 数据库（MySQL）

镜像拉取

bash
docker pull xuxueli/xxl-job-admin:2.4.0

数据库初始化

xxl-job需要MySQL数据库支持，首先需要创建数据库并执行初始化脚本：

sql
CREATE DATABASE xxl_job CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
USE xxl_job;

-- 执行官方提供的初始化SQL脚本
-- 脚本地址: https://github.com/xuxueli/xxl-job/blob/master/doc/db/tables_xxl_job.sql

基本使用（Docker Run）

bash
docker run -d \
  --name xxl-job-admin \
  -p 8080:8080 \
  -e PARAMS="--spring.datasource.url=jdbc:mysql://数据库IP:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai \
  --spring.datasource.username=数据库用户名 \
  --spring.datasource.password=数据库密码" \
  xuxueli/xxl-job-admin:2.4.0

Docker Compose配置

yaml
version: '3'
services:
  xxl-job-admin:
    image: xuxueli/xxl-job-admin:2.4.0
    container_name: xxl-job-admin
    ports:
      - "8080:8080"
    environment:
      - PARAMS=--spring.datasource.url=jdbc:mysql://mysql:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
        --spring.datasource.username=root
        --spring.datasource.password=root
    depends_on:
      - mysql
    restart: always

  mysql:
    image: mysql:5.7
    container_name: xxl-job-mysql
    ports:
      - "3306:3306"
    environment:
      - MYSQL_ROOT_PASSWORD=root
      - MYSQL_DATABASE=xxl_job
    volumes:
      - ./sql:/docker-entrypoint-initdb.d
    restart: always

环境变量配置参数

访问管理界面

启动容器后，通过以下地址访问xxl-job管理界面：

http://localhost:8080/xxl-job-admin

默认登录账号：admin/***

执行器配置

在应用中集成xxl-job执行器，需要添加依赖并配置执行器：

xml
<!-- Maven依赖 -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.0</version>
</dependency>

执行器配置：

properties
# 调度中心地址
xxl.job.admin.addresses=http://xxl-job-admin:8080/xxl-job-admin

# 执行器名称
xxl.job.executor.appname=xxl-job-executor-sample

# 执行器IP [选填]：默认为空表示自动获取IP
xxl.job.executor.ip=

# 执行器端口号 [选填]：默认为9999，单机部署多个执行器时注意要配置不同执行器端口
xxl.job.executor.port=9999

# 执行器通讯TOKEN [选填]：非空时启用
xxl.job.accessToken=

# 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler

# 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
xxl.job.executor.logretentiondays=30

版本信息

当前稳定版本：2.4.0

更多详细信息请参考官方文档：[***]