Dubbo原始碼解析之服務叢集

Java勸退師發表於2019-04-11

1.簡介

為了避免單點故障,現在的應用通常至少會部署在兩臺伺服器上。對於一些負載比較高的服務,會部署更多的伺服器。這樣,在同一環境下的服務提供者數量會大於1。對於服務消費者來說,同一環境下出現了多個服務提供者。這時會出現一個問題,服務消費者需要決定選擇哪個服務提供者進行呼叫。另外服務呼叫失敗時的處理措施也是需要考慮的,是重試呢,還是丟擲異常,亦或是隻列印異常等。為了處理這些問題,Dubbo 定義了叢集介面 Cluster 以及 Cluster Invoker。叢集 Cluster 用途是將多個服務提供者合併為一個 Cluster Invoker,並將這個 Invoker 暴露給服務消費者。這樣一來,服務消費者只需通過這個 Invoker 進行遠端呼叫即可,至於具體呼叫哪個服務提供者,以及呼叫失敗後如何處理等問題,現在都交給叢集模組去處理。叢集模組是服務提供者和服務消費者的中間層,為服務消費者遮蔽了服務提供者的情況,這樣服務消費者就可以專心處理遠端呼叫相關事宜。比如發請求,接受服務提供者返回的資料等。這就是叢集的作用。

Dubbo 提供了多種叢集實現,包含但不限於 Failover Cluster、Failfast Cluster 和 Failsafe Cluster 等。每種叢集實現類的用途不同,接下來會一一進行分析。

2. 叢集容錯

在對叢集相關程式碼進行分析之前,這裡有必要先來介紹一下叢集容錯的所有元件。包含 Cluster、Cluster Invoker、Directory、Router 和 LoadBalance 等。

Dubbo原始碼解析之服務叢集

叢集工作過程可分為兩個階段,第一個階段是在服務消費者初始化期間,叢集 Cluster 實現類為服務消費者建立 Cluster Invoker 例項,即上圖中的 merge 操作。第二個階段是在服務消費者進行遠端呼叫時。以 FailoverClusterInvoker 為例,該型別 Cluster Invoker 首先會呼叫 Directory 的 list 方法列舉 Invoker 列表(可將 Invoker 簡單理解為服務提供者)。Directory 的用途是儲存 Invoker,可簡單類比為 List。其實現類 RegistryDirectory 是一個動態服務目錄,可感知註冊中心配置的變化,它所持有的 Inovker 列表會隨著註冊中心內容的變化而變化。每次變化後,RegistryDirectory 會動態增刪 Inovker,並呼叫 Router 的 route 方法進行路由,過濾掉不符合路由規則的 Invoker。當 FailoverClusterInvoker 拿到 Directory 返回的 Invoker 列表後,它會通過 LoadBalance 從 Invoker 列表中選擇一個 Inovker。最後 FailoverClusterInvoker 會將引數傳給 LoadBalance 選擇出的 Invoker 例項的 invoker 方法,進行真正的遠端呼叫。

以上就是叢集工作的整個流程,這裡並沒介紹叢集是如何容錯的。Dubbo 主要提供了這樣幾種容錯方式:

Failover Cluster - 失敗自動切換 Failfast Cluster - 快速失敗 Failsafe Cluster - 失敗安全 Failback Cluster - 失敗自動恢復 Forking Cluster - 並行呼叫多個服務提供者 下面開始分析原始碼。

3.原始碼分析

3.1 Cluster 實現類分析

我們在上一章看到了兩個概念,分別是叢集介面 Cluster 和 Cluster Invoker,這兩者是不同的。Cluster 是介面,而 Cluster Invoker 是一種 Invoker。服務提供者的選擇邏輯,以及遠端呼叫失敗後的的處理邏輯均是封裝在 Cluster Invoker 中。那麼 Cluster 介面和相關實現類有什麼用呢?用途比較簡單,僅用於生成 Cluster Invoker。下面我們來看一下原始碼。

public class FailoverCluster implements Cluster {

    public final static String NAME = "failover";

