当前位置： 首页 > news >正文

2025/8/22 xxl-job速通

news 2025/8/23 16:03:07

目录

一、xxl-job简介

文档地址

源码仓库地址

中央仓库地址

二、运行 xxl-job

        2.1、环境搭建

        2.2、环境配置

        2.3、初始化“调度数据库”

        2.4、接下来找到 xxl-job-admin/src/main/resources/application.properties 文件，修改数据库连接信息：

        2.5、日志配置也要修改一下，在 xxl-job-admin/src/main/resources/logback.xml 文件中，有如下一行：

三、配置部署“执行器项目”

        3.1、准备好一个SpringBoot工程

        3.2、添加xxl-job依赖

        3.3、修改application.properties 文件，内容如下：

        3.4、执行器组件配置

        3.5、部署执行器项目

一、xxl-job简介

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

文档地址
  • 中文文档
  • English Documentation
源码仓库地址
源码仓库地址Release Download
https://github.com/xuxueli/xxl-jobDownload
http://gitee.com/xuxueli0323/xxl-jobDownload
中央仓库地址
<!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
<dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>${最新稳定版本}</version>
</dependency>

二、运行 xxl-job

        2.1、环境搭建

源码下载

想要快速使用xxl-job，我们可以首先到gitee或者是github上拉取它的开源代码

https://github.com/xuxueli/xxl-job

然后用 IDEA 打开项目，打开之后，有五个主要的文件夹：

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

        2.2、环境配置

  • Maven3+

  • Jdk17+ (说明：版本3.x开始要求Jdk17；版本2.x及以下支持Jdk1.8。如对Jdk版本有诉求，可选择接入不同版本。)

  • Mysql8.0+

        2.3、初始化“调度数据库”

由于 xxl-job 运行需要数据库，所以接下来我们就来配置数据库，先找到数据库脚本，在doc/db/tables_xxl_job.sql 位置

找到数据库脚本后，导入到数据库中执行一下，执行完成后，生成如下库和表：

        2.4、接下来找到 xxl-job-admin/src/main/resources/application.properties 文件，修改数据库连接信息：

        2.5、日志配置也要修改一下，在 xxl-job-admin/src/main/resources/logback.xml 文件中，有如下一行：

# windows系统下是这样修改的,直接./表示项目的根目录下生成一个applogs的文件夹用来存放日志
<property name="log.path" value="./applogs/xxl-job/xxl-job-admin.log"/>

找到com.xxl.job.admin.XxlJobAdminApplication运行main方法即可启动“调度中心”项目

项目启动成功后，浏览器输入如下地址 http://localhost:8080/xxl-job-admin/toLogin，就可以看到登录页面了：

登录账号:admin
登录密码:123456

登录后运行界面如下图所示：

至此“调度中心”项目已经部署成功

三、配置部署“执行器项目”

“执行器”项目：xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，可直接使用，也可以参考其并将现有项目改造成执行器)
作用：负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。

        3.1、准备好一个SpringBoot工程

        3.2、添加xxl-job依赖

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

        3.3、修改application.properties 文件，内容如下：

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

日志可选，如果需要日志在 resources 目录下新建 logback.xml，并添加如下内容：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds"><contextName>logback</contextName>
<!--    <property name="log.path" value="/data/applogs/xxl-job/xxl-job-admin.log"/>--><property name="log.path" value="./applogs/xxl-job/xxl-job-admin.log"/><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender><appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern></rollingPolicy><encoder><pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n</pattern></encoder></appender><root level="info"><appender-ref ref="console"/><appender-ref ref="file"/></root></configuration>

        3.4、执行器组件配置

参考执行器组件，配置文件地址：

/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java

package com.hzf.anauditiondemo01.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;/*** @ClassName XxlJobConfig* @Description* @Author Mr.Huang* @Date 2025/8/22 14:17* @Version 1.0**/
@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;@Beanpublic 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();*/
}

        3.5、部署执行器项目

官方提供了三种部署执行器项目的方式:

  • BEAN模式（类形式）
  • BEAN模式（方法形式）
  • GLUE模式(Java)

1.BEAN模式（类形式）

Bean模式任务，支持基于类的开发方式，每个任务对应一个Java类。

  • 优点：不限制项目环境，兼容性好。即使是无框架项目，如main方法直接启动的项目也可以提供支持，可以参考示例项目 “xxl-job-executor-sample-frameless”；
  • 缺点：
    • 每个任务需要占用一个Java类，造成类的浪费；
    • 不支持自动扫描任务并注入到执行器容器，需要手动注入。
