XXL-JOB分布式任务调度系统完全指南
目录
一、什么是XXL-JOB？
XXL-JOB是一个轻量级分布式任务调度平台，由国内开发者许雪里开源。其核心设计目标是开发简单、功能强大、易于扩展。现已发展成为Java领域最受欢迎的任务调度解决方案之一。
核心特性
✔️ 简单易用：提供Web控制台，操作简便
✔️ 动态调度：支持动态修改任务配置
✔️ 故障转移：执行器集群部署时自动故障转移
✔️ 分片处理：支持海量数据分片任务处理
✔️ 弹性扩展：调度中心和执行器均可水平扩展
二、为什么需要分布式任务调度？
在分布式系统中，传统的定时任务方案面临诸多挑战：
| 传统方案痛点 | XXL-JOB解决方案 |
|---|---|
| 单点故障风险 | 调度中心集群部署 |
| 任务重复执行 | 分布式锁控制 |
| 监控困难 | 可视化控制台 |
| 扩展性差 | 动态扩缩容 |
| 日志分散 | 统一日志管理 |
典型应用场景：
- 订单超时自动取消
- 定时数据报表生成
- 跨系统数据同步
- 大规模数据批处理
- 系统健康检查
三、快速开始
1. 环境准备
- JDK 1.8+
- MySQL 5.7+
- Maven 3.0+
2. 源码获取
git clone http://gitee.com/xuxueli0323/xxl-job
3. 项目结构
xxl-job/
├── doc/ # 数据库脚本和文档
├── xxl-job-admin # 调度中心（核心）
├── xxl-job-core # 公共依赖
└── xxl-job-executor-samples # 执行器示例
├── xxl-job-executor-sample-springboot：springboot版本（推荐）
└── xxl-job-executor-sample-frameless：无框架版本
四、详细配置指南
1. 数据库初始化
执行SQL脚本：
/xxl-job/doc/db/tables_xxl_job.sql
初始化之后的表
2. 调度中心配置
关键配置项（application.properties）：
# 主要修改数据库为自己的刚才执行sql的库
# 数据源配置
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
# 访问令牌（生产环境必配）
xxl.job.accessToken=your_token_here
# web port，访问界面端口
server.port=8081
启动项目XxlJobAdminApplication后访问：http://localhost:8081/xxl-job-admin
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
五、项目集成
1. 添加依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.4.1</version> <!-- 跟随调度中心的版本 ，我本地是2.4.1-->
</dependency>
2. 将源代码的示例配置拿过来进行修改
/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties
# web port
server.port=8081
# 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的访问地址
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### xxl-job, access token token一致才能注册上去
xxl.job.accessToken=default_token
### xxl-job executor appname
#执行器分组名称，关系到会注册到哪个组里
xxl.job.executor.appname=appLqp
### 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=
### 执行器端口（与server.port不同，这是RPC端口）
xxl.job.executor.port=10003
### 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
3、将实例的config配置拿到项目
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* xxl-job config
*
* @author xuxueli 2017-04-28
*/
@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;
}
/**
* 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
*
* 1、引入依赖：
* <dependency>
* <groupId>org.springframework.cloud</groupId>
* <artifactId>spring-cloud-commons</artifactId>
* <version>${version}</version>
* </dependency>
*
* 2、配置文件，或者容器启动变量
* spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
*
* 3、获取IP
* String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
*/
}
4.新增执行器
第一次进入，需要自己新建执行器，成功注册后，在调度中心可以看到
六、任务开发实战
1. 编写定时任务
package com.xxl.xxljobdemo.jobhandler;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
/**
* XxlJob开发示例（Bean模式）
*
* 开发步骤：
* 1、任务开发：在Spring Bean实例中，开发Job方法；
* 2、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
* 3、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志；
* 4、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；
*
*/
@Component
public class SampleXxlJob {
private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
// 可使用@Resource/@Autowire注入执行器里中的其他服务
@Autowired
private UserService userService;
/**
* 1、简单任务示例（Bean模式）
*/
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
System.out.println("XXL-JOB, Hello World.");
XxlJobHelper.log("XXL-JOB, Hello World.");
for (int i = 0; i < 5; i++) {
XxlJobHelper.log("beat at:" + i);
TimeUnit.SECONDS.sleep(2);
}
// default success
}
/**
* 2、分片广播任务
*/
@XxlJob("shardingJobHandler")
public void shardingJobHandler() throws Exception {
// 分片参数
int shardIndex = XxlJobHelper.getShardIndex();
int shardTotal = XxlJobHelper.getShardTotal();
XxlJobHelper.log("分片参数：当前分片序号 = {}, 总分片数 = {}", shardIndex, shardTotal);
// 业务逻辑
for (int i = 0; i < shardTotal; i++) {
if (i == shardIndex) {
XxlJobHelper.log("第 {} 片, 命中分片开始处理", i);
} else {
XxlJobHelper.log("第 {} 片, 忽略", i);
}
}
}
/**
* 3、命令行任务
*/
@XxlJob("commandJobHandler")
public void commandJobHandler() throws Exception {
String command = XxlJobHelper.getJobParam();
int exitValue = -1;
BufferedReader bufferedReader = null;
try {
// command process
ProcessBuilder processBuilder = new ProcessBuilder();
processBuilder.command(command);
processBuilder.redirectErrorStream(true);
Process process = processBuilder.start();
//Process process = Runtime.getRuntime().exec(command);
BufferedInputStream bufferedInputStream = new BufferedInputStream(process.getInputStream());
bufferedReader = new BufferedReader(new InputStreamReader(bufferedInputStream));
// command log
String line;
while ((line = bufferedReader.readLine()) != null) {
XxlJobHelper.log(line);
}
// command exit
process.waitFor();
exitValue = process.exitValue();
} catch (Exception e) {
XxlJobHelper.log(e);
} finally {
if (bufferedReader != null) {
bufferedReader.close();
}
}
if (exitValue == 0) {
// default success
} else {
XxlJobHelper.handleFail("command exit value("+exitValue+") is failed");
}
}
/**
* 4、跨平台Http任务
* 参数示例：
* "url: http://www.baidu.com\n" +
* "method: get\n" +
* "data: content\n";
*/
@XxlJob("httpJobHandler")
public void httpJobHandler() throws Exception {
// param parse
String param = XxlJobHelper.getJobParam();
if (param==null || param.trim().length()==0) {
XxlJobHelper.log("param["+ param +"] invalid.");
XxlJobHelper.handleFail();
return;
}
String[] httpParams = param.split("\n");
String url = null;
String method = null;
String data = null;
for (String httpParam: httpParams) {
if (httpParam.startsWith("url:")) {
url = httpParam.substring(httpParam.indexOf("url:") + 4).trim();
}
if (httpParam.startsWith("method:")) {
method = httpParam.substring(httpParam.indexOf("method:") + 7).trim().toUpperCase();
}
if (httpParam.startsWith("data:")) {
data = httpParam.substring(httpParam.indexOf("data:") + 5).trim();
}
}
// param valid
if (url==null || url.trim().length()==0) {
XxlJobHelper.log("url["+ url +"] invalid.");
XxlJobHelper.handleFail();
return;
}
if (method==null || !Arrays.asList("GET", "POST").contains(method)) {
XxlJobHelper.log("method["+ method +"] invalid.");
XxlJobHelper.handleFail();
return;
}
boolean isPostMethod = method.equals("POST");
// request
HttpURLConnection connection = null;
BufferedReader bufferedReader = null;
try {
// connection
URL realUrl = new URL(url);
connection = (HttpURLConnection) realUrl.openConnection();
// connection setting
connection.setRequestMethod(method);
connection.setDoOutput(isPostMethod);
connection.setDoInput(true);
connection.setUseCaches(false);
connection.setReadTimeout(5 * 1000);
connection.setConnectTimeout(3 * 1000);
connection.setRequestProperty("connection", "Keep-Alive");
connection.setRequestProperty("Content-Type", "application/json;charset=UTF-8");
connection.setRequestProperty("Accept-Charset", "application/json;charset=UTF-8");
// do connection
connection.connect();
// data
if (isPostMethod && data!=null && data.trim().length()>0) {
DataOutputStream dataOutputStream = new DataOutputStream(connection.getOutputStream());
dataOutputStream.write(data.getBytes("UTF-8"));
dataOutputStream.flush();
dataOutputStream.close();
}
// valid StatusCode
int statusCode = connection.getResponseCode();
if (statusCode != 200) {
throw new RuntimeException("Http Request StatusCode(" + statusCode + ") Invalid.");
}
// result
bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream(), "UTF-8"));
StringBuilder result = new StringBuilder();
String line;
while ((line = bufferedReader.readLine()) != null) {
result.append(line);
}
String responseMsg = result.toString();
XxlJobHelper.log(responseMsg);
return;
} catch (Exception e) {
XxlJobHelper.log(e);
XxlJobHelper.handleFail();
return;
} finally {
try {
if (bufferedReader != null) {
bufferedReader.close();
}
if (connection != null) {
connection.disconnect();
}
} catch (Exception e2) {
XxlJobHelper.log(e2);
}
}
}
/**
* 5、生命周期任务示例：任务初始化与销毁时，支持自定义相关逻辑；
*/
@XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")
public void demoJobHandler2() throws Exception {
XxlJobHelper.log("XXL-JOB, Hello World.");
}
public void init(){
logger.info("init");
}
public void destroy(){
logger.info("destroy");
}
/**
* 单个参数传递
*
* @throws Exception
*/
@XxlJob("oneParameter")
public void sendMessage() throws Exception {
String jobParam = XxlJobHelper.getJobParam();
User user = userService.getById(jobParam);
XxlJobHelper.log("单个任务参数为：" + XxlJobHelper.getJobParam());
}
/**
* 多个参数，应用 , 分割
*
* @throws Exception
*/
@XxlJob("moreParameters")
public void sendMessage2() throws Exception {
try {
// 获取参数
String param = XxlJobHelper.getJobParam();
List<String> methodParams = StrUtil.split(param, ",");
List<User> users = userService.listByIds(methodParams);
XxlJobHelper.log("参数1为：" + methodParams.get(0) + "，参数2为" + methodParams.get(1));
} catch (Exception e) {
XxlJobHelper.handleFail("参数传递异常");
}
}
}
2.在任务管理新增执行任务
3.任务执行
七、调度策略详解
1. 调度类型
-
CRON：通过CRON表达式触发（推荐）
示例：0 0/5 * * * ? # 每5分钟执行一次 -
固定速度：固定间隔时间触发
示例：30秒间隔 -
无：不自动触发，需手动执行
2. 路由策略列表
| 策略名称 | 说明 | 解释 | 适用场景 |
|---|---|---|---|
| FIRST | 选择第一个执行器 | 固定选择第一个机器 | 固定节点执行 |
| LAST | 选择最后一个执行器 | 固定选择最后一个机器 | 固定节点执行 |
| ROUND | 轮询选择 | 轮流选择在线的机器 | 负载均衡 |
| RANDOM | 随机选择 | 随机选择在线的机器 | 负载均衡 |
| CONSISTENT_HASH | 一致性哈希 | 每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上 | 任务与执行器绑定 |
| LEAST_FREQUENTLY_USED | 最不经常使用 | 使用频率最低的机器优先被选举 | 负载均衡 |
| LEAST_RECENTLY_USED | 最近最久未使用 | 最久未使用的机器优先被选举 | 负载均衡 |
| FAILOVER | 故障转移 | 按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度 | 高可用场景 |
| BUSYOVER | 忙碌转移 | 按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度 | 负载均衡 |
| SHARDING_BROADCAST | 分片广播 | 广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务； | 并行任务处理 |
3. 阻塞处理策略
- 单机串行（默认）
- 调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行
- 丢弃后续调度
- 调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败
- 覆盖之前调度
- 调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务
4.过期策略
-
忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
-
立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
5.子任务
每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
八、常见问题解答
Q：如何解决任务重复执行？
A：确保路由策略配置正确，避免多个执行器同时处理同一任务
Q：调度中心集群如何部署？
A：多个实例共享同一数据库，通过Nginx做负载均衡
Q：任务执行时间过长怎么办？
A：1) 优化任务逻辑 2) 设置合理的超时时间 3) 考虑拆分子任务
九、总结
XXL-JOB作为一款企业级任务调度解决方案，具有以下优势：
- 开箱即用：简单配置即可快速集成
- 功能全面：满足各种调度场景需求
- 社区活跃：持续更新维护，文档齐全
- 性能优异：单机可支持数千任务调度
对于需要替代传统Spring @Scheduled方案，或需要构建分布式任务调用的系统，XXL-JOB无疑是最佳选择之一。
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