    @Override
    public <T> Invoker<T> join(Directory<T> directory) throws RpcException {
        // 建立並返回 FailoverClusterInvoker 物件
        return new FailoverClusterInvoker<T>(directory);
    }
}
複製程式碼

如上,FailoverCluster 總共就包含這幾行程式碼,用於建立 FailoverClusterInvoker 物件,很簡單。下面再看一個。

public class FailbackCluster implements Cluster {

    public final static String NAME = "failback";

    @Override
    public <T> Invoker<T> join(Directory<T> directory) throws RpcException {
        // 建立並返回 FailbackClusterInvoker 物件
        return new FailbackClusterInvoker<T>(directory);
    }

}
複製程式碼

如上,FailbackCluster 的邏輯也是很簡單,無需解釋了。所以接下來,我們把重點放在各種 Cluster Invoker 上

3.2 Cluster Invoker 分析

我們首先從各種 Cluster Invoker 的父類 AbstractClusterInvoker 原始碼開始說起。前面說過,叢集工作過程可分為兩個階段,第一個階段是在服務消費者初始化期間,這個在服務引用那篇文章中分析過,就不贅述。第二個階段是在服務消費者進行遠端呼叫時,此時 AbstractClusterInvoker 的 invoke 方法會被呼叫。列舉 Invoker,負載均衡等操作均會在此階段被執行。因此下面先來看一下 invoke 方法的邏輯。

public Result invoke(final Invocation invocation) throws RpcException {
    checkWhetherDestroyed();
    LoadBalance loadbalance = null;

    // 繫結 attachments 到 invocation 中.
    Map<String, String> contextAttachments = RpcContext.getContext().getAttachments();
    if (contextAttachments != null && contextAttachments.size() != 0) {
        ((RpcInvocation) invocation).addAttachments(contextAttachments);
    }

    // 列舉 Invoker
    List<Invoker<T>> invokers = list(invocation);
    if (invokers != null && !invokers.isEmpty()) {
        // 載入 LoadBalance
        loadbalance = ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(invokers.get(0).getUrl()
                .getMethodParameter(RpcUtils.getMethodName(invocation), Constants.LOADBALANCE_KEY, Constants.DEFAULT_LOADBALANCE));
    }
    RpcUtils.attachInvocationIdIfAsync(getUrl(), invocation);
    
    // 呼叫 doInvoke 進行後續操作
    return doInvoke(invocation, invokers, loadbalance);
}

// 抽象方法,由子類實現
protected abstract Result doInvoke(Invocation invocation, List<Invoker<T>> invokers,
                                       LoadBalance loadbalance) throws RpcException;
複製程式碼

AbstractClusterInvoker 的 invoke 方法主要用於列舉 Invoker,以及載入 LoadBalance。最後再呼叫模板方法 doInvoke 進行後續操作。下面我們來看一下 Invoker 列舉方法 list(Invocation) 的邏輯,如下:

protected List<Invoker<T>> list(Invocation invocation) throws RpcException {
    // 呼叫 Directory 的 list 方法列舉 Invoker
    List<Invoker<T>> invokers = directory.list(invocation);
    return invokers;
}
複製程式碼

如上,AbstractClusterInvoker 中的 list 方法做的事情很簡單,只是簡單的呼叫了 Directory 的 list 方法,沒有其他更多的邏輯了。Directory 即相關實現類在前文已經分析過,這裡就不多說了。接下來,我們把目光轉移到 AbstractClusterInvoker 的各種實現類上,來看一下這些實現類是如何實現 doInvoke 方法邏輯的。

3.2.1 FailoverClusterInvoker

FailoverClusterInvoker 在呼叫失敗時,會自動切換 Invoker 進行重試。預設確配置下,Dubbo 會使用這個類作為預設 Cluster Invoker。下面來看一下該類的邏輯。

public class FailoverClusterInvoker<T> extends AbstractClusterInvoker<T> {

    // 省略部分程式碼