步骤一：执行器项目中，开发Job类：
1、开发一个继承自"com.xxl.job.core.handler.IJobHandler"的JobHandler类，实现其中任务方法。
2、手动通过如下方式注入到执行器容器。
​```
XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());
​```
步骤二：调度中心，新建调度任务

后续步骤和 “BEAN模式（方法形式）”一致，可以前往参考

2.BEAN模式（方法形式）

Bean 模式任务，支持基于方法的开发方式，每个任务对应一个方法，一般推荐这种方式。

优点：

  • 每个任务只需要开发一个方法，并添加 ”@XxlJob” 注解即可，更加方便、快速。
  • 支持自动扫描任务并注入到执行器容器。

缺点：

  • 要求 Spring 容器环境。

基于方法开发的任务，底层会生成 JobHandler 代理，和基于类的方式一样，任务也会以 JobHandler 的形式存在于执行器任务容器中。

步骤一：执行器项目中，开发Job方法：
1、任务开发：在Spring Bean实例中，开发Job方法；
2、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
3、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志；
4、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；

package com.hzf.anauditiondemo01.job;import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;/*** @ClassName MyJobHandler* @Description* @Author Mr.Huang* @Date 2025/8/22 14:50* @Version 1.0**/
@Component
public class MyJobHandler {@XxlJob("demoJobHandler")public void demoJobHandler() {String param = XxlJobHelper.getJobParam();System.out.println("能看到我吗？1111");XxlJobHelper.log("XXL-JOB, Hello World！：{}", param);}
}

步骤二：调度中心，新建调度任务

接下来打开配置调度中心，找到执行器管理，点击新增，如下：

接下来找到任务管理，并点击新增：

以上我是通过cron表达式进行配置的,每5秒执行一下我刚刚写的Job

附赠:Cron表达式

注意这里建好的调度任务名称后，配置文件要和调度任务名称一致

配置完成后，回到执行器管理，点击查看，可以查看刚刚注册的节点信息：

再次回到任务管理，选择启动，就可以开始定时任务的执行了：

开启之后，点击调度日志，就可以看到我们系统任务执行的详细信息了：

点击操作,可以查看执行日志:

3.GLUE模式(Java)

任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。开发流程如下：

步骤一：调度中心，新建调度任务：

对新建的任务进行参数配置，运行模式选中 “GLUE模式(Java)”

步骤二：开发任务代码：
选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。

版本回溯功能（支持30个版本的版本回溯）：在GLUE任务的Web IDE界面，选择右上角下拉框“版本回溯”，会列出该GLUE的更新历史，选择相应版本即可显示该版本代码，保存后GLUE代码即回退到对应的历史版本；

http://www.dtcms.com/a/346349.html

相关文章：

  • 解决 微信开发者工具 ：下载基础库版本 2.31.0 失败
  • RAG和微调是什么？两者的区别？什么场景使用RAG或微调？判断依据是什么？
  • LINUX网络编程--网络的发展与通信
  • AI赋能环保精准治理：AI水质监测溯源快、空气质量预测施策准，守护生态新效能
  • 关于 java+gradle的弹窗多选应用app
  • 【GPT入门】第54课 量化位数与存储大小的影响
  • Java 面试题训练助手 Web 版本
  • 网络通信——UDP协议。
  • Kubernetes 1.28 集群部署指南（基于 Containerd 容器运行时）
  • 笔记：二叉树构建方法
  • 从“配置化思维”到“前端效率革命”：xiangjsoncraft 如何用 JSON 简化页面开发？
  • 【源码】MES系统：从下达计划、执行反馈、异常预警到过程控制的一整套执行中枢。
  • FastTracker：实时准确的视觉跟踪
  • 一键部署openGauss6.0.2轻量版单节点
  • DPY-3010: connections to this database server version are not supported by p
  • LoRA内幕机制解析（53）
  • Design Compiler：层次模型(Block Abstraction)的简介
  • 什么是神鸟云？
  • 亚马逊老品怎么再次爆发流量？
  • 软件测试要怎么自学？
  • CVPR 2025 | 哈工大港大DeCLIP：解耦CLIP注意力实现开放词汇感知！
  • RK3588随笔：MIPI协议——D-PHY 物理层的自定义和校验
  • codeforces round 1043(div3) 补题
  • Finite State Machine(FSM) for the Development Mode
  • NVM-Windows 命令大全
  • YOLO --- YOLOv5模型以及项目详解
  • Tiger任务管理系统-13
  • MiniOB环境部署开发(使用Docker)
  • FPC设计技巧
  • 解释实现哈希值作为唯一的ID以及后面的hexdigest是什么意思