2.dubbo源碼分析 之 內核SPI實現

Dubbo采用微內核+插件體系,使得設計優雅,擴展性強。那所謂的微內核+插件體系是如何實現的呢!大家是否熟悉spi(service providerinterface)機制,即我們定義了服務接口標準,讓廠商去實現(如果不了解spi的請谷歌百度下), jdk通過ServiceLoader類實現spi機制的服務查找功能 -- Java 規范 SPI

1、為什么不使用JDK SPI

在dubbo中它實現了一套自己的SPI機制。JDK標準的SPI會一次性實例化擴展點所有實現,如果有擴展實現初始化很耗時,但如果沒用上也加載,會很浪費資源.

增加了對擴展點IoC和AOP的支持,一個擴展點可以直接setter注入其它擴展點。

2、Dubbo SPI 約定

SPI文件的存儲路徑在以下三個文件路徑:

  • META-INF/dubbo/internal/ dubbo內部實現的各種擴展都放在了這個目錄了
  • META-INF/dubbo/
  • META-INF/services/

spi 文件 存儲路徑在以上三個SPI目錄下,并且文件名為接口的全路徑名 就是=接口的包名+接口名也就是SPI接口的全路徑類名:例如

E:\Project\github\dubbo\dubbo-rpc\dubbo-rpc-default\src\main\resources
\META-INF\dubbo\internal\
com.alibaba.dubbo.rpc.Protocol

每個spi 文件里面的格式定義為: 擴展名=具體的類名,例如


dubbo=com.alibaba.dubbo.rpc.protocol.dubbo.DubboProtoco

3、涉及到類與注解簡單說明

在dubbo SPI中最關鍵的類是ExtensionLoader。每個定義的spi的接口都會構建一個ExtensionLoader實例,存儲在ExtensionLoader對象的ConcurrentMap<Class<?>,ExtensionLoader<?>> EXTENSION_LOADERS這個map對象中。

獲取SPI對象的典型方式為:

Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();

對于獲取SPI對象的過程會在后面詳細說明。

涉及到幾個注解。下面我們就來簡單的分析一下這些注解。

  • @SPI:標識在dubbo中需要使用SPI的接口上,指定的SPI里面指定的值為默認值。

  • @Adaptive:這個注解和@SPI注解配置使用,用于它可以標注在SPI接口擴展類上,也可以標注在SPI接口的方法上。如果這個注解標注在SPI接口實現的擴展類上時,獲取的SPI實例對象就是標注了@Adaptive注冊的類。例如:ExtensionFactory的SPI擴展對象為AdaptiveExtensionFactory。如果注解在標注在SPI接口的方法上說明就是一個動態代理類,它會通過dubbo里面的com.alibaba.dubbo.common.compiler.CompilerSPI接口通過字節碼技術來創建對象。創建出來的對象名格式為SPI接口$Adaptive,例如Protocol接口創建的SPI對象為Protocol$Adaptive。

  • @Activate: 是一個 Duboo 框架提供的注解。在 Dubbo 官方文檔上有記載:
    對于集合類擴展點,比如:Filter, InvokerListener, ExportListener, TelnetHandler, StatusChecker等, 可以同時加載多個實現,此時,可以用自動激活來簡化配置。

4、ExtensionLoader

在上一個章節我們就說過對于每個定義的spi的接口都會構建一個ExtensionLoader實例,然后通過這個實例的getAdaptiveExtension就可以獲取一個擴展。下面我們就來詳細的解剖一下ExtensionLoader這個對象。

在這個對象里面有幾個重要的方法:

  • getExtensionLoader(Class<T> type) 就是為該接口new 一個-ExtensionLoader,然后緩存起來。
  • getAdaptiveExtension() 獲取一個擴展類,如果@Adaptive注解在類上就是一個裝飾類;如果注解在方法上就是一個動態代理類,例如Protocol$Adaptive對象。
  • getExtension(String name) 獲取一個指定對象。
  • getActivateExtension(URL url, String[] values, String group):方法主要獲取當前擴展的所有可自動激活的實現標注了@Activate注解
Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();

基于以上的dubbo SPI典型使用我們來分析一下這些方法。

4.1 getExtensionLoader

就是為該接口new 一個ExtensionLoader,然后緩存起來。并為非ExtensionFactory的對象創建一個objectFactory用來依賴注入。