    @Override
    public Result doInvoke(Invocation invocation, final List<Invoker<T>> invokers, LoadBalance loadbalance) throws RpcException {
        List<Invoker<T>> copyinvokers = invokers;
        checkInvokers(copyinvokers, invocation);
        // 獲取重試次數
        int len = getUrl().getMethodParameter(invocation.getMethodName(), Constants.RETRIES_KEY, Constants.DEFAULT_RETRIES) + 1;
        if (len <= 0) {
            len = 1;
        }
        RpcException le = null;
        List<Invoker<T>> invoked = new ArrayList<Invoker<T>>(copyinvokers.size());
        Set<String> providers = new HashSet<String>(len);
        // 迴圈呼叫,失敗重試
        for (int i = 0; i < len; i++) {
            if (i > 0) {
                checkWhetherDestroyed();
                // 在進行重試前重新列舉 Invoker,這樣做的好處是,如果某個服務掛了,
                // 通過呼叫 list 可得到最新可用的 Invoker 列表
                copyinvokers = list(invocation);
                // 對 copyinvokers 進行判空檢查
                checkInvokers(copyinvokers, invocation);
            }

            // 通過負載均衡選擇 Invoker
            Invoker<T> invoker = select(loadbalance, invocation, copyinvokers, invoked);
            // 新增到 invoker 到 invoked 列表中
            invoked.add(invoker);
            // 設定 invoked 到 RPC 上下文中
            RpcContext.getContext().setInvokers((List) invoked);
            try {
                // 呼叫目標 Invoker 的 invoke 方法
                Result result = invoker.invoke(invocation);
                return result;
            } catch (RpcException e) {
                if (e.isBiz()) {
                    throw e;
                }
                le = e;
            } catch (Throwable e) {
                le = new RpcException(e.getMessage(), e);
            } finally {
                providers.add(invoker.getUrl().getAddress());
            }
        }
        
        // 若重試失敗,則丟擲異常
        throw new RpcException(..., "Failed to invoke the method ...");
    }
}
複製程式碼

如上,FailoverClusterInvoker 的 doInvoke 方法首先是獲取重試次數,然後根據重試次數進行迴圈呼叫,失敗後進行重試。在 for 迴圈內,首先是通過負載均衡元件選擇一個 Invoker,然後再通過這個 Invoker 的 invoke 方法進行遠端呼叫。如果失敗了,記錄下異常,並進行重試。重試時會再次呼叫父類的 list 方法列舉 Invoker。整個流程大致如此,不是很難理解。下面我們看一下 select 方法的邏輯。

protected Invoker<T> select(LoadBalance loadbalance, Invocation invocation, List<Invoker<T>> invokers, List<Invoker<T>> selected) throws RpcException {
    if (invokers == null || invokers.isEmpty())
        return null;
    // 獲取呼叫方法名
    String methodName = invocation == null ? "" : invocation.getMethodName();

    // 獲取 sticky 配置,sticky 表示粘滯連線。所謂粘滯連線是指讓服務消費者儘可能的
    // 呼叫同一個服務提供者,除非該提供者掛了再進行切換
    boolean sticky = invokers.get(0).getUrl().getMethodParameter(methodName, Constants.CLUSTER_STICKY_KEY, Constants.DEFAULT_CLUSTER_STICKY);
    {
        // 檢測 invokers 列表是否包含 stickyInvoker,如果不包含,
        // 說明 stickyInvoker 代表的服務提供者掛了,此時需要將其置空
        if (stickyInvoker != null && !invokers.contains(stickyInvoker)) {
            stickyInvoker = null;
        }
        
        // 在 sticky 為 true,且 stickyInvoker != null 的情況下。如果 selected 包含 
        // stickyInvoker,表明 stickyInvoker 對應的服務提供者可能因網路原因未能成功提供服務。
        // 但是該提供者並沒掛,此時 invokers 列表中仍存在該服務提供者對應的 Invoker。
        if (sticky && stickyInvoker != null && (selected == null || !selected.contains(stickyInvoker))) {
            // availablecheck 表示是否開啟了可用性檢查,如果開啟了,則呼叫 stickyInvoker 的 
            // isAvailable 方法進行檢查,如果檢查通過,則直接返回 stickyInvoker。
            if (availablecheck && stickyInvoker.isAvailable()) {
                return stickyInvoker;
            }
        }
    }
    
    // 如果執行緒走到當前程式碼處,說明前面的 stickyInvoker 為空,或者不可用。
    // 此時繼續呼叫 doSelect 選擇 Invoker
    Invoker<T> invoker = doSelect(loadbalance, invocation, invokers, selected);

    // 如果 sticky 為 true,則將負載均衡元件選出的 Invoker 賦值給 stickyInvoker
    if (sticky) {
        stickyInvoker = invoker;
    }
    return invoker;
}
複製程式碼

