分散式任務排程xxl-job問題解決

2022-03-05 13:00:29

前言

在單機應用時期，任務排程一般都是基於spring schedule和整合quartz來實現的，當系統發展成分散式服務，應用多範例的時候，任務就會出現多次呼叫的問題，很多時候我們任務並不需要跑多次。解決方案有很多，最最簡單粗暴的就是可以設定應用開關。其次就是集中式話任務管理排程。當然，quartz也有叢集模式，但是基於api控制並不直觀。下面介紹一個集中式的分散式任務排程框架，可以很方便的解決分散式任務排程的問題

xxl-job簡介

XXL-JOB是一個輕量級分散式任務排程框架，其核心設計目標是開發迅速、學習簡單、輕量級、易擴充套件。現已開放原始碼並接入多家公司線上產品線，開箱即用。

功能如下

1、簡單：支援通過Web頁面對任務進行CRUD操作，操作簡單，一分鐘上手；

2、動態：支援動態修改任務狀態、暫停/恢復任務，以及終止執行中任務，即時生效；

3、排程中心HA（中心式）：排程採用中心式設計，“排程中心”基於叢集Quartz實現，可保證排程中心HA；

4、執行器HA（分散式）：任務分散式執行，任務"執行器"支援叢集部署，可保證任務執行HA；

5、任務Failover：執行器叢集部署時，任務路由策略選擇"故障轉移"情況下排程失敗時將會平滑切換執行器進行Failover；

6、一致性：“排程中心”通過DB鎖保證叢集分散式排程的一致性, 一次任務排程只會觸發一次執行；

7、自定義任務引數：支援線上設定排程任務入參，即時生效；

8、排程執行緒池：排程系統多執行緒觸發排程執行，確保排程精確執行，不被堵塞；

9、彈性擴容縮容：一旦有新執行器機器上線或者下線，下次排程時將會重新分配任務；

10、郵件報警：任務失敗時支援郵件報警，支援設定多郵件地址群發報警郵件；

11、狀態監控：支援實時監控任務進度；

12、Rolling執行紀錄檔：支援線上檢視排程結果，並且支援以Rolling方式實時檢視執行器輸出的完整的執行紀錄檔；

13、GLUE：提供Web IDE，支援線上開發任務邏輯程式碼，動態釋出，實時編譯生效，省略部署上線的過程。支援30個版本的歷史版本回溯。

14、資料加密：排程中心和執行器之間的通訊進行資料加密，提升排程資訊保安性；

15、任務依賴：支援設定子任務依賴，當父任務執行結束且執行成功後將會主動觸發一次子任務的執行, 多個子任務用逗號分隔；

16、推播maven中央倉庫: 將會把最新穩定版推播到maven中央倉庫, 方便使用者接入和使用;

17、任務註冊: 執行器會週期性自動註冊任務, 排程中心將會自動發現註冊的任務並觸發執行。同時，也支援手動錄入執行器地址；

18、路由策略：執行器叢集部署時提供豐富的路由策略，包括：第一個、最後一個、輪詢、隨機、一致性HASH、最不經常使用、最近最久未使用、故障轉移、忙碌轉移等；

19、執行報表：支援實時檢視執行資料，如任務數量、排程次數、執行器數量等；以及排程報表，如排程日期分佈圖，排程成功分佈圖等；

20、指令碼任務：支援以GLUE模式開發和執行指令碼任務，包括Shell、Python等型別指令碼;

21、阻塞處理策略：排程過於密集執行器來不及處理時的處理策略，策略包括：單機序列（預設）、丟棄後續排程、覆蓋之前排程；

22、失敗處理策略；排程失敗時的處理策略，策略包括：失敗告警（預設）、失敗重試；

23、分片廣播任務：執行器叢集部署時，任務路由策略選擇"分片廣播"情況下，一次任務排程將會廣播觸發叢集中所有執行器執行一次任務，可根據分片引數開發分片任務；

