以下是XXL-JOB的快速入门指南,整合了多个来源的核心步骤与注意事项:
一、环境准备
- 基础环境
安装以下软件: - JDK 1.8+
- Maven 3+
- MySQL 5.7+
- 源码下载
从GitHub或Gitee下载源码(推荐稳定版本如2.3.0): - git clone https://gitee.com/xuxueli0323/xxl-job.git git checkout -b 2.3.0 origin/2.3.0 # 切换分支
二、调度中心部署
- 初始化数据库
执行源码中 /xxl-job/doc/db/tables_xxl_job.sql 脚本,创建名为 xxl_job 的数据库。 - 配置调度中心
修改 xxl-job-admin 模块的 application.properties: - 数据库连接:指向初始化后的MySQL实例。
- 登录账号:显式配置 xxl.job.login.username=admin 和 xxl.job.login.password=123456。
- 邮件报警:配置SMTP服务(如QQ邮箱)。
- 日志保留天数:默认30天。
- 启动调度中心
编译打包后运行,访问 http://localhost:8080/xxl-job-admin 使用默认账号登录。
三、执行器配置
- 添加依赖
在Spring Boot项目中引入依赖(版本需与调度中心一致):
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.0</version>
</dependency>
2.配置文件设置
修改执行器的 application.properties:
3.调度中心地址:xxl.job.admin.addresses=
http://localhost:8080/xxl-job-admin
4.执行器名称:xxl.job.executor.appname=自定义名称
5.端口与日志路径:默认端口9999,日志路径需有读写权限。
6.初始化执行器组件
创建配置类 XxlJobConfig.java,注入 XxlJobSpringExecutor 并设置参数(如Admin地址、AppName等)。
四、任务开发与测试
- 编写任务处理器
使用 @XxlJob 注解定义任务方法,示例:
@Component public class MyJobHandler
{
@XxlJob("myJobHandler")
public void execute() {
String param = XxlJobHelper.getJobParam();
XxlJobHelper.log("任务参数:" + param);
}
}
- 注册任务到调度中心
- 执行器管理:在调度中心界面添加执行器,名称需与配置文件一致。
- 任务配置:设置Cron表达式、路由策略、任务参数等。
- 运行与监控
启动执行器后,任务会自动注册。在调度中心手动触发任务,通过日志查看执行结果。
五、常见问题
- 执行器未注册:检查 xxl.job.admin.addresses 地址是否正确,网络是否通畅。
- 日志路径错误:修改 logback.xml 中的日志路径或通过配置文件动态指定。
- 数据库连接失败:确保MySQL版本兼容,且调度中心集群强制连接主库。
扩展功能
- 分片任务:通过 XxlJobHelper.getShardIndex() 实现分布式任务分片。
- 动态参数:任务运行时通过 XxlJobHelper.getJobParam() 获取参数8。
- 失败告警:配置邮件通知,任务失败时自动触发。
通过以上步骤,可快速完成XXL-JOB的部署与任务调度测试。如需进阶功能(如HA集群、动态扩容),可参考官方文档或社区教程。