如上,select 方法的主要邏輯集中在了對粘滯連線特性的支援上。首先是獲取 sticky 配置,然後再檢測 invokers 列表中是否包含 stickyInvoker,如果不包含,則認為該 stickyInvoker 不可用,此時將其置空。這裡的 invokers 列表可以看做是存活著的服務提供者列表,如果這個列表不包含 stickyInvoker,那自然而然的認為 stickyInvoker 掛了,所以置空。如果 stickyInvoker 存在於 invokers 列表中,此時要進行下一項檢測 — 檢測 selected 中是否包含 stickyInvoker。如果包含的話,說明 stickyInvoker 在此之前沒有成功提供服務(但其仍然處於存活狀態)。此時我們認為這個服務不可靠,不應該在重試期間內再次被呼叫,因此這個時候不會返回該 stickyInvoker。如果 selected 不包含 stickyInvoker,此時還需要進行可用性檢測,比如檢測服務提供者網路連通性等。當可用性檢測通過,才可返回 stickyInvoker,否則呼叫 doSelect 方法選擇 Invoker。如果 sticky 為 true,此時會將 doSelect 方法選出的 Invoker 賦值給 stickyInvoker。

以上就是 select 方法的邏輯,這段邏輯看起來不是很複雜,但是資訊量比較大。不搞懂 invokers 和 selected 兩個入參的含義,以及粘滯連線特性,這段程式碼是不容易看懂的。所以大家在閱讀這段程式碼時,不要忽略了對背景知識的理解。關於 select 方法先分析這麼多,繼續向下分析。

private Invoker<T> doSelect(LoadBalance loadbalance, Invocation invocation, List<Invoker<T>> invokers, List<Invoker<T>> selected) throws RpcException {
    if (invokers == null || invokers.isEmpty())
        return null;
    if (invokers.size() == 1)
        return invokers.get(0);
    if (loadbalance == null) {
        // 如果 loadbalance 為空,這裡通過 SPI 載入 Loadbalance,預設為 RandomLoadBalance
        loadbalance = ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(Constants.DEFAULT_LOADBALANCE);
    }
    
    // 通過負載均衡元件選擇 Invoker
    Invoker<T> invoker = loadbalance.select(invokers, getUrl(), invocation);

	// 如果 selected 包含負載均衡選擇出的 Invoker,或者該 Invoker 無法經過可用性檢查,此時進行重選
    if ((selected != null && selected.contains(invoker))
            || (!invoker.isAvailable() && getUrl() != null && availablecheck)) {
        try {
            // 進行重選
            Invoker<T> rinvoker = reselect(loadbalance, invocation, invokers, selected, availablecheck);
            if (rinvoker != null) {
                // 如果 rinvoker 不為空,則將其賦值給 invoker
                invoker = rinvoker;
            } else {
                // rinvoker 為空,定位 invoker 在 invokers 中的位置
                int index = invokers.indexOf(invoker);
                try {
                    // 獲取 index + 1 位置處的 Invoker,以下程式碼等價於:
                    //     invoker = invokers.get((index + 1) % invokers.size());
                    invoker = index < invokers.size() - 1 ? invokers.get(index + 1) : invokers.get(0);
                } catch (Exception e) {
                    logger.warn("... may because invokers list dynamic change, ignore.");
                }
            }
        } catch (Throwable t) {
            logger.error("cluster reselect fail reason is : ...");
        }
    }
    return invoker;
}
複製程式碼

