Xxl-Job執行器自動注冊是怎么做的？

作者：wayna 2024-12-04 10:47:26

相信使用過 xxl-job 的眾多開發同學里，有很多人新增執行器時都是跟我們一樣選擇自動注冊。這個操作在容器化部署來臨之前沒什么問題，但是隨著后來 docker 容器的流行，線上服務大多以容器方式放行。

一、xxl-job 執行器自動注冊 ip 錯誤

先說一下問題發生的場景，這個問題來自我們測試 xxl-job 后管新增一個執行器時，新增執行器時選擇的是自動注冊機制，也就是由 xxl-job 自動填寫我們的執行器 ip 地址。

容器的 ip 都是虛擬 ip，不代表物理機真實通信地址的 ip，這里就有一個問題，如果 xxl-job 后管跟執行器不在同一個服務器部署，并且執行器自動注冊提交的是容器 ip，那么就會產生定時任務執行失敗的問題，因為 xxl-job 后管調用不通執行器。

這里給大家畫一個 xxl-job 調用執行器的示意圖，方便大家理解，

調用流程

給大家講一下示意圖：

1.xxl-job 執行器在啟動時會向 xxl-job 后管提交當前服務器 ip，獲取邏輯在 com.xxl.job.core.util.IpUtil#getIp 方法中，這個方法在最新版本里默認優先使用 JDK 提供的 InetAddress.getLocalHost() 方法獲取本機 ip。獲取不到的話再使用 JDK 提供的 NetworkInterface.getNetworkInterfaces() 方法遍歷本機網卡獲取 ip。

InetAddress.getLocalHost() 的一些坑：

在 Linux 環境通過獲取 /etc/hosts 和 /etc/resolv.conf 文件內容，如果在 /etc/hosts 文件內容中沒有匹配到對應的 ip 地址，則通過 /etc/resolv.conf 中配置的 DNS 地址，向 DNS 服務器發出域名解析請求；
如果訪問 DNS 服務存在性能問題；
InetAddress.getLocalHost() 實現中還加了 synchronized 鎖，并發環境中會影響性能。

2.調用 xxl-job 后管提供的 api/registry 接口，傳遞 xxl-job 執行器名稱以及通信地址。

3.xxl-job 后管觸發定時任務時，會調用 xxl-job 執行器提供的 /run 接口來執行對應任務。

在上面流程中，因為第二步提交的 xxl-job 執行器通信地址錯誤，因而導致第三步執行失敗。那么怎么解決這個問題嘞，其實很簡單，xxl-job 后管使用手動注冊填寫可以聯通的執行器地址即可。

二、xxl-job執行器自動注冊流程

xxl-job 執行器的自動注冊流程其實很簡單，這里給大家梳理一下，

自動注冊、移除流程

三、執行器注冊

客戶端在引入 xxl-job 執行器啟動時，xxl-job 執行器會啟動 ExecutorRegistryThread 線程，

圖片

這個線程是專門來做執行器注冊的，它會每隔 30 秒調用 xxl-job 后管的 /api/register 接口提交執行器地址和名稱。

xxl-job 后管收到執行器的注冊信息后，會通過 registryOrRemoveThreadPool 線程池異步保存執行器信息并發送成功響應。

圖片

registryOrRemoveThreadPool 線程池會判斷是否已經存在當前執行器注冊記錄，不存在就新建，存在就更新執行器最新注冊時間。

所以當我們在 xxl-job 后管新增執行器，選擇自動注冊的時候，執行器的地址就是這么來的。

四、執行器移除

移除有兩個方式，一種是正常結束 xxl-job 執行器，比如停止應用程序，xxl-job 執行器就會調用 /api/registryRemove 接口用來移除當前執行器注冊信息。還有一種 xxl-job 后管啟動的 registryMonitorThread 線程自動檢測注冊時間已經超期的執行器注冊信息。

圖片