com.alibaba.dubbo.common.extension.ExtensionLoader#getExtensionLoader

    public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type) {
        ExtensionLoader<T> loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
        if (loader == null) {
            // 創建一個ExtensionLoader
            EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
            loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
        }
        return loader;
    }

為SPI接口創建一個ExtensionLoader對象,用于獲取擴展對象。

com.alibaba.dubbo.common.extension.ExtensionLoader#ExtensionLoader

    private ExtensionLoader(Class<?> type) {
        this.type = type;
        objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());
    }

在創建ExtensionLoader對象的時候,如果當前對象不是ExtensionFactory為當前SPI接口創建一個ExtensionFactory對象。當調用ExtensionLoader#injectExtension方法的時候進行依賴注入。

4.2 getAdaptiveExtension

這個方法是dubbo SPI里最核心的方法。dubbo通過這個方法來獲取到SPI接口的對應擴展類。

com.alibaba.dubbo.common.extension.ExtensionLoader#getAdaptiveExtension

    public T getAdaptiveExtension() {
        Object instance = cachedAdaptiveInstance.get();
        if (instance == null) {
            if(createAdaptiveInstanceError == null) {
                synchronized (cachedAdaptiveInstance) {
                    instance = cachedAdaptiveInstance.get();
                    if (instance == null) {
                        try {
                            // 創建對應的擴展類
                            instance = createAdaptiveExtension();
                            cachedAdaptiveInstance.set(instance);
                        } 
                    }
                }
            }
        }

        return (T) instance;
    }

當SPI接口首次調用這個方法的時候,擴展類還沒有創建好,所以它就會直接訪問createAdaptiveExtension方法。

com.alibaba.dubbo.common.extension.ExtensionLoader#createAdaptiveExtension

    private T createAdaptiveExtension() {
        try {
            return injectExtension((T) getAdaptiveExtensionClass().newInstance());
        } catch (Exception e) {
            throw new IllegalStateException("Can not create adaptive extenstion " + type + ", cause: " + e.getMessage(), e);
        }
    }

通過getAdaptiveExtensionClass獲取到SPI擴展對象Class的實例,然后通過反射方法newInstance()創建這個對象。最后通過最開始介紹的ExtensionLoader#getExtensionLoader創建的objectFactory進行依賴注入。

com.alibaba.dubbo.common.extension.ExtensionLoader#getAdaptiveExtensionClass

    private Class<?> getAdaptiveExtensionClass() {
        // @Adaptive 注解在類上
        getExtensionClasses();
        if (cachedAdaptiveClass != null) {
            return cachedAdaptiveClass;
        }
        // @Adaptive注解在SPI接口方法上
        return cachedAdaptiveClass = createAdaptiveExtensionClass();
    }

這里就是上面說的,如果@Adaptive接口標注在@SPI接口的實現類上面就會直接返回這個對象的Class實例。如果標注在@SPI接口的方法上,就會通過dubbo中的字節碼Compiler接口通過動態代理來創建SPI接口的實例。

4.2.1 @Adaptive在類上

下面我們就來分析一下@Adaptive標注在SPI接口的實現類上。SPI擴展的創建過程。

com.alibaba.dubbo.common.extension.ExtensionLoader#getExtensionClasses

    private Map<String, Class<?>> getExtensionClasses() {
        Map<String, Class<?>> classes = cachedClasses.get();
        if (classes == null) {
            synchronized (cachedClasses) {
                classes = cachedClasses.get();
                if (classes == null) {
                    // 加載擴展類
                    classes = loadExtensionClasses();
                    cachedClasses.set(classes);
                }
            }
        }
        return classes;
    }

加載擴展類,并把擴展類Class實例設置到cachedClasses中。

com.alibaba.dubbo.common.extension.ExtensionLoader#loadExtensionClasses

    private Map<String, Class<?>> loadExtensionClasses() {
        final SPI defaultAnnotation = type.getAnnotation(SPI.class);
        if(defaultAnnotation != null) {
            String value = defaultAnnotation.value();
            if(value != null && (value = value.trim()).length() > 0) {
                String[] names = NAME_SEPARATOR.split(value);
                if(names.length > 1) {
                    throw new IllegalStateException("more than 1 default extension name on extension " + type.getName()
                            + ": " + Arrays.toString(names));
                }
                // 設置擴展類的默認名稱
                if(names.length == 1) cachedDefaultName = names[0];
            }
        }
        
        Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();
        // 加載上面所說的三個配置文件中的dubbo SPI文件
        loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY);
        loadFile(extensionClasses, DUBBO_DIRECTORY);
        loadFile(extensionClasses, SERVICES_DIRECTORY);
        return extensionClasses;
    }

