xxl-job分布式调度平台

xxl-job 是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

xxl-job将原来的定时任务拆分成了2个部分(调度中心、执行器)。

调度中心是任务调度的中枢。它集中配置、管理所有定时任务（Job），包括CRUD、启停、触发策略等。根据预设策略（如CRON表达式、固定速率）触发任务，通过路由算法（分片、广播、故障转移等）分配任务到执行器集群。智能分配任务到健康节点，避免单点过载。 执行器启动后向调度中心注册，维持心跳，确保调度中心实时感知节点状态。作为执行器与任务管理端的中间层，通过HTTP/RPC转发调度请求和结果。 另外，记录任务触发、执行状态、耗时等，提供可视化追踪。支持失败重试、告警通知（邮件、钉钉等），具备熔断机制防止雪崩。聚合任务执行数据，生成报表辅助容量规划。 调度中心支持集团部署，通过DB分布式锁或选主机制避免重复调度。主节点宕机后，备用节点自动接管任务调度。

执行器是任务的最终执行者。

以下是 SpringBoot 项目中集成 XXL-JOB 的具体步骤，包含 调度中心部署 和 执行器项目开发 的详细流程：

环境:java:openJDK17、springboot3、xxl-job3.0.0-SNAPSHOT

 一、调度中心部署

 1. 下载并初始化

下载源码          从 GitHub 下载 XXL-JOB 源码：[XXL-JOB GitHub]( github /xuxueli/xxl-job)

git clone github /xuxueli/xxl-job.git

初始化数据库          执行 xxl-job/doc/db/tables_xxl_job.sql初始化数据库表。      修改配置          修改 xxl-job-admin/src/main/resources/application.properties：     

    # 数据库配置     spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8     spring.datasource.username=root     spring.datasource.password=root

启动调度中心          运行 XxlJobAdminApplication 主类，访问 http://localhost:8080/xxl-job-admin，默认账号密码：admin/123456。     

二、执行器项目集成

1. 添加依赖

在 pom.xml中添加 XXL-JOB 依赖：

<dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.4.2</version> </dependency>

2. 配置执行器

在 application.yml 中添加配置：

xxl:   job:     admin:       addresses: http://localhost:8080/xxl-job-admin  # 调度中心地址     executor:       appname: xxl-job-executor-sample  # 执行器名称       port: 9999  # 执行器端口（默认 9999，需未被占用）

3. 编写任务处理器

创建任务处理类 SampleXxlJob：

@Component public class SampleXxlJob {     // 任务示例：简单打印日志     @XxlJob("demoJobHandler")     public void demoJobHandler() throws Exception {         XxlJobHelper.log("XXL-JOB 测试任务开始执行");         System.out.println("Hello XXL-JOB!");         XxlJobHelper.log("XXL-JOB 测试任务执行完成");     } }

4. 启动执行器

确保 SpringBoot 主类启用任务扫描：

@SpringBootApplication public class XxlJobExecutorApplication {     public static void main(String[] args) {         SpringApplication.run(XxlJobExecutorApplication.class, args);     } }

 三、调度中心配置任务

1. 添加执行器

-   登录调度中心，进入 「执行器管理」。 -   添加执行器：     -   AppName: xxl-job-executor-sample（与配置一致）     -   名称: 自定义（如 `测试执行器`）     -   注册方式: 自动注册

2. 创建任务

-   进入 「任务管理」→ 「新增任务」：     -   任务描述: 测试任务     -   路由策略: 轮询     -   Cron: `0/30 * * * * ?`（每 30 秒执行一次）     -   JobHandler: demoJobHandler（与注解名一致）     -   执行参数: 可选

3. 触发任务

-   点击 「操作」 → 「执行一次」，查看日志验证执行结果。

四、验证与调试

1. 查看执行日志

-   在调度中心 「调度日志」 中检查任务执行状态和日志输出。

2. 常见问题

-   执行器未注册：检查执行器配置的 appname 和端口是否与调度中心一致。 -   任务未触发：确认 Cron 表达式正确，调度中心与执行器网络互通。

五、完整流程图 调度中心部署 → 执行器配置 → 任务编码 → 调度中心注册 → 任务触发 → 日志验证

通过以上步骤，可快速完成 XXL-JOB 的集成与测试任务开发。

=以下为执行器项目代码======================================================

1.结构

 2.pom.xml

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http:// .w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>3.4.2</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>infosky</groupId> <artifactId>xxljob-exectour-demo</artifactId> <version>1.0</version> <name>xxljob-exectour-demo</name> <description>Demo project for Spring Boot</description> <properties> <java.version>17</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.4.2</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>

 3.application.properties

spring.application.name=xxljob-exectour-demo server.port=8081 #调度中心部署跟地址 如调度中心集群部署存在多个地址则用逗号分隔。 xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin #执行器通讯TOKEN 选填、非空时启用 xxl.job.accessToken=default_token #执行器AppName 选填、执行器心跳注册分组依据；为空则关闭自动注册 xxl.job.executor.appname=xxljob-executour-demo #执行器注册 选填、优先使用该配置作为注册地址，为空时使用内嵌服务"IP:PORT"作为注册地址 xxl.job.executor.address= #执行器IP 选填、默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯使用；地址信息用于"执行器注册"和"调度中心请求" xxl.job.executor.ip=127.0.0.1 #执行器端口号 选填、小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口 xxl.job.executor.port=9999 #执行器运行日志文件存储磁盘路径 选填、需要对该路径拥有读写权限；为空则使用默认路径 xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler #执行器日志文件保存天数 选填、过期日志自动清理，限制值>=3时生效；否则(如-1),则关闭自动清理功能 xxl.job.executor.logretentiondays=10

4.springboot启动类  XxljobExectourDemoApp

package infosky.xxljobExectourDemo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class XxljobExectourDemoApp { public static void main(String[] args) { SpringApplication.run(XxljobExectourDemoApp.class, args); } }

5.xxljob配置类  XxlJobConfig

package infosky.xxljobExectourDemo.config; import com.xxl.job.core.executor.impl.XxlJobSpringExecutor; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * xxljob配置 */ @Configuration public class XxlJobConfig { @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 xxlJobSpringExecutor(){ 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; } }

 6.任务执行类  DemoJob

 

package infosky.xxljobExectourDemo.xxljob; import com.xxl.job.core.handler.annotation.XxlJob; import org.springframework.stereotype.Component; import java.util.Date; /** * 任务处理类 */ @Component public class DemoJob { @XxlJob("demoJobHandler") public void demoJobHandler(){ System.out.println("==============任务执行时间：" + new Date()); } }

 

附件

官网:分布式任务调度平台XXL-JOBXXL-JOB是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。 .xuxueli /xxl-job/#google_vignette

开源社区:XXL开源社区 | 社区 .xuxueli /page/community.html