doSelect 主要做了兩件事,第一是通過負載均衡元件選擇 Invoker。第二是,如果選出來的 Invoker 不穩定,或不可用,此時需要呼叫 reselect 方法進行重選。若 reselect 選出來的 Invoker 為空,此時定位 invoker 在 invokers 列表中的位置 index,然後獲取 index + 1 處的 invoker,這也可以看做是重選邏輯的一部分。下面我們來看一下 reselect 方法的邏輯。

private Invoker<T> reselect(LoadBalance loadbalance, Invocation invocation,
    List<Invoker<T>> invokers, List<Invoker<T>> selected, boolean availablecheck) throws RpcException {

    List<Invoker<T>> reselectInvokers = new ArrayList<Invoker<T>>(invokers.size() > 1 ? (invokers.size() - 1) : invokers.size());

    // 下面的 if-else 分支邏輯有些冗餘,pull request #2826 對這段程式碼進行了簡化,可以參考一下
    // 根據 availablecheck 進行不同的處理
    if (availablecheck) {
        // 遍歷 invokers 列表
        for (Invoker<T> invoker : invokers) {
            // 檢測可用性
            if (invoker.isAvailable()) {
                // 如果 selected 列表不包含當前 invoker,則將其新增到 reselectInvokers 中
                if (selected == null || !selected.contains(invoker)) {
                    reselectInvokers.add(invoker);
                }
            }
        }
        
        // reselectInvokers 不為空,此時通過負載均衡元件進行選擇
        if (!reselectInvokers.isEmpty()) {
            return loadbalance.select(reselectInvokers, getUrl(), invocation);
        }

    // 不檢查 Invoker 可用性
    } else {
        for (Invoker<T> invoker : invokers) {
            // 如果 selected 列表不包含當前 invoker,則將其新增到 reselectInvokers 中
            if (selected == null || !selected.contains(invoker)) {
                reselectInvokers.add(invoker);
            }
        }
        if (!reselectInvokers.isEmpty()) {
            // 通過負載均衡元件進行選擇
            return loadbalance.select(reselectInvokers, getUrl(), invocation);
        }
    }

    {
        // 若執行緒走到此處,說明 reselectInvokers 集合為空,此時不會呼叫負載均衡元件進行篩選。
        // 這裡從 selected 列表中查詢可用的 Invoker,並將其新增到 reselectInvokers 集合中
        if (selected != null) {
            for (Invoker<T> invoker : selected) {
                if ((invoker.isAvailable())
                        && !reselectInvokers.contains(invoker)) {
                    reselectInvokers.add(invoker);
                }
            }
        }
        if (!reselectInvokers.isEmpty()) {
            // 再次進行選擇,並返回選擇結果
            return loadbalance.select(reselectInvokers, getUrl(), invocation);
        }
    }
    return null;
}
複製程式碼

reselect 方法總結下來其實只做了兩件事情,第一是查詢可用的 Invoker,並將其新增到 reselectInvokers 集合中。第二,如果 reselectInvokers 不為空,則通過負載均衡元件再次進行選擇。其中第一件事情又可進行細分,一開始,reselect 從 invokers 列表中查詢有效可用的 Invoker,若未能找到,此時再到 selected 列表中繼續查詢。關於 reselect 方法就先分析到這,繼續分析其他的 Cluster Invoker。

3.2.2 FailbackClusterInvoker

FailbackClusterInvoker 會在呼叫失敗後,返回一個空結果給服務提供者。並通過定時任務對失敗的呼叫進行重傳,適合執行訊息通知等操作。下面來看一下它的實現邏輯。

public class FailbackClusterInvoker<T> extends AbstractClusterInvoker<T> {

    private static final long RETRY_FAILED_PERIOD = 5 * 1000;

    private final ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(2,
            new NamedInternalThreadFactory("failback-cluster-timer", true));

    private final ConcurrentMap<Invocation, AbstractClusterInvoker<?>> failed = new ConcurrentHashMap<Invocation, AbstractClusterInvoker<?>>();
    private volatile ScheduledFuture<?> retryFuture;

