ElasticJob 快速上手

廢物大師兄發表於2021-01-19

1.  ElasticJob 是什麼

ElasticJob 是一個分散式排程解決方案,由兩個相互獨立的子專案 ElasticJob-Lite 和 ElasticJob-Cloud 組成。 

ElasticJob-Lite 定位為輕量級無中心化解決方案,使用jar的形式提供分散式任務的協調服務。

ElasticJob 已於2020年5月28日成為 Apache ShardingSphere 的子專案。 

ElasticJob特性:

  • 彈性排程
    • 支援任務在分散式場景下的分片和高可用
    • 能夠水平擴充套件任務的吞吐量和執行效率
    • 任務處理能力隨資源配備彈性伸縮 
  • 資源分配
    • 在適合的時間將適合的資源分配給任務並使其生效
    • 相同任務聚合至相同的執行器統一處理
    • 動態調配追加資源至新分配的任務  
  • 作業治理
    • 失效轉移
    • 錯過作業重新執行
    • 自診斷修復
  • 作業開放生態
    • 可擴充套件的作業型別統一介面
    • 豐富的作業型別庫,如資料流、指令碼、HTTP、檔案、大資料等
    • 易於對接業務作業,能夠與 Spring 依賴注入無縫整合  
  • 視覺化管控端
    • 作業管控端
    • 作業執行歷史資料追蹤
    • 註冊中心管理 

2.  例項演示

這裡採用最新版本 3.0.0-RC1 

1、啟動zookeeper服務

首先,下載zookeeper-3.6.0版本,解壓後複製一份zoo_sample.cfg,重新命名未zoo.cfg,保持預設配置即可

注意,zookeeper-3.6.0啟動以後會佔用三個埠,其中包括8080哦

