2. 程式人生 > >【Dubbo 源碼解析】02_Dubbo SPI

【Dubbo 源碼解析】02_Dubbo SPI

阿新 • • 發佈：2019-02-01
小寫 throw 擴展點 作用 http bstr zh-cn line isa

Dubbo SPI:（version:2.6.*）

Dubbo 微內核 + 插件 模式，得益於 Dubbo SPI 。其中 ExtentionLoader是 Dubbo SPI 最核心的類，它負責擴展點的加載和生命周期管理。

ExtensionLoader

ExtensionLoader 類似於 Java SPI 的 ServiceLoader，負責擴展的加載和生命周期維護，它是 Dubbo SPI 最核心的類。

使用最頻繁的 API 有如下幾個：

  • public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type)

    -- 獲取 type 類對應的 ExtensionLoader

  • public T getAdaptiveExtension()

    -- 獲取擴展自適應實例（擴展適配器）。擴展點適配器的實現中，一般會調用下面的 API 來獲取指定的擴展點實例

    warn: dubbo 中大多數的擴展實例，都是通過擴展點匹配器 AdaptiveExtension 來獲取的

  • public T getExtension(String name)

    -- 根據 name 獲取指定的擴展實例

  • public T getDefaultExtension()

    -- 獲取 @SPI value 中指定的默認擴展點

  • public List<T> getActivateExtension(URL url, String key)

    -- 獲取被激活的擴展點集合

舉例：

  • Protocol refprotocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension(); -- 獲取擴展點適配器。擴展點適配器實現類中會調用下面的代碼來獲取指定的擴展點實例

  • Protocol extension = (Protocol)ExtensionLoader.getExtensionLoader(Protocol.class).getExtension(extName); -- 獲取指定的擴展點

  • Protocol extension = (Protocol)ExtensionLoader.getExtensionLoader(Protocol.class).getDefaultExtension(); -- 獲取 @SPI value 中指定的默認擴展點

  • ExtensionLoader.getExtensionLoader(ExporterListener.class).getActivateExtension(invoker.getUrl(), Constants.EXPORTER_LISTENER_KEY)) -- 獲取被激活的擴展點集合

Dubbo 擴展點機制基本概念

  • 擴展點(Extension Point)

    是一個Java的接口。

  • 擴展(Extension)

    擴展點的實現類。

  • 擴展實例(Extension Instance)

    擴展點實現類的實例。

  • 擴展自適應實例(Extension Adaptive Instance)

    擴展適配器。擴展適配器實例就是一個 Extension 的代理，它實現了擴展點接口。在調用擴展點的接口方法時，會根據實際的參數來決定要使用哪個擴展。

  • @SPI

    @SPI 註解作用於擴展點的接口上，表明該接口是一個擴展點，可以被 Dubbo 的ExtentionLoader 加載。如果沒有此註解的話， ExtensionLoader.getExtensionLoader(type) 調用會異常。

  • @Adaptive

    1. @Adaptive 註解使用在類上，表示這個類是一個擴展適配器。當調用 ExtensionLoader.getExtensionLoader(type).getAdaptiveExtension() 會獲取到該擴展適配器的實例。

    2. @Adaptive 註解使用在方法上，表示該方法是一個適配（自適應）方法。Dubbo 在為擴展點生成擴展適配器時，如果方法上有 @Adaptive 註解，會為該方法生成對應的實現。實現方法內部會根據方法的參數，來決定使用哪個擴展。

舉例： 以 com.alibaba.dubbo.rpc.Protocol 為例

@SPI("dubbo")
public interface Protocol {
    int getDefaultPort();
    
    @Adaptive
    <T> Exporter<T> export(Invoker<T> invoker) throws RpcException;
    
    @Adaptive
    <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException;
    
    void destroy();
}