    @Override
    protected Result doInvoke(Invocation invocation, List<Invoker<T>> invokers, LoadBalance loadbalance) throws RpcException {
        try {
            checkInvokers(invokers, invocation);
            // 選擇 Invoker
            Invoker<T> invoker = select(loadbalance, invocation, invokers, null);
            // 進行呼叫
            return invoker.invoke(invocation);
        } catch (Throwable e) {
            // 如果呼叫過程中發生異常,此時僅列印錯誤日誌,不丟擲異常
            logger.error("Failback to invoke method ...");
            
            // 記錄呼叫資訊
            addFailed(invocation, this);
            // 返回一個空結果給服務消費者
            return new RpcResult();
        }
    }

    private void addFailed(Invocation invocation, AbstractClusterInvoker<?> router) {
        if (retryFuture == null) {
            synchronized (this) {
                if (retryFuture == null) {
                    // 建立定時任務,每隔5秒執行一次
                    retryFuture = scheduledExecutorService.scheduleWithFixedDelay(new Runnable() {

                        @Override
                        public void run() {
                            try {
                                // 對失敗的呼叫進行重試
                                retryFailed();
                            } catch (Throwable t) {
                                // 如果發生異常,僅列印異常日誌,不丟擲
                                logger.error("Unexpected error occur at collect statistic", t);
                            }
                        }
                    }, RETRY_FAILED_PERIOD, RETRY_FAILED_PERIOD, TimeUnit.MILLISECONDS);
                }
            }
        }
        
        // 新增 invocation 和 invoker 到 failed 中
        failed.put(invocation, router);
    }

    void retryFailed() {
        if (failed.size() == 0) {
            return;
        }
        
        // 遍歷 failed,對失敗的呼叫進行重試
        for (Map.Entry<Invocation, AbstractClusterInvoker<?>> entry : new HashMap<Invocation, AbstractClusterInvoker<?>>(failed).entrySet()) {
            Invocation invocation = entry.getKey();
            Invoker<?> invoker = entry.getValue();
            try {
                // 再次進行呼叫
                invoker.invoke(invocation);
                // 呼叫成功後,從 failed 中移除 invoker
                failed.remove(invocation);
            } catch (Throwable e) {
                // 僅列印異常,不丟擲
                logger.error("Failed retry to invoke method ...");
            }
        }
    }
}
複製程式碼

這個類主要由3個方法組成,首先是 doInvoker,該方法負責初次的遠端呼叫。若遠端呼叫失敗,則通過 addFailed 方法將呼叫資訊存入到 failed 中,等待定時重試。addFailed 在開始階段會根據 retryFuture 為空與否,來決定是否開啟定時任務。retryFailed 方法則是包含了失敗重試的邏輯,該方法會對 failed 進行遍歷,然後依次對 Invoker 進行呼叫。呼叫成功則將 Invoker 從 failed 中移除,呼叫失敗則忽略失敗原因。

以上就是 FailbackClusterInvoker 的執行邏輯,不是很複雜,繼續往下看。

3.2.3 FailfastClusterInvoker

FailfastClusterInvoker 只會進行一次呼叫,失敗後立即丟擲異常。適用於冪等操作,比如新增記錄。原始碼如下:

public class FailfastClusterInvoker<T> extends AbstractClusterInvoker<T> {

    @Override
    public Result doInvoke(Invocation invocation, List<Invoker<T>> invokers, LoadBalance loadbalance) throws RpcException {
        checkInvokers(invokers, invocation);
        // 選擇 Invoker
        Invoker<T> invoker = select(loadbalance, invocation, invokers, null);
        try {
            // 呼叫 Invoker
            return invoker.invoke(invocation);
        } catch (Throwable e) {
            if (e instanceof RpcException && ((RpcException) e).isBiz()) {
                // 丟擲異常
                throw (RpcException) e;
            }
            // 丟擲異常
            throw new RpcException(..., "Failfast invoke providers ...");
        }
    }
}
複製程式碼

如上,首先是通過 select 方法選擇 Invoker,然後進行遠端呼叫。如果呼叫失敗,則立即丟擲異常。FailfastClusterInvoker 就先分析到這,下面分析 FailsafeClusterInvoker。

3.2.4 FailsafeClusterInvoker