從代碼里面可以看到,在loadExtensionClasses中首先會檢測擴展點在@SPI注解中配置的默認擴展實現的名稱,并將其賦值給cachedDefaultName屬性進行緩存,后面想要獲取該擴展點的默認實現名稱就可以直接通過訪問cachedDefaultName字段來完成,比如getDefaultExtensionName方法就是這么實現的。從這里的代碼中又可以看到,具體的擴展實現類型,是通過調用loadFile方法來加載,分別從一下三個地方加載:

  • META-INF/dubbo/internal/
  • META-INF/dubbo/
  • META-INF/services/

那么這個loadFile方法則至關重要了,看看其源代碼:

private void loadFile(Map<String, Class<?>> extensionClasses, String dir) {
    // SPI目錄與SPI接口
    String fileName = dir + type.getName();
    try {
        Enumeration<java.net.URL> urls;
        ClassLoader classLoader = findClassLoader();
        // 掃描classpath下面的當前SPI接口的擴展
        if (classLoader != null) {
            urls = classLoader.getResources(fileName);
        } else {
            urls = ClassLoader.getSystemResources(fileName);
        }
        if (urls != null) {
            while (urls.hasMoreElements()) {
                java.net.URL url = urls.nextElement();
                try {
                    BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), "utf-8"));
                    try {
                        String line = null;
                        while ((line = reader.readLine()) != null) {
                            final int ci = line.indexOf('#');
                            // 讀取SPI文件中的SPI擴展
                            if (ci >= 0) line = line.substring(0, ci);
                            line = line.trim();
                            if (line.length() > 0) {
                                try {
                                    String name = null;
                                    int i = line.indexOf('=');
                                    if (i > 0) {
                                        name = line.substring(0, i).trim();
                                        line = line.substring(i + 1).trim();
                                    }
                                    if (line.length() > 0) {
                                        Class<?> clazz = Class.forName(line, true, classLoader);
                                        if (! type.isAssignableFrom(clazz)) {
                                            throw new IllegalStateException("Error when load extension class(interface: " +
                                                    type + ", class line: " + clazz.getName() + "), class " 
                                                    + clazz.getName() + "is not subtype of interface.");
                                        }
                                        // 如果Adaptive注解標注在這個對象上,設置cachedAdaptiveClass值為當前對象
                                        if (clazz.isAnnotationPresent(Adaptive.class)) {
                                            if(cachedAdaptiveClass == null) {
                                                cachedAdaptiveClass = clazz;
                                            } else if (! cachedAdaptiveClass.equals(clazz)) {
                                                throw new IllegalStateException("More than 1 adaptive class found: "
                                                        + cachedAdaptiveClass.getClass().getName()
                                                        + ", " + clazz.getClass().getName());
                                            }
                                        } else {
                                            try {
                                                // 判斷這個SPI擴展是否以當前SPI接口為構造器,使用裝飾器模式增強這個類
                                                clazz.getConstructor(type);
                                                Set<Class<?>> wrappers = cachedWrapperClasses;
                                                if (wrappers == null) {
                                                    cachedWrapperClasses = new ConcurrentHashSet<Class<?>>();
                                                    wrappers = cachedWrapperClasses;
                                                }
                                                wrappers.add(clazz);
                                            } catch (NoSuchMethodException e) {
                                                // 沒有以當前SPI接口為構造器
                                                clazz.getConstructor();
                                                if (name == null || name.length() == 0) {
                                                    name = findAnnotationName(clazz);
                                                    if (name == null || name.length() == 0) {
                                                        if (clazz.getSimpleName().length() > type.getSimpleName().length()
                                                                && clazz.getSimpleName().endsWith(type.getSimpleName())) {
                                                            name = clazz.getSimpleName().substring(0, clazz.getSimpleName().length() - type.getSimpleName().length()).toLowerCase();
                                                        } else {
                                                            throw new IllegalStateException("No such extension name for the class " + clazz.getName() + " in the config " + url);
                                                        }
                                                    }
                                                }
                                                String[] names = NAME_SEPARATOR.split(name);
                                                if (names != null && names.length > 0) {
                                                    // 標注了Activate注解,保存在cachedActivates屬性中
                                                    Activate activate = clazz.getAnnotation(Activate.class);
                                                    if (activate != null) {
                                                        cachedActivates.put(names[0], activate);
                                                    }
                                                    for (String n : names) {
                                                        // 把擴展名稱與擴展類的映射關系保存在cachedNames中
                                                        if (! cachedNames.containsKey(clazz)) {
                                                            cachedNames.put(clazz, n);
                                                        }
                                                        Class<?> c = extensionClasses.get(n);
                                                        if (c == null) {
                                                            // 把擴展名稱與擴展類的映射關系保存在extensionClasses中,用于返回
                                                            extensionClasses.put(n, clazz);
                                                        } else if (c != clazz) {
                                                            throw new IllegalStateException("Duplicate extension " + type.getName() + " name " + n + " on " + c.getName() + " and " + clazz.getName());
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                } catch (Throwable t) {
                                    IllegalStateException e = new IllegalStateException("Failed to load extension class(interface: " + type + ", class line: " + line + ") in " + url + ", cause: " + t.getMessage(), t);
                                    exceptions.put(line, e);
                                }
                            }
                        } // end of while read lines
                    } finally {
                        reader.close();
                    }
                } catch (Throwable t) {
                    logger.error("Exception when load extension class(interface: " +
                                        type + ", class file: " + url + ") in " + url, t);
                }
            } // end of while urls
        }
    } catch (Throwable t) {
        logger.error("Exception when load extension class(interface: " +
                type + ", description file: " + fileName + ").", t);
    }
}

這里就把@Adaptive的對象放置到cachedAdaptiveClass屬性中,把有SPI接口為構造的包裝對象放置在cachedWrapperClasses屬性中,把沒有SPI接口為構造的對象放置在cachedNames屬性中。

4.2.2 @Adaptive在方法上

如果@Adaptive標注在SPI接口的方法上,那么dubbo就會通過SPI接口Compiler進行字節碼操作生成代理對象。默認使用Javassist字節碼框架生成代理對象。

com.alibaba.dubbo.common.extension.ExtensionLoader#createAdaptiveExtensionClass

    private Class<?> createAdaptiveExtensionClass() {
        String code = createAdaptiveExtensionClassCode();
        ClassLoader classLoader = findClassLoader();
        com.alibaba.dubbo.common.compiler.Compiler compiler = ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();
        return compiler.compile(code, classLoader);
    }

生成的代碼對象的模板如下:

package <擴展點接口所在包>;
 
public class <擴展點接口名>$Adpative implements <擴展點接口> {
    public <有@Adaptive注解的接口方法>(<方法參數>) {
        if(是否有URL類型方法參數?) 使用該URL參數
        else if(是否有方法類型上有URL屬性) 使用該URL屬性
        # <else 在加載擴展點生成自適應擴展點類時拋異常,即加載擴展點失敗!>
         
        if(獲取的URL == null) {
            throw new IllegalArgumentException("url == null");
        }
 
              根據@Adaptive注解上聲明的Key的順序,從URL獲致Value,作為實際擴展點名。
               如URL沒有Value,則使用缺省擴展點實現。如沒有擴展點, throw new IllegalStateException("Fail to get extension");
 
               在擴展點實現調用該方法,并返回結果。
    }
 
    public <有@Adaptive注解的接口方法>(<方法參數>) {
        throw new UnsupportedOperationException("is not adaptive method!");
    }
}

例如Protocol生成的代理對象Protocol$Adpative如下:

package com.alibaba.dubbo.rpc;

import com.alibaba.dubbo.common.extension.ExtensionLoader;

public class Protocol$Adpative 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);
    }
}