Protocol 類上有 @SPI("dubbo")， 含有 4 個方法，其中有 2 個有 @Adaptive 註解。

  1. @SPI("dubbo")

    @SPI 表示 Protocol 是一個擴展點。如果 Protocol 類上沒有 @SPI 註解的話，試圖去加載擴展時，會拋出異常。

    "dubbo" 表示 Protocol 的默認擴展點的名稱是 "dubbo"

  2. @Adaptive

    這裏 @Adaptive 用在方法上，表示 export() 與 refer() 方法都是適配方法，Dubbo 會自動為該方法生成適配實現。

    而 getDefaultPort() 和 destroy() 方法上沒有 @Adaptive 註解，則 Dubbo 在自動生成擴展適配器時，會讓這類方法拋出異常。

說明：

  • Dubbo 自動生成擴展實現的代碼參考 ExtensionLoader#createAdaptiveExtensionClassCode() 方法

    通過閱讀源碼，我們可以發現，Dubbo 是通過擴展點適配器在運行時動態選擇擴展點實現的，而動態選擇的策略是通過 URL 中的參數來決定的。

  • Duubo 為 Protocol 生成的擴展點適配器（Protocol$Adaptive.class）的代碼如下：

package com.alibaba.dubbo.rpc;
?
import com.alibaba.dubbo.common.extension.ExtensionLoader;
?
public class Protocol$Adaptive implements com.alibaba.dubbo.rpc.Protocol {
    public void destroy() {
        throw new UnsupportedOperationException("method public abstract void com.alibaba.dubbo.rpc.Protocol.destroy() of interface com.alibaba.dubbo.rpc.Protocol is not adaptive method!");
    }
?
    public int getDefaultPort() {
        throw new UnsupportedOperationException("method public abstract int com.alibaba.dubbo.rpc.Protocol.getDefaultPort() of interface com.alibaba.dubbo.rpc.Protocol is not adaptive method!");
    }
?
    public com.alibaba.dubbo.rpc.Exporter export(com.alibaba.dubbo.rpc.Invoker arg0) throws com.alibaba.dubbo.rpc.RpcException {
        if (arg0 == null) throw new IllegalArgumentException("com.alibaba.dubbo.rpc.Invoker argument == null");
        if (arg0.getUrl() == null)
            throw new IllegalArgumentException("com.alibaba.dubbo.rpc.Invoker argument getUrl() == null");
        com.alibaba.dubbo.common.URL url = arg0.getUrl();
        String extName = (url.getProtocol() == null ? "dubbo" : url.getProtocol());
        if (extName == null)
            throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.Protocol) name from url(" + url.toString() + ") use keys([protocol])");
        com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol) ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName);
        return extension.export(arg0);
    }
?
    public com.alibaba.dubbo.rpc.Invoker refer(java.lang.Class arg0, com.alibaba.dubbo.common.URL arg1) throws com.alibaba.dubbo.rpc.RpcException {
        if (arg1 == null) throw new IllegalArgumentException("url == null");
        com.alibaba.dubbo.common.URL url = arg1;
        String extName = (url.getProtocol() == null ? "dubbo" : url.getProtocol());
        if (extName == null)
            throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.Protocol) name from url(" + url.toString() + ") use keys([protocol])");
        com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol) ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName);
        return extension.refer(arg0, arg1);
    }
}

源碼分析

根據代碼 ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension() 來分析 SPI 的加載過程：

#getExtensionLoader(Protocol.class)

  1. new 出一個 ExtensionLoader，並將 Protocol.class 賦值給成員變量 type

#getAdaptiveExtension() 獲取 SPI 擴展點適配器

#getExtensionClasses() 首先加載 type 類相關的所有擴展點實例

  1. 獲取 Protocol.class 上的 @SPI 註解，如果 value() 有且只有一個值，就將值存放到 cachedDefaultName 中；如果沒有值，就跳過。 cachedDefaultName 就是 @SPI 默認實現的擴展點 name

  2. 按目錄順序加載 SPI 擴展文件，擴展文件名為：com.alibaba.dubbo.rpc.Protocol 目錄順序為： META-INF/dubbo/internal/ META-INF/dubbo/ META-INF/services/

  3. 依次讀取文件中的內容，內容格式有兩種：kv格式 和 v 格式 dubbo=com.alibaba.dubbo.rpc.protocol.dubbo.DubboProtocol com.alibaba.dubbo.rpc.protocol.http.HttpProtocol k: 擴展點的 name （name 有多個值的話，用逗號","隔開） v: 擴展點對應的 class

