springboot集成xxl-job

最新推荐文章于 2025-11-18 15:19:45 发布

原创最新推荐文章于 2025-11-18 15:19:45 发布 · 818 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#分布式

杂项专栏收录该内容

4 篇文章

订阅专栏

前言：关于xxl-job的一些简单的介绍就不做过多介绍，本文主要讲一下如何将xxl-job整合到springboot项目中。

先贴上项目的两个地址：
1.github： https://github.com/xuxueli/xxl-job
2.码云：http://gitee.com/xuxueli0323/xxl-job

随便找一个然后下载下来，导入到自己的编写工具中，目录结构如下：
在这里插入图片描述
创建xxl-job依赖的8张表，脚本位置如下：

创建成功后更改工程xxl-job-admin的数据库连接，其它配置可以不用动，启动工程

然后输入：http://localhost:18080/xxl-job-admin/ 端口号自己在配置文件指定。
成功后如下图
在这里插入图片描述
任务管理界面
编辑任务页面

在这里插入图片描述自己的定时任务

任务名字注意保持一致。

执行器管理界面
在这里插入图片描述编辑执行器界面

AppName对应配置文件中的xxl.job.executor.appname=xxl-job-executor-sample。

可以看看下载的xxl-job-excutors-samples里面springboot的事例写法。
有了前面的初步了解，下面的整合步骤也就很清晰了。
一、在你的springboot项目的pom中加上

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

二、将xxl-job的配置集成到你自己项目中配置中

### xxl-job admin address list：调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。
xxl.job.admin.addresses=http://127.0.0.1:18080/xxl-job-admin
### xxl-job executor address：执行器"AppName"和地址信息配置：AppName执行器心跳注册分组依据；地址信息用于"调度中心请求并触发任务"和"执行器注册"。执行器默认端口为9999，执行器IP默认为空表示自动获取IP，多网卡时可手动设置指定IP，手动设置IP时将会绑定Host。单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.appname=xxl-job-executor-sample
xxl.job.executor.ip=
xxl.job.executor.address=
xxl.job.executor.port=9999
### 执行器通讯TOKEN：非空时启用；
xxl.job.accessToken=
### 执行器运行日志文件存储磁盘路径 ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志保存天数：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效；
xxl.job.executor.logretentiondays=-1

三、将执行器加载配置类整合到项目中

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
 *
 */
@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();
     */


}

四、编写自己的定时任务

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

/**
 * 任务Handler示例（Bean模式）
 */
@Component
public class DemoJobHandler{

    @XxlJob("demoJobHandler")
    public ReturnT<String> demoJobHandler(String param) throws Exception {

        return ReturnT.SUCCESS;
    }
}