2、編寫定時任務業務邏輯

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.1</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>elasticjob-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
        <elasticjob-lite.version>3.0.0-RC1</elasticjob-lite.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.shardingsphere.elasticjob</groupId>
            <artifactId>elasticjob-lite-spring-boot-starter</artifactId>
            <version>${elasticjob-lite.version}</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-jdbc</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.apache.shardingsphere.elasticjob</groupId>
            <artifactId>elasticjob-error-handler-dingtalk</artifactId>
            <version>${elasticjob-lite.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

application.yml

elasticjob:
  regCenter:
    serverLists: 192.168.100.15:2181
    namespace: elasticjob-demo
    baseSleepTimeMilliseconds: 2000
    maxSleepTimeMilliseconds: 4000
    maxRetries: 3
  jobs:
    firstJob:
      elasticJobClass: com.example.job.FirstJob
      cron: 0/6 * * * * ?
      shardingTotalCount: 3
      jobErrorHandlerType: DINGTALK
      props:
        dingtalk:
          webhook: https://oapi.dingtalk.com/robot/send?access_token=xxx
          secret: ASDF
          connectTimeout: 3000
          readTimeout: 5000
    secondJob:
      elasticJobClass: com.example.job.SecondJob
      cron: 0/10 * * * * ?
      shardingTotalCount: 1
      jobErrorHandlerType: DINGTALK
      props:
        dingtalk:
          webhook: https://oapi.dingtalk.com/robot/send?access_token=xxx
          secret: ASDF
          connectTimeout: 3000
          readTimeout: 5000 

兩個定時任務

FirstJob.java

package com.example.job;

import org.apache.shardingsphere.elasticjob.api.ShardingContext;
import org.apache.shardingsphere.elasticjob.simple.job.SimpleJob;
import org.springframework.stereotype.Component;

/**
 * @author ChengJianSheng
 * @date 2021/1/13
 */
@Component
public class FirstJob implements SimpleJob {
    @Override
    public void execute(ShardingContext shardingContext) {
        switch (shardingContext.getShardingItem()) {
            case 0:
                // do something by sharding item 0
                System.out.println(0);
                // int a = 1 / 0;
                break;
            case 1:
                // do something by sharding item 1
                System.out.println(1);
                break;
            case 2:
                // do something by sharding item 2
                System.out.println(2);
                break;
            // case n: ...
        }
    }
}

SecondJob.java

package com.example.job;

import org.apache.shardingsphere.elasticjob.api.ShardingContext;
import org.apache.shardingsphere.elasticjob.simple.job.SimpleJob;
import org.springframework.stereotype.Component;

/**
 * @author ChengJianSheng
 * @date 2021/1/18
 */
@Component
public class SecondJob implements SimpleJob {
    @Override
    public void execute(ShardingContext shardingContext) {
        System.out.println("hello");
    }
} 

專案結構

執行專案即可

通過 ElasticJob-UI 檢視任務

https://shardingsphere.apache.org/elasticjob/current/cn/downloads/

3.  啟動報錯排查

專案啟動過程中,可能會報如下錯誤

org.apache.zookeeper.ClientCnxn$EndOfStreamException: Unable to read additional data from server sessionid 0x1000bdf48160002, likely server has closed socket

org.apache.shardingsphere.elasticjob.reg.exception.RegException: org.apache.zookeeper.KeeperException$OperationTimeoutException: KeeperErrorCode = OperationTimeout

Caused by: org.apache.zookeeper.KeeperException$OperationTimeoutException: KeeperErrorCode = OperationTimeout

最開始,我以為是zookeeper版本的問題,後來換了版本也不行,防火牆關了也不行

然後,我懷疑是開發環境問題,於是在本地執行zookeeper,程式連127.0.0.1:2181,居然可以了

於是我陷入了沉思,為今之計,只剩下一個辦法了,打斷點除錯

找到了異常丟擲的位置,如下圖

baseSleepTimeMilliseconds 表示 等待重試的間隔時間的初始值

maxSleepTimeMilliseconds  表示 等待重試的間隔時間的最大值

maxRetries 表示 最大重試次數

根據程式碼中意思,如果在 maxSleepTimeMilliseconds * maxRetries 毫秒內還沒有連線成功,則連線關閉,並丟擲操作超時異常

聯想到,連線本地zookeeper可以,連開發環境zk就不行,再加上觀察日誌從連線開始到拋異常的時間間隔,我猜到應該是maxSleepTimeMilliseconds設定太短了

於是,application.yml配置檔案中將maxSleepTimeMilliseconds設定為4000,baseSleepTimeMilliseconds設定為2000

然後好使

回想剛開始報的那些錯,其實根本就還沒有連上zookeeper

4.  作業分片

ElasticJob 中任務分片項的概念,使得任務可以在分散式的環境下執行,每臺任務伺服器只執行分配給該伺服器的分片。 隨著伺服器的增加或當機,ElasticJob 會近乎實時的感知伺服器數量的變更,從而重新為分散式的任務伺服器分配更加合理的任務分片項,使得任務可以隨著資源的增加而提升效率。

任務的分散式執行,需要將一個任務拆分為多個獨立的任務項,然後由分散式的伺服器分別執行某一個或幾個分片項。

也就是說,分片是為了在分散式環境下高效合理利用任務伺服器資源的。簡單地來講,一個定時任務,我們執行多臺伺服器,這意味著有多個例項在執行同一項任務,分片就是為了告訴這些例項各自該處理那些資料,最大限度的降低資料重複處理的問題,同時加快任務處理速度。每個任務例項該處理哪些資料,是根據分片項來的,在任務程式碼層面,就可以根據分片項來進行邏輯判斷。

舉例說明,如果作業分為 4 片,用兩臺伺服器執行,則每個伺服器分到 2 片,分別負責作業的 50% 的負載

分片項

ElasticJob 並不直接提供資料處理的功能,而是將分片項分配至各個執行中的作業伺服器,開發者需要自行處理分片項與業務的對應關係。 分片項為數字,始於 0 而終於分片總數減 1。

個性化分片引數

個性化引數可以和分片項匹配對應關係,用於將分片項的數字轉換為更加可讀的業務程式碼。 

合理使用個性化引數可以讓程式碼更可讀。例如,如果配置為 0=北京,1=上海,2=廣州,那麼程式碼中直接使用北京,上海,廣州的列舉值即可完成分片項和業務邏輯的對應關係。

分片策略

平均分片策略

根據分片項平均分片。如果作業伺服器數量與分片總數無法整除,多餘的分片將會順序的分配至每一個作業伺服器。

舉例說明:

  • 如果 3 臺作業伺服器且分片總數為9, 則分片結果為:1=[0,1,2], 2=[3,4,5], 3=[6,7,8]
  • 如果 3 臺作業伺服器且分片總數為8, 則分片結果為:1=[0,1,6], 2=[2,3,7], 3=[4,5]
  • 如果 3 臺作業伺服器且分片總數為10,則分片結果為:1=[0,1,2,9], 2=[3,4,5], 3=[6,7,8]

奇偶分片策略 

根據作業名稱雜湊值的奇偶數決定按照作業伺服器 IP 升序或是降序的方式分片。

如果作業名稱雜湊值是偶數,則按照 IP 地址進行升序分片; 如果作業名稱雜湊值是奇數,則按照 IP 地址進行降序分片。 可用於讓伺服器負載在多個作業共同執行時分配的更加均勻。

舉例說明:

  • 如果 3 臺作業伺服器,分片總數為2且作業名稱的雜湊值為偶數,則分片結果為:1 = [0], 2 = [1], 3 = []
  • 如果 3 臺作業伺服器,分片總數為2且作業名稱的雜湊值為奇數,則分片結果為:3 = [0], 2 = [1], 1 = [] 

輪詢分片策略

根據作業名稱輪詢分片。

5.  官方文件

https://shardingsphere.apache.org/elasticjob/current/cn/features/elastic/

https://shardingsphere.apache.org/elasticjob/current/cn/user-manual/elasticjob-lite/ 

https://shardingsphere.apache.org/elasticjob/current/cn/user-manual/elasticjob-lite/configuration/ 

https://shardingsphere.apache.org/elasticjob/current/cn/dev-manual/ 

 

相關文章