a. 如果 v 類上有 @Adaptive 註解，就將 v 賦值給 cachedAdaptiveClass ? b. 如果 v 類是裝飾類，那麽就將 v 添加到 cachedWrapperClasses 中 ? 裝飾類：v 類含有一個參數的構造函數，且這個參數為 SPI 接口 type，這裏為 Protocol.class ? clazz.getConstructor(type); ? c. 如果前端的情況都不滿足，且 v 有默認的構造函數 ? 則檢查擴展點的 name 是否有值，沒有值的話就，取 v 上的 @Extension 註解的 value()；沒有 @Extension 註解，就取 v 類的簡稱的小寫（simpleName - type.simpleName） ? 獲取 v 類上的 @Activate 註解，有值的話就存放到 cachedActivates 裏面（cachedActivates.put(names[0], activate)，@Activate 是用來激活指定的擴展點的） ? 將 v 緩存到 cachedNames 中 （cachedNames.put(clazz, name)） ? 將 v 緩存到 cachedClasses 中 （extensionClasses.put(name, clazz)）

#createAdaptiveExtensionClass()

  1. 經過上面的加載過程，如果 cachedAdaptiveClass 有值，就返回。沒有的話，就使用字節碼技術動態創建一個擴展點匹配器 AdaptiveExtensionClass 返回。（絕大部分的 SPI 擴展點匹配器 AdaptiveExtension 的創建方式） 以 Protocol.class 為例，動態創建出的擴展點適配器的類名為 Protocol$Adaptive

  2. 將獲取到的擴展點匹配器實例 instance 存放到 cachedAdaptiveInstance 中並返回

#getExtension(name) 按名稱 name 去獲取擴展點

  1. 先按照上面 2-4 的步驟加載 SPI 擴展文件

  2. 從 cachedClasses 中獲取擴展類 v （getExtensionClasses().get(name)）

  3. 通過反射創建擴展點實例 instance （clazz.newInstance()），並將實例放到緩存 EXTENSION_INSTANCES 中 （EXTENSION_INSTANCES.putIfAbsent(clazz, clazz.newInstance())）

  4. injectExtension() 註入擴展點實例 instance 依賴的擴展點 【IoC】 a. 拿到 instance 類的 set 方法。set 方法需要是 public 且只有一個入參 b. 通過 set 方法的名稱反推出擴展點的名字 name c. 通過 ExtensionFactory 獲取到 type + name 的擴展點（objectFactory.getExtension(pt, property)，pt 為 set 方法的入參 class 類型，property 為擴展點的 name） d. 通過反射註入依賴的擴展點（method.invoke(instance, object)）

  5. 將所有的 cachedWrapperClasses 包裝在 instance 上，並按照 4 的流程註入 wrapperClass 實例依賴的擴展點 【AOP】

附：

  • 獲取 SPI 擴展點有兩種方式：

  1. 先獲取擴展點適配器，然後在方法調用時，擴展點適配器會動態路由到指定的擴展點去調用

  2. 通過 getExtension(name) 或者 getDefaultExtension() 方法直接獲取 以 Protocol.class 為例，dubbo 在暴露一個服務的時候，會調用 Protocol#export(Invoker<T> invoker) 方法。 具體它是先獲取擴展點適配器 Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension()，然後再通過擴展點適配器去調用 export(Invoker<T> invoker) 方法。 而擴展點適配器 Protocol$Adaptive.class 的 export(Invoker<T> invoker) 方法則是根據 invoker 中指定的擴展點名稱 extName 去調用指定擴展點的 export(Invoker<T> invoker) 方法

  • #getActivateExtension(URL url, String key, String group) 獲取激活的擴展點列表