FailsafeClusterInvoker 是一種失敗安全的 Cluster Invoker。所謂的失敗安全是指,當呼叫過程中出現異常時,FailsafeClusterInvoker 僅會列印異常,而不會丟擲異常。適用於寫入審計日誌等操作。下面分析原始碼。

public class FailsafeClusterInvoker extends AbstractClusterInvoker {

@Override
public Result doInvoke(Invocation invocation, List<Invoker<T>> invokers, LoadBalance loadbalance) throws RpcException {
    try {
        checkInvokers(invokers, invocation);
        // 選擇 Invoker
        Invoker<T> invoker = select(loadbalance, invocation, invokers, null);
        // 進行遠端呼叫
        return invoker.invoke(invocation);
    } catch (Throwable e) {
		// 列印錯誤日誌,但不丟擲
        logger.error("Failsafe ignore exception: " + e.getMessage(), e);
        // 返回空結果忽略錯誤
        return new RpcResult();
    }
}
複製程式碼

} FailsafeClusterInvoker 的邏輯和 FailfastClusterInvoker 的邏輯一樣簡單,無需過多說明。繼續向下分析。

3.2.5 ForkingClusterInvoker

ForkingClusterInvoker 會在執行時通過執行緒池建立多個執行緒,併發呼叫多個服務提供者。只要有一個服務提供者成功返回了結果,doInvoke 方法就會立即結束執行。ForkingClusterInvoker 的應用場景是在一些對實時性要求比較高讀操作(注意是讀操作,並行寫操作可能不安全)下使用,但這將會耗費更多的資源。下面來看該類的實現。

public class ForkingClusterInvoker<T> extends AbstractClusterInvoker<T> {
    
    private final ExecutorService executor = Executors.newCachedThreadPool(
            new NamedInternalThreadFactory("forking-cluster-timer", true));

    @Override
    public Result doInvoke(final Invocation invocation, List<Invoker<T>> invokers, LoadBalance loadbalance) throws RpcException {
        try {
            checkInvokers(invokers, invocation);
            final List<Invoker<T>> selected;
            // 獲取 forks 配置
            final int forks = getUrl().getParameter(Constants.FORKS_KEY, Constants.DEFAULT_FORKS);
            // 獲取超時配置
            final int timeout = getUrl().getParameter(Constants.TIMEOUT_KEY, Constants.DEFAULT_TIMEOUT);
            // 如果 forks 配置不合理,則直接將 invokers 賦值給 selected
            if (forks <= 0 || forks >= invokers.size()) {
                selected = invokers;
            } else {
                selected = new ArrayList<Invoker<T>>();
                // 迴圈選出 forks 個 Invoker,並新增到 selected 中
                for (int i = 0; i < forks; i++) {
                    // 選擇 Invoker
                    Invoker<T> invoker = select(loadbalance, invocation, invokers, selected);
                    if (!selected.contains(invoker)) {
                        selected.add(invoker);
                    }
                }
            }
            
            // ----------------------✨ 分割線1 ✨---------------------- //
            
            RpcContext.getContext().setInvokers((List) selected);
            final AtomicInteger count = new AtomicInteger();
            final BlockingQueue<Object> ref = new LinkedBlockingQueue<Object>();
            // 遍歷 selected 列表
            for (final Invoker<T> invoker : selected) {
                // 為每個 Invoker 建立一個執行執行緒
                executor.execute(new Runnable() {
                    @Override
                    public void run() {
                        try {
                            // 進行遠端呼叫
                            Result result = invoker.invoke(invocation);
                            // 將結果存到阻塞佇列中
                            ref.offer(result);
                        } catch (Throwable e) {
                            int value = count.incrementAndGet();
                            // 僅在 value 大於等於 selected.size() 時,才將異常物件
                            // 放入阻塞佇列中,請大家思考一下為什麼要這樣做。
                            if (value >= selected.size()) {
                                // 將異常物件存入到阻塞佇列中
                                ref.offer(e);
                            }
                        }
                    }
                });
            }
            
            // ----------------------✨ 分割線2 ✨---------------------- //
            
            try {
                // 從阻塞佇列中取出遠端呼叫結果
                Object ret = ref.poll(timeout, TimeUnit.MILLISECONDS);
                
                // 如果結果型別為 Throwable,則丟擲異常
                if (ret instanceof Throwable) {
                    Throwable e = (Throwable) ret;
                    throw new RpcException(..., "Failed to forking invoke provider ...");
                }
                
                // 返回結果
                return (Result) ret;
            } catch (InterruptedException e) {
                throw new RpcException("Failed to forking invoke provider ...");
            }
        } finally {
            RpcContext.getContext().clearAttachments();
        }
    }
}
複製程式碼