24、動態分片：分片廣播任務以執行器為維度進行分片，支援動態擴容執行器叢集從而動態增加分片數量，協同進行業務處理；在進行巨量資料量業務操作時可顯著提升任務處理能力和速度。

25、事件觸發：除了"Cron方式"和"任務依賴方式"觸發任務執行之外，支援基於事件的觸發任務方式。排程中心提供觸發任務單次執行的API服務，可根據業務事件靈活觸發。

快速入門

專案地址為：https://github.com/xuxueli/xxl-job

2.1 初始化“排程資料庫”

請下載專案原始碼並解壓，獲取 "排程資料庫初始化SQL指令碼" 並執行即可，正常情況下應該生成16張表。

"排程資料庫初始化SQL指令碼" 位置為:

/xxl-job/doc/db/tables_xxl_job.sql

排程中心支援叢集部署，叢集情況下各節點務必連線同一個mysql範例;

如果mysql做主從,排程中心叢集節點務必強制走主庫;

2.2 編譯原始碼

解壓原始碼,按照maven格式將原始碼匯入IDE, 使用maven進行編譯即可，原始碼結構如下：

xxl-job-admin：排程中心
xxl-job-core：公共依賴
xxl-job-executor：執行器Sample範例（選擇合適的版本執行器，可直接使用，也可以參考其並將現有專案改造成執行器）
：xxl-job-executor-sample-spring：Spring版本，通過Spring容器管理執行器，比較通用，推薦這種方式；
：xxl-job-executor-sample-springboot：Springboot版本，通過Springboot管理執行器；
：xxl-job-executor-sample-jfinal：JFinal版本，通過JFinal管理執行器；

2.3 設定部署“排程中心”

排程中心專案：xxl-job-admin
作用：統一管理任務排程平臺上排程任務，負責觸發排程執行，並且提供任務管理平臺。

步驟一：排程中心設定：

排程中心組態檔地址：

/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties

排程中心設定內容說明：

### 排程中心JDBC連結：連結地址請保持和 2.1章節所建立的排程資料庫的地址一致

xxl.job.db.driverClass=com.mysql.jdbc.Driver
xxl.job.db.url=jdbc:mysql://localhost:3306/xxl-job?useUnicode=true&characterEncoding=UTF-8
xxl.job.db.user=root
xxl.job.db.password=root_pwd

### 報警郵箱

xxl.job.mail.host=smtp.163.com
xxl.job.mail.port=25
xxl.job.mail.username=ovono802302@163.com
xxl.job.mail.password=asdfzxcv
xxl.job.mail.sendFrom=ovono802302@163.com
xxl.job.mail.sendNick=《任務排程平臺XXL-JOB》

### 登入賬號

xxl.job.login.username=admin
xxl.job.login.password=123456

### 排程中心通訊TOKEN，非空時啟用

xxl.job.accessToken=

步驟二：部署專案：

如果已經正確進行上述設定，可將專案編譯打war包並部署到tomcat中。排程中心存取地址：http://localhost:8080/xxl-job-admin (該地址執行器將會使用到，作為回撥地址)，登入後執行介面如下圖所示

至此“排程中心”專案已經部署成功。

步驟三：排程中心叢集（可選）：

排程中心支援叢集部署，提升排程系統可用性。

叢集部署唯一要求為：保證每個叢集節點設定（db和登陸賬號等）保持一致。排程中心通過db設定區分不同叢集。

排程中心在叢集部署時可通過nginx負載均衡，此時可以為叢集分配一個域名。該域名一方面可以用於存取，另一方面也可以用於設定執行器回撥地址。

2.4 設定部署“執行器專案”

“執行器”專案：xxl-job-executor-sample-spring (如新建執行器專案，可參考該Sample範例執行器專案的設定步驟；)

作用：負責接收“排程中心”的排程並執行；可直接部署執行器，也可以將執行器整合到現有業務專案中。

步驟一：maven依賴確認pom檔案中引入了 "xxl-job-core" 的maven依賴；

步驟二：執行器設定執行器設定，組態檔地址：