創建自適應擴展點實現類型和實例化就已經完成了,下面就來看下擴展點自動注入的實現injectExtension:

com.alibaba.dubbo.common.extension.ExtensionLoader#injectExtension

private T injectExtension(T instance) {
    try {
        if (objectFactory != null) {
            for (Method method : instance.getClass().getMethods()) {
                // 處理所有set方法
                if (method.getName().startsWith("set")
                        && method.getParameterTypes().length == 1
                        && Modifier.isPublic(method.getModifiers())) {
                    // 獲取set方法參數類型
                    Class<?> pt = method.getParameterTypes()[0];
                    try {
                        // 獲取setter對應的property名稱
                        String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";
                        // 根據類型,名稱信息從ExtensionFactory獲取  
                        Object object = objectFactory.getExtension(pt, property);
                        if (object != null) {
                            // 如果不為空,說set方法的參數是擴展點類型,那么進行注入  
                            method.invoke(instance, object);
                        }
                    } catch (Exception e) {
                        logger.error("fail to inject via method " + method.getName()
                                + " of interface " + type.getName() + ": " + e.getMessage(), e);
                    }
                }
            }
        }
    } catch (Exception e) {
        logger.error(e.getMessage(), e);
    }
    return instance;
}

這里可以看到,擴展點自動注入的一句就是根據setter方法對應的參數類型和property名稱從ExtensionFactory中查詢,如果有返回擴展點實例,那么就進行注入操作。到這里getAdaptiveExtension方法就分析完畢了。

