解决 XXL-Job 端口额外占用问题小结

🏷️个人主页：牵着猫散步的鼠鼠

🏷️系列专栏：Java技术栈笔记

🏷️个人学习笔记，若有缺误，欢迎评论区指正

1. 前言

2. 问题解决

2.1. 下载源码

2.2. 启动admin服务器

2.3. 项目引入core组件

3. 总结

1. 前言

最近博主在Spring整合XXL-JOB到项目时发现了个问题，注册执行器需要额外占用端口，也就是我们每启动一个程序，除了程序本身的API端口外，还需要额外开放一个执行器端口。

这样看起来没啥，但是如果放到Docker容器中，用户不显示指定执行器端口的话，默认占用9999端口，假如我想启动两个实例，那么必定会发生端口冲突，也就是我必须为每个实例指定执行器端口，假如我有10个实例，那也太麻烦了的吧，然后去xxl-job github查看，发现issue都已经1.2k个了，这个问题也老早就有人提了Issue，可是作者不太理人不管事哈哈(可能生活太忙维护不过来啦)

2. 问题解决

2.1. 下载源码

我这里找到一位老哥修改的克隆版本，移除了netty组件，使执行器端口与Springboot的web端口一致

首先下载修改后的源码：kdyzm/xxl-job: 本项目是xxl-job 项目的克隆项目，目的在于优化和修复原项目中的问题 (github.com)

和官方源码一样，分为三部分代码，只是修改了部分源码

2.2. 启动admin服务器

我们接下来修改xxl-job-admin的配置文件application.properties，修改admin服务端端口

修改访问密钥，这个我们在被调度方会使用到

修改数据源(数据库还是没变哈，可参考我以前部署xxl-job的文章)

配置完以上信息就可以启动admin服务端啦

2.3. 项目引入core组件

修改core项目的pom文件 groupId配置，方便我们后续在项目中引用

接下来我们重新打包core项目，并install到我们本地仓库

等待core项目install完成后，我们就可以在自己的项目中使用修改后的xxl-job core组件了

在自己项目application.yml中添加如下配置，端口设置为springboot服务端口


xxl:
  job:
    # 验证信息 官网Bug https://github.com/xuxueli/xxl-job/issues/1951
    accessToken: 123123123
    # 注册地址
    admin:
      addresses: http://127.0.0.1:9090/xxl-job-admin
    # 注册执行器
    executor:
      #  执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
      address:
      appname: lucky-draw-handler
      # 执行器IP 配置为本机IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      ip:
      # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      port: ${server.port}
      # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logpath: ./logs
      # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
      logretentiondays: 30

新增配置类

@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 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;
    }

}

启动项目即可发现自己执行器成功注册到了admin服务端