public List<T> getActivateExtension(URL url, String[] values, String group) {
    List<T> exts = new ArrayList<T>();
    List<String> names = values == null ? new ArrayList<String>(0) : Arrays.asList(values);
    // 添加框架默認激活的擴展點
    if (!names.contains(Constants.REMOVE_VALUE_PREFIX + Constants.DEFAULT_KEY)) {
        getExtensionClasses();
        for (Map.Entry<String, Activate> entry : cachedActivates.entrySet()) {
            String name = entry.getKey();
            Activate activate = entry.getValue();
            if (isMatchGroup(group, activate.group())) {
                T ext = getExtension(name);
                if (!names.contains(name) /* 添加默認激活的擴展點，需要排除指定激活的 */
                        && !names.contains(Constants.REMOVE_VALUE_PREFIX + name)
                        && isActive(activate, url)) {
                    exts.add(ext);
                }
            }
        }
        Collections.sort(exts, ActivateComparator.COMPARATOR);
    }
    
    // 添加 url 中指定激活的擴展點
    List<T> usrs = new ArrayList<T>();
    for (int i = 0; i < names.size(); i++) {
        String name = names.get(i);
        if (!name.startsWith(Constants.REMOVE_VALUE_PREFIX)
                && !names.contains(Constants.REMOVE_VALUE_PREFIX + name)) {
            if (Constants.DEFAULT_KEY.equals(name)) {
                if (!usrs.isEmpty()) {
                    exts.addAll(0, usrs);
                    usrs.clear();
                }
            } else {
                T ext = getExtension(name);
                usrs.add(ext);
            }
        }
    }
    if (!usrs.isEmpty()) {
        exts.addAll(usrs);
    }
    return exts;
}

參考：

@see: http://dubbo.apache.org/zh-cn/blog/introduction-to-dubbo-spi.html

@see: http://dubbo.apache.org/zh-cn/blog/introduction-to-dubbo-spi-2.html

【Dubbo 源碼解析】02_Dubbo SPI

相關推薦

【Dubbo 源碼解析】02_Dubbo SPI

小寫 throw 擴展點 作用 http bstr zh-cn line isa Dubbo SPI:（version:2.6.*） Dubbo 微內核 + 插件 模式，得益於 Dubbo SPI 。其中 ExtentionLoader是 Dubbo SPI 最核心的類，

【Dubbo 源碼解析】01_Dubbo 設計簡介

toc inf 參數 遠程 lin d-link jpg prot 定義 Dubbo 設計簡介 Dubbo 采用 Microkernel + Plugin （微內核 + 插件）模式，Microkernel 只負責組裝 Plugin，Dubbo 自身的功能也是通過擴展點實現

【Dubbo 源碼解析】06_Dubbo 服務調用

阻塞 發現 cluster iss 長連接 lean NPU void lib Dubbo 服務調用 根據上圖，可以看出，服務調用過程為： Consumer 端的 Proxy 調用 Cluster 層選擇集群中的某一個 Invoker（負載均衡）

【Dubbo 源碼解析】07_Dubbo 重試機制

version ast 查看 error enabled pre div set time Dubbo 重試機制 通過前面 Dubbo 服務發現&引用 的分析，我們知道，Dubbo 的重試機制是通過 com.alibaba.dubbo.rpc.cluster.su

【JUC源碼解析】ConcurrentLinkedQueue

阻塞 操作 turn == 技術 next .com 源碼解析 否則 簡介 ConcurrentLinkedQueue是一個基於鏈表結點的無界線程安全隊列。 概述 隊列順序，為FIFO(first-in-first-out)；隊首元素，是當前排隊時間最長的；隊尾元素，

【JUC源碼解析】ConcurrentSkipListMap

sde 空指針 順序 pri 不一致 前驅 values dex warning 簡介 基於跳表，支持並發，有序的哈希表。 跳表 紅色路徑為尋找結點F。 拿空間換時間，時間復雜度，O(nlogn). 源碼分析 內部類 Node 屬性 1

【JUC源碼解析】ScheduledThreadPoolExecutor

技術 inf del timer 默認 執行 task 情況下 多線程 簡介 它是一個線程池執行器（ThreadPoolExecutor）,在給定的延遲（delay）後執行。在多線程或者對靈活性有要求的環境下，要優於java.util.Timer。 提交的任務在執行之前

【spring源碼學習】spring的AOP面向切面編程的實現解析