4.3 getExtension

這個方法的主要作用是用來獲取ExtensionLoader實例代表的擴展的指定實現。已擴展實現的名字作為參數,結合前面學習getAdaptiveExtension的代碼,我們可以推測,這方法中也使用了在調用getExtensionClasses方法的時候收集并緩存的數據,其中涉及到名字和具體實現類型對應關系的緩存屬性是cachedClasses。具體是是否如我們猜想的那樣呢,學習一下相關代碼就知道了:

public T getExtension(String name) {  
    if (name == null || name.length() == 0)  
        throw new IllegalArgumentException("Extension name == null");  
    // 判斷是否是獲取默認實現
    if ("true".equals(name)) {    
        return getDefaultExtension();  
    }  
    Holder<Object> holder = cachedInstances.get(name);// 緩存  
    if (holder == null) {  
        cachedInstances.putIfAbsent(name, new Holder<Object>());  
        holder = cachedInstances.get(name);  
    }  
    Object instance = holder.get();  
    if (instance == null) {  
        synchronized (holder) {  
            instance = holder.get();  
            if (instance == null) {  
                // 沒有緩存實例則創建  
                instance = createExtension(name);
                holder.set(instance);// 緩存起來  
            }  
        }  
    }  
    return (T) instance;  
}  

判斷是使用默認的擴展 還是根據名稱來創建相應的SPI擴展。

com.alibaba.dubbo.common.extension.ExtensionLoader#createExtension

private T createExtension(String name) {
    // 獲取解析Adaptive標注了@Adaptive的對象緩存在屬性cachedNames
    Class<?> clazz = getExtensionClasses().get(name);
    if (clazz == null) {
        throw findException(name);
    }
    try {
        // 從已創建Extension實例緩存中獲取  
        T instance = (T) EXTENSION_INSTANCES.get(clazz);
        if (instance == null) {
            EXTENSION_INSTANCES.putIfAbsent(clazz, (T) clazz.newInstance());
            instance = (T) EXTENSION_INSTANCES.get(clazz);
        }
        // 注入AdaptiveExtension
        injectExtension(instance);
        Set<Class<?>> wrapperClasses = cachedWrapperClasses;
        // Wrapper類型進行包裝,層層包裹
        if (wrapperClasses != null && wrapperClasses.size() > 0) {
            for (Class<?> wrapperClass : wrapperClasses) {
                instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));
            }
        }
        return instance;
    } catch (Throwable t) {
        throw new IllegalStateException("Extension instance(name: " + name + ", class: " +
                type + ")  could not be instantiated: " + t.getMessage(), t);
    }
}

這里或許有一個疑問: 從代碼中看,不論instance是否存在于EXTENSION_INSTANCE,都會進行擴展點注入和Wrap操作。那么如果對于同一個擴展點,調用了兩次createExtension方法的話,那不就進行了兩次Wrap操作么?

如果外部能夠直接調用createExtension方法,那么確實可能出現這個問題。但是由于createExtension方法是private的,因此外部無法直接調用。而在ExtensionLoader類中調用它的getExtension方法(只有它這一處調用),內部自己做了緩存(cachedInstances),因此當getExtension方法內部調用了一次createExtension方法之后,后面對getExtension方法執行同樣的調用時,會直接使用cachedInstances緩存而不會再去調用createExtension方法了。

