XXL-Job端口額外占用問題的解決方法小結

更新時間：2024年05月14日 09:41:15 作者：牽著貓散步的鼠鼠

最近博主在Spring整合XXL-JOB到項目時發(fā)現(xiàn)了個問題,注冊執(zhí)行器需要額外占用端口,也就是我們每啟動一個程序,除了程序本身的API端口外,還需要額外開放一個執(zhí)行器端口,所以本文給大家分享了XXL-Job端口額外占用問題的解決方法小結,需要的朋友可以參考下

1. 前言

最近博主在Spring整合XXL-JOB到項目時發(fā)現(xiàn)了個問題，注冊執(zhí)行器需要額外占用端口，也就是我們每啟動一個程序，除了程序本身的API端口外，還需要額外開放一個執(zhí)行器端口。

這樣看起來沒啥，但是如果放到Docker容器中，用戶不顯示指定執(zhí)行器端口的話，默認占用9999端口，假如我想啟動兩個實例，那么必定會發(fā)生端口沖突，也就是我必須為每個實例指定執(zhí)行器端口，假如我有10個實例，那也太麻煩了的吧，然后去xxl-job github查看，發(fā)現(xiàn)issue都已經(jīng)1.2k個了，這個問題也老早就有人提了Issue，可是作者不太理人不管事哈哈(可能生活太忙維護不過來啦)

2. 問題解決

2.1. 下載源碼

我這里找到一位老哥修改的克隆版本，移除了netty組件，使執(zhí)行器端口與Springboot的web端口一致

首先下載修改后的源碼：kdyzm/xxl-job: 本項目是xxl-job 項目的克隆項目，目的在于優(yōu)化和修復原項目中的問題 (github.com)

和官方源碼一樣，分為三部分代碼，只是修改了部分源碼

2.2. 啟動admin服務器

我們接下來修改xxl-job-admin的配置文件application.properties，修改admin服務端端口

修改訪問密鑰，這個我們在被調(diào)度方會使用到

修改數(shù)據(jù)源(數(shù)據(jù)庫還是沒變哈，可參考我以前部署xxl-job的文章)

配置完以上信息就可以啟動admin服務端啦

2.3. 項目引入core組件

修改core項目的pom文件 groupId配置，方便我們后續(xù)在項目中引用

接下來我們重新打包core項目，并install到我們本地倉庫

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

在自己項目application.yml中添加如下配置，端口設置為springboot服務端口

 
xxl:
  job:
    # 驗證信息 官網(wǎng)Bug https://github.com/xuxueli/xxl-job/issues/1951
    accessToken: 123123123
    # 注冊地址
    admin:
      addresses: http://127.0.0.1:9090/xxl-job-admin
    # 注冊執(zhí)行器
    executor:
      #  執(zhí)行器注冊 [選填]：優(yōu)先使用該配置作為注冊地址，為空時使用內(nèi)嵌服務 ”IP:PORT“ 作為注冊地址。從而更靈活的支持容器類型執(zhí)行器動態(tài)IP和動態(tài)映射端口問題。
      address:
      appname: lucky-draw-handler
      # 執(zhí)行器IP 配置為本機IP [選填]：默認為空表示自動獲取IP，多網(wǎng)卡時可手動設置指定IP，該IP不會綁定Host僅作為通訊實用；地址信息用于 "執(zhí)行器注冊" 和 "調(diào)度中心請求并觸發(fā)任務"；
      ip:
      # 執(zhí)行器端口號 [選填]：小于等于0則自動獲?。荒J端口為9999，單機部署多個執(zhí)行器時，注意要配置不同執(zhí)行器端口；
      port: ${server.port}
      # 執(zhí)行器運行日志文件存儲磁盤路徑 [選填] ：需要對該路徑擁有讀寫權限；為空則使用默認路徑；
      logpath: ./logs
      # 執(zhí)行器日志文件保存天數(shù) [選填] ： 過期日志自動清理, 限制值大于等于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;
    }
 
}

啟動項目即可發(fā)現(xiàn)自己執(zhí)行器成功注冊到了admin服務端