內部 遠程調用 關註 add aps 文件 uem 連接 row 一：Advice(通知)（1）定義在連接點做什麽，為切面增強提供織入接口。在spring aop中主要描述圍繞方法調用而註入的切面行為。（2）spring定義了幾個時刻織入增強行為的接口??=>org.

dubbo源碼解析-spi(3)

做的 property 部分 修飾 末尾 not clas ioc cto 前言 在上一篇的末尾,我們提到了dubbo的spi中增加了IoC和AOP的功能.那麽本篇就講一下這個增加的IoC,spi部分預計會有四篇,因為這東西實在是太重要了.溫故而知新,我們先來回顧一下,我們

dubbo源碼解析-spi(二)

gets tile load type rec nfa 收獲 shm 介紹 前言 上一篇簡單的介紹了spi的基本一些概念,在末尾也提到了,dubbo對jdk的spi進行了一些改進,具體改進了什麽,來看看文檔的描述 JDK 標準的 SPI 會一次性實例化擴展點所有實現，如果

【Dubbo源碼閱讀系列】服務暴露之遠程暴露

3ds 不難 [] wrapper 重點 client 工廠 特定 講解 引言 什麽叫 遠程暴露 ?試著想象著這麽一種場景：假設我們新增了一臺服務器 A，專門用於發送短信提示給指定用戶。那麽問題來了，我們的 Message 服務上線之後，應該如何告知調用方服務器，服務器 A

【Dubbo源碼閱讀系列】之遠程服務調用（上）

res 簡單的 eric 執行流程 交互 windbg 模式 face voc 今天打算來講一講 Dubbo 服務遠程調用。筆者在開始看 Dubbo 遠程服務相關源碼的時候，看的有點迷糊。後來慢慢明白 Dubbo 遠程服務的調用的本質就是動態代理模式的一種實現。本地消費者無

【MyBatis源碼分析】insert方法、update方法、delete方法處理流程（上篇）

times database connect 環境 enable clas 它的 java對象 ace 打開一個會話Session 前文分析了MyBatis將配置文件轉換為Java對象的流程，本文開始分析一下insert方法、update方法、delete方法處理的流程，至

【spring源碼學習】spring的IOC容器之BeanFactoryPostProcessor接口學習

時機 process roc sta 自動 註解 lis nbsp factor 【一】org.springframework.beans.factory.config.BeanFactoryPostProcessor接口==>該接口實現方法的執行時機：該接口void

【spring源碼學習】spring的遠程調用實現源碼分析

數據 編碼方式 ria date 技術 color nbsp mvc err 【一】spring的遠程調用提供的基礎類 （1）org.springframework.remoting.support.RemotingSupport ===>spring提供實現的遠程調

【spring源碼學習】spring配置的事務方式是REQUIRED,但業務層拋出TransactionRequiredException異常問題

uncaught easy lap api tee class odi lose gre (1)spring拋出異常的點:org.springframework.orm.jpa.EntityManagerFactoryUtils public static DataAc

【MatConvNet代碼解析】 vl_nnsoftmaxloss

eight ear img src vnet com 會有 分類 bubuko 背景知識：http://deeplearning.stanford.edu/wiki/index.php/Softmax%E5%9B%9E%E5%BD%92 假設softmax層的輸入（sof

【Canal源碼分析】數據傳輸協議

shutdown nal odi error comm default enc repeated head Canal的數據傳輸有兩塊，一塊是進行binlog訂閱時，binlog轉換為我們所定義的Message，第二塊是client與server進行TCP交互時，傳輸的TC

【Canal源碼分析】TableMetaTSDB

啟動 尋找 進行 lib 保存 AD orien strip 介紹 這是Canal在新版本引入的一個內容，主要是為了解決由於歷史的DDL導致表結構與現有表結構不一致，導致的同步失敗的問題。采用的是Druid和Fastsql，來記錄表結構到DB中，如果需要進行回滾時，得從DB

【JDK源碼分析】通過源碼徹底理解ReentrantLock顯示鎖

線程封裝 rac syn next 之前 線程 vat 喚醒 current 前言ReentrantLock和synchronized一樣是一個可重入的互斥鎖，但ReentrantLock功能更強大，它提供了非公平和公平兩種鎖爭用策略供使用者選擇，而synchronized