4.4 getActivateExtension

getActivateExtension方法主要獲取當前擴展的所有可自動激活的實現。可根據入參(values)調整指定實現的順序,在這個方法里面也使用到getExtensionClasses方法中收集的緩存數據。

com.alibaba.dubbo.common.extension.ExtensionLoader#getActivateExtension(com.alibaba.dubbo.common.URL, java.lang.String[], java.lang.String)

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);  
  
    // 如果未配置"-default",則加載所有Activates擴展(names指定的擴展)  
    if (! names.contains(Constants.REMOVE_VALUE_PREFIX + Constants.DEFAULT_KEY)) {  
        // 加載當前Extension所有實現,會獲取到當前Extension中所有@Active實現,賦值給cachedActivates變量  
        getExtensionClasses(); 
        // 遍歷當前擴展所有的@Activate擴展  
        for (Map.Entry<String, Activate> entry : cachedActivates.entrySet()) { 
            String name = entry.getKey();  
            Activate activate = entry.getValue();  
            // 判斷group是否滿足,group為null則直接返回true 
            if (isMatchGroup(group, activate.group())) {  
                // 獲取擴展示例  
                T ext = getExtension(name); 
  
                // 排除names指定的擴展;并且如果names中沒有指定移除該擴展(-name),且當前url匹配結果顯示可激活才進行使用  
                if (! names.contains(name)  
                        && ! names.contains(Constants.REMOVE_VALUE_PREFIX + name)   
                        && isActive(activate, url)) {  
                    exts.add(ext);  
                }  
            }  
        }  
        Collections.sort(exts, ActivateComparator.COMPARATOR); // 默認排序  
    }  
  
    // 對names指定的擴展進行專門的處理  
    List<T> usrs = new ArrayList<T>();  
    // 遍歷names指定的擴展名 
    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)) { 
            // default表示上面已經加載并且排序的exts,將排在default之前的Activate擴展放置到default組之前,例如:ext1,default,ext2  
                if (usrs.size() > 0) { // 如果此時user不為空,則user中存放的是配置在default之前的Activate擴展  
                    exts.addAll(0, usrs); // 注意index是0,放在default前面  
                    usrs.clear(); // 放到default之前,然后清空  
                }  
            } else {  
                T ext = getExtension(name);  
                usrs.add(ext);  
            }  
        }  
    }  
    if (usrs.size() > 0) { // 這里留下的都是配置在default之后的  
        exts.addAll(usrs); // 添加到default排序之后  
    }  
    return exts;  
}  

5、總結

上面把SPI的思路以及源代碼分析了一遍,有幾點可能需要注意的地方:

  • 每個ExtensionLoader實例只負責加載一個特定擴展點實現
  • 每個擴展點對應最多只有一個ExtensionLoader實例
  • 對于每個擴展點實現,最多只會有一個實例
  • 一個擴展點實現可以對應多個名稱(逗號分隔)
  • 對于需要等到運行時才能決定使用哪一個具體實現的擴展點,應獲取其自使用擴展點實現(AdaptiveExtension)
  • @Adaptive注解要么注釋在擴展點@SPI的方法上,要么注釋在其實現類的類定義上
  • 如果@Adaptive注解注釋在@SPI接口的方法上,那么原則上該接口所- - 有方法都應該加@Adaptive注解(自動生成的實現中默認為注解的方法拋異常)
  • 每個擴展點最多只能有一個被AdaptiveExtension
  • 每個擴展點可以有多個可自動激活的擴展點實現(使用@Activate注解)
  • 由于每個擴展點實現最多只有一個實例,因此擴展點實現應保證線程安全
  • 如果擴展點有多個Wrapper,那么最終其執行的順序不確定(內部使用ConcurrentHashSet存儲)

參考文章:
1、Dubbo原理解析-Dubbo內核實現之基于SPI思想Dubbo內核實現
2、Spring Boot 中如何使用 Dubbo Activate 擴展點
3、Dubbo擴展點加載機制 - ExtensionLoader

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,517評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,087評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,521評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,493評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,207評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,603評論 1 325
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,624評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,813評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,364評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,110評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,305評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,874評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,532評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,953評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,209評論 1 291
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,033評論 3 396
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,268評論 2 375

推薦閱讀更多精彩內容