17623711574/xxl-job

XXL-Job 分布式任务调度平台

概述

XXL-Job是一个轻量级分布式任务调度平台，由许雪里（XXL）开发，是一个开源的分布式任务调度框架。它提供了任务调度、任务管理、执行日志、监控报警等功能，支持多种任务类型和执行策略，适用于各种定时任务调度场景。

核心功能和特性

核心功能

• 分布式任务调度：支持分布式环境下的任务调度
• 任务管理：提供Web界面进行任务的创建、编辑、删除、启动、停止等操作
• 执行日志：记录任务执行过程和结果，支持日志查询
• 监控报警：支持任务执行失败报警，可配置邮件、短信等报警方式

特性

• 轻量级：核心包体积小，部署简单
• 高可用：支持集群部署，确保任务调度的可靠性
• 易扩展：支持自定义任务参数、执行器和任务处理器
• 多语言支持：支持Java、Python、PHP等多种语言
• 丰富的任务类型：支持Bean模式、GLUE模式、远程HTTP调用等多种任务类型

使用场景和适用范围

适用场景

• 定时任务调度：如定时数据同步、定时报表生成等
• 批量任务处理：如批量数据导入导出、批量消息发送等
• 分布式任务协调：如分布式锁、分布式事务等
• 系统监控和报警：如定时检查系统状态、定时发送监控报告等

适用范围

• 中小规模企业的任务调度需求
• 微服务架构下的任务调度
• 需要高可用、易扩展的任务调度场景
• 需要多语言支持的任务调度场景

使用方法和配置说明

环境要求

• JDK 1.8+
• MySQL 5.7+
• Docker 19.03+

Docker部署示例

docker run命令

bash
docker run -d \
  --name xxl-job-admin \
  -p 8080:8080 \
  -e PARAMS="--spring.datasource.url=jdbc:mysql://mysql-host:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai \
  --spring.datasource.username=root \
  --spring.datasource.password=root" \
  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-host:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
      - spring.datasource.username=root
      - spring.datasource.password=root
    restart: always

配置参数说明

环境变量

• PARAMS: 用于传递Spring Boot配置参数，如数据库连接信息等
• spring.datasource.url: 数据库连接URL
• spring.datasource.username: 数据库用户名
• spring.datasource.password: 数据库密码

常用配置参数

• xxl.job.login.username: 登录用户名，默认为admin
• xxl.job.login.password: 登录密码，默认为***
• xxl.job.accessToken: 调度中心通信令牌，非空时启用
• server.port: 服务端口，默认为8080

访问方法

启动容器后，通过浏览器访问 http://localhost:8080/xxl-job-admin，使用默认用户名admin和密码***登录。

任务执行器配置

执行器注册

执行器需要向调度中心注册，可通过以下方式配置：

• 自动注册：通过配置调度中心地址，执行器启动时自动注册
• 手动注册：在调度中心手动添加执行器信息

执行器配置示例（Spring Boot项目）

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

# 执行器通讯TOKEN
xxl.job.accessToken=

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

# 执行器注册地址
xxl.job.executor.address=

# 执行器IP
xxl.job.executor.ip=

# 执行器端口号
xxl.job.executor.port=9999

# 执行器运行日志文件存储路径
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler

# 执行器日志文件保存天数
xxl.job.executor.logretentiondays=30

任务开发

任务注解

使用@XxlJob注解定义任务方法：

java
@Component
public class SampleXxlJob {
    /**
     * 简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-Job, Hello World.");
        
        // 业务逻辑
        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        // 默认任务成功
    }
}

任务类型

XXL-Job支持多种任务类型：

• Bean模式：基于类的方法，需要在执行器中开发并注册
• GLUE模式：支持在线编辑代码，无需重启执行器
• 远程HTTP调用：通过HTTP接口调用远程服务
• 命令行模式：执行Shell命令或脚本

注意事项

1. 数据库初始化：首次使用需要执行SQL脚本创建表结构，脚本位于项目的doc/db/tables_xxl_job.sql文件中
2. 集群部署：调度中心支持集群部署，通过数据库实现分布式锁，确保任务不重复执行
3. 任务超时：可配置任务超时时间，超时后自动终止任务
4. 失败重试：支持任务失败重试机制，可配置重试次数和重试间隔