/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-spring/src/main/resources/xxl-job-executor.properties

執行器設定，設定內容說明：

### xxl-job admin address list：排程中心部署跟地址：如排程中心叢集部署存在多個地址則用逗號分隔。執行器將會使用該地址進行"執行器心跳註冊"和"任務結果回撥"。

xxl.job.admin.addresses=http://127.0.0.1:8080/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.port=9999

### xxl-job log path：執行器執行紀錄檔檔案儲存的磁碟位置，需要對該路徑擁有讀寫許可權
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler/

### xxl-job, access token：執行器通訊TOKEN，非空時啟用

xxl.job.accessToken=

步驟三：執行器元件設定執行器元件，組態檔地址：

/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-spring/src/main/resources/applicationcontext-xxl-job.xml

執行器元件，設定內容說明：

<!-- 設定01、JobHandler 掃描路徑：自動掃描容器中JobHandler -->
<context:component-scan base-package="com.xxl.job.executor.service.jobhandler" />

<!-- 設定02、執行器Excutor設定：執行器核心設定 -->
<bean id="xxlJobExecutor" class="com.xxl.job.core.executor.XxlJobExecutor" init-method="start" destroy-method="destroy" >
    <!-- 執行器IP[選填]，為空則自動獲取 -->
    <property name="ip" value="${xxl.job.executor.ip}" />
    <!-- 執行器埠號[必須] -->
    <property name="port" value="${xxl.job.executor.port}" />
    <!-- 執行器AppName[選填]，為空則關閉自動註冊 -->
    <property name="appName" value="${xxl.job.executor.appname}" />
    <!-- 執行器註冊中心地址[選填]，為空則關閉自動註冊 -->
    <property name="adminAddresses" value="${xxl.job.admin.addresses}" />
    <!-- 執行器紀錄檔路徑[必填] -->
    <property name="logPath" value="${xxl.job.executor.logpath}" />
    <!-- 存取令牌，非空則進行匹配校驗[選填] -->
    <property name="accessToken" value="${xxl.job.accessToken}" />
</bean>

步驟四：部署執行器專案：如果已經正確進行上述設定，可將執行器專案編譯打部署，系統提供三個執行器Sample範例專案，選擇其中一個即可，各自的部署方式如下。

xxl-job-executor-sample-spring：專案編譯打包成WAR包，並部署到tomcat中。
xxl-job-executor-sample-springboot：專案編譯打包成springboot型別的可執行JAR包，命令啟動即可；

至此“執行器”專案已經部署結束。

步驟五：執行器叢集（可選）：

執行器支援叢集部署，提升排程系統可用性，同時提升任務處理能力。

叢集部署唯一要求為：保證叢集中每個執行器的設定項 "xxl.job.admin.addresses/排程中心地址" 保持一致，執行器根據該設定進行執行器自動註冊等操作。

2.5 開發第一個任務“Hello World”

本範例以新建一個 “GLUE模式(Java)” 執行模式的任務為例。更多有關任務的詳細設定，請檢視“章節三：任務詳解”。（ “GLUE模式(Java)”的執行程式碼託管到排程中心線上維護，相比“Bean模式任務”需要在執行器專案開發部署上線，更加簡便輕量）

前提：請確認“排程中心”和“執行器”專案已經成功部署並啟動；

步驟一：新建任務：登入排程中心，點選下圖所示“新建任務”按鈕，新建範例任務。然後，參考下面截圖中任務的引數設定，點選儲存。

步驟二：“GLUE模式(Java)” 任務開發：

請點選任務右側 “GLUE” 按鈕，進入 “GLUE編輯器開發介面” ，見下圖。“GLUE模式(Java)” 執行模式的任務預設已經初始化了範例任務程式碼，即列印Hello World。（ “GLUE模式(Java)” 執行模式的任務實際上是一段繼承自IJobHandler的Java類程式碼，它在執行器專案中執行，可使用@Resource/@Autowire注入執行器裡中的其他服務）