ForkingClusterInvoker 的 doInvoker 方法比較長,這裡通過兩個分割線將整個方法劃分為三個邏輯塊。從方法開始到分割線1之間的程式碼主要是用於選出 forks 個 Invoker,為接下來的併發呼叫提供輸入。分割線1和分割線2之間的邏輯通過執行緒池併發呼叫多個 Invoker,並將結果儲存在阻塞佇列中。分割線2到方法結尾之間的邏輯主要用於從阻塞佇列中獲取返回結果,並對返回結果型別進行判斷。如果為異常型別,則直接丟擲,否則返回。

以上就是ForkingClusterInvoker 的 doInvoker 方法大致過程。我們在分割線1和分割線2之間的程式碼上留了一個問題,問題是這樣的:為什麼要在value >= selected.size()的情況下,才將異常物件新增到阻塞佇列中?這裡來解答一下。原因是這樣的,在並行呼叫多個服務提供者的情況下,只要有一個服務提供者能夠成功返回結果,而其他全部失敗。此時 ForkingClusterInvoker 仍應該返回成功的結果,而非丟擲異常。在value >= selected.size()時將異常物件放入阻塞佇列中,可以保證異常物件不會出現在正常結果的前面,這樣可從阻塞佇列中優先取出正常的結果。

關於 ForkingClusterInvoker 就先分析到這,接下來分析最後一個 Cluster Invoker。

3.2.6 BroadcastClusterInvoker

本章的最後,我們再來看一下 BroadcastClusterInvoker。BroadcastClusterInvoker 會逐個呼叫每個服務提供者,如果其中一臺報錯,在迴圈呼叫結束後,BroadcastClusterInvoker 會丟擲異常。該類通常用於通知所有提供者更新快取或日誌等本地資源資訊。原始碼如下。

public class BroadcastClusterInvoker extends AbstractClusterInvoker {

@Override
public Result doInvoke(final Invocation invocation, List<Invoker<T>> invokers, LoadBalance loadbalance) throws RpcException {
    checkInvokers(invokers, invocation);
    RpcContext.getContext().setInvokers((List) invokers);
    RpcException exception = null;
    Result result = null;
    // 遍歷 Invoker 列表,逐個呼叫
    for (Invoker<T> invoker : invokers) {
        try {
            // 進行遠端呼叫
            result = invoker.invoke(invocation);
        } catch (RpcException e) {
            exception = e;
            logger.warn(e.getMessage(), e);
        } catch (Throwable e) {
            exception = new RpcException(e.getMessage(), e);
            logger.warn(e.getMessage(), e);
        }
    }
    
    // exception 不為空,則丟擲異常
    if (exception != null) {
        throw exception;
    }
    return result;
}
複製程式碼

}

以上就是 BroadcastClusterInvoker 的程式碼,比較簡單,就不多說了。

4.總結

本篇文章詳細分析了叢集容錯的幾種實現方式。叢集容錯對於 Dubbo 框架來說,是很重要的邏輯。叢集模組處於服務提供者和消費者之間,對於服務消費者來說,叢集可向其遮蔽服務提供者叢集的情況,使其能夠專心進行遠端呼叫。除此之外,通過叢集模組,我們還可以對服務之間的呼叫鏈路進行編排優化,治理服務。總的來說,對於 Dubbo 而言,叢集容錯相關邏輯是非常重要的。想要對 Dubbo 有比較深的理解,叢集容錯是必須要掌握的。

歡迎大家加入Java高階架構群 378461078

相關文章