Dubbo剖析-SPI機制

文章要點

  1. 什么是spi
  2. dubbo為什么實現(xiàn)自己的spi
  3. dubbo的adaptive機制
  4. dubbo的IOC和AOP
  5. dubbo動態(tài)編譯機制
  6. dubbo與spring的融合

一、什么是spi

SPI 全稱為 (Service Provider Interface) ，是JDK內(nèi)置的一種服務(wù)提供發(fā)現(xiàn)機制。SPI是一種動態(tài)替換發(fā)現(xiàn)的機制。我們經(jīng)常遇到的就是java.sql.Driver接口，不同的數(shù)據(jù)庫不同的Driver實現(xiàn)。

如何應(yīng)用？
當(dāng)服務(wù)的提供者提供了一種接口的實現(xiàn)之后，需要在classpath下的META-INF/services/目錄里創(chuàng)建一個以服務(wù)接口命名的文件，這個文件里的內(nèi)容就是這個接口的具體的實現(xiàn)類。當(dāng)程序需要這個服務(wù)的時候，調(diào)用java.util.ServiceLoader加載spi配置文件即可獲取spi文件里所有的實現(xiàn)類。

舉例說明
mysql
在mysql-connector-java-5.1.45.jar中，META-INF/services目錄下會有一個名字為java.sql.Driver的文件：

com.mysql.jdbc.Driver
com.mysql.fabric.jdbc.FabricMySQLDriver

驅(qū)動加載
DriverManager

static {
    loadInitialDrivers();
    println("JDBC DriverManager initialized");
}

//loadInitialDrivers
AccessController.doPrivileged(new PrivilegedAction<Void>() {
    public Void run() {
        ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
        Iterator<Driver> driversIterator = loadedDrivers.iterator();

可參考：spi詳解

二、dubbo為什么實現(xiàn)自己的spi

為什么dubbo要實現(xiàn)自己的spi？

  1. JDK 是加載所有的spi類，沒有用到的會浪費
  2. JDK spi不支持緩存
  3. JDK spi通過for循環(huán)進行加載，dubbo支持按照key進行獲取spi對象

三、dubbo 的adaptive機制

Adaptive如字面意思，適配的類。dubbo的spi入口ExtensionLoader.getExtensionLoader，當(dāng)我們傳入type，ExtensionLoader掃描對應(yīng)的spi文件，如果類加@Adaptive注解則直接返回，反之自動生成對應(yīng)適配類。

調(diào)用ExtensionLoader的地方有多個，下面列兩個，有興趣的可以自己跟蹤下代碼

//com.alibaba.dubbo.container.Main 啟動入口
private static final ExtensionLoader<Container> loader = ExtensionLoader.getExtensionLoader(Container.class);

//com.alibaba.dubbo.config.ServiceConfig
private static final Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();

調(diào)用鏈路
|--ExtensionLoader.getAdaptiveExtension
|----ExtensionLoader.createAdaptiveExtension
|------ExtensionLoader.injectExtension
|--------ExtensionLoader.getAdaptiveExtensionClass
|----------ExtensionLoader.getExtensionClasses
|------------ExtensionLoader.loadExtensionClasses
|--------------ExtensionLoader.loadFile
|----------ExtensionLoader.createAdaptiveExtensionClass

getAdaptiveExtensionClass，獲取Adaptive適配類，返回 cachedAdaptiveClass，這個在 spi加載的時候會提取出來并緩存到cachedAdaptiveClass，如果沒有Adaptive類則自動生成。

先看下getExtensionClasses調(diào)用的loadExtensionClasses的實現(xiàn)邏輯

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];
        }
    }
    
    //將所有的spi緩存到extensionClasses
    Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();
    loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY);
    loadFile(extensionClasses, DUBBO_DIRECTORY);
    loadFile(extensionClasses, SERVICES_DIRECTORY);
    return extensionClasses;
}

loadFile

加載對應(yīng)路徑下的spi文件里的class并存儲到緩存變量里

加載的路徑

DUBBO_INTERNAL_DIRECTORY = META-INF/dubbo/internal/
DUBBO_DIRECTORY = META-INF/dubbo/
SERVICES_DIRECTORY = META-INF/services/

文件名

目錄 + type.getName();

三個緩存變量

cachedAdaptiveClass
如果這個class含有adaptive注解就賦值，例如ExtensionFactory，而例如Protocol在這個環(huán)節(jié)是沒有的。

cachedWrapperClasses
只有當(dāng)該class無adative注解，并且構(gòu)造函數(shù)包含目標(biāo)接口（type）類型，例如protocol里面的spi就只有ProtocolFilterWrapper和ProtocolListenerWrapper能命中

cachedActivates
剩下的類，類有Activate注解

cachedNames
剩下的類就存儲在這里

代碼視圖

private void loadFile(Map<String, Class<?>> extensionClasses, String dir) {
    //省略若干代碼

    Class<?> clazz = Class.forName(line, true, classLoader);
    
    //查看類或方法是否包含Adaptive注解，如：AdaptiveExtensionFactory
    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 {
            //判斷該類是否有type參數(shù)的構(gòu)造方法,如ProtocolFilterWrapper，ProtocolListenerWrapper
            clazz.getConstructor(type);
            Set<Class<?>> wrappers = cachedWrapperClasses;
            if (wrappers == null) {
                cachedWrapperClasses = new ConcurrentHashSet<Class<?>>();
                wrappers = cachedWrapperClasses;
            }
            //添加到 cachedWrapperClasses
            wrappers.add(clazz);
        } catch (NoSuchMethodException e) {
            clazz.getConstructor();
            if (name == null || name.length() == 0) {
                //spi沒有key的情況下， 讀取注解名
                name = findAnnotationName(clazz);
                if (name == null || name.length() == 0) {
                    if (clazz.getSimpleName().length() > type.getSimpleName().length()
                            && clazz.getSimpleName().endsWith(type.getSimpleName())) {
                        //讀取 simpleName的一部分作為name  如 com.alibaba.dubbo.rpc.protocol.http.HttpProtocol
                        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 注解  
                Activate activate = clazz.getAnnotation(Activate.class);
                if (activate != null) {
                    cachedActivates.put(names[0], activate);
                }
                for (String n : names) {
                    if (!cachedNames.containsKey(clazz)) {
                        //上面的邏輯如果都沒有符合的，加入到 cachedNames
                        cachedNames.put(clazz, n);
                    }
                    Class<?> c = extensionClasses.get(n);
                    if (c == null) {
                        extensionClasses.put(n, clazz);
                    } else if (c != clazz) {
                        throw new IllegalStateException("Duplicate extension " + type.getName() + " name " + n + " on " + c.getName() + " and " + clazz.getName());
                    }
                }
            }
        }
    }

    //省略若干代碼
}

經(jīng)過spi文件的加載，對應(yīng)的class都已經(jīng)緩存，最后調(diào)用ExtensionLoader.getAdaptiveExtension返回，getAdaptiveExtension方法會判斷 cachedAdaptiveInstance 是否為空如果不為空則返回反之則生成對應(yīng)的 Adaptive類，生成邏輯見下方第五小節(jié)。

四、dubbo 的IOC和AOP

private T createExtension(String name) {
    //從緩存里獲取class
    Class<?> clazz = getExtensionClasses().get(name);
    if (clazz == null) {
        throw findException(name);
    }
    try {
        //從緩存獲取class實例
        T instance = (T) EXTENSION_INSTANCES.get(clazz);
        if (instance == null) {
            EXTENSION_INSTANCES.putIfAbsent(clazz, (T) clazz.newInstance());
            instance = (T) EXTENSION_INSTANCES.get(clazz);
        }
        //模仿spring做的IOC注入
        injectExtension(instance);

        Set<Class<?>> wrapperClasses = cachedWrapperClasses;
        if (wrapperClasses != null && wrapperClasses.size() > 0) {
            for (Class<?> wrapperClass : wrapperClasses) {
                //對instance進行包裝，這里使用到aop
                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);
    }
}

createExtension
從cachedClasses 獲得class名

EXTENSION_INSTANCES 實例對象緩存

getExtension(String name)返回的是 get出來的對象wrapper對象，例如protocol就是ProtocolFilterWrapper和ProtocolListenerWrapper其中一個。

injectExtension(T instance)//dubbo的IOC反轉(zhuǎn)控制，就是從spi或spring 容器里面獲取對象并賦值。

IOC
dubbo的IOC反轉(zhuǎn)控制，就是從spi和spring里面提取對象賦值。
|--injectExtension(T instance)
|----objectFactory.getExtension(pt, property)
|------SpiExtensionFactory.getExtension(type, name)
|--------ExtensionLoader.getExtensionLoader(type)
|--------loader.getAdaptiveExtension()
|------SpringExtensionFactory.getExtension(type, name)
|--------context.getBean(name)

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())) {
                    Class<?> pt = method.getParameterTypes()[0];
                    try {
                        String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";
                        //獲取對應(yīng)的對象，這里有SpringExtensionFactory 和 SpiExtensionFactory兩種實現(xiàn)
                        //如果SpiExtensionFactory不支持的則通過SpringExtensionFactory 從spring容器中獲取實例對象
                        Object object = objectFactory.getExtension(pt, property);
                        if (object != null) {
                            //set注入
                            method.invoke(instance, object);
                        }
    //省略部分代碼
    return instance;
}

AOP
AOP的簡單設(shè)計, createExtension的aop代碼實現(xiàn)

//這里獲取當(dāng)前spi下所有 包裝類型，這里其實就是一個裝飾者模式的運用，可以參考ProtocolFilterWrapper
Set<Class<?>> wrapperClasses = cachedWrapperClasses;
if (wrapperClasses != null && wrapperClasses.size() > 0) {
    for (Class<?> wrapperClass : wrapperClasses) {
        //將instance裝飾完成后返回
        instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));
    }
}

五、dubbo的動態(tài)編譯

以 Protocol的spi 舉例子

com.alibaba.dubbo.config.ServiceConfig
private static final Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();

|--ExtensionLoader.getAdaptiveExtensionClass
|----ExtensionLoader.createAdaptiveExtensionClass
|------ExtensionLoader.createAdaptiveExtensionClassCode

private Class<?> getAdaptiveExtensionClass() {
    getExtensionClasses();

    //如果緩存里有 Adaptive類則直接返回
    if (cachedAdaptiveClass != null) {
        return cachedAdaptiveClass;
    }

    //如果沒有Adaptive類，就自動生成
    return cachedAdaptiveClass = createAdaptiveExtensionClass();
}

private Class<?> createAdaptiveExtensionClass() {
    //生成類 代碼文本
    String code = createAdaptiveExtensionClassCode();
    ClassLoader classLoader = findClassLoader();

    //獲取Compiler的spi 類
    com.alibaba.dubbo.common.compiler.Compiler compiler = ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();

    //編譯代碼  default=javassist
    return compiler.compile(code, classLoader);
}

createAdaptiveExtensionClassCode
主要生成 Protocol 的 Adaptive類java代碼，Protocol的默認協(xié)議是 dubbo

@SPI("dubbo")
public interface Protocol {

只對Protocol帶有 @Adaptive 注解的方法寫入實現(xiàn)體，其它方法的實現(xiàn)則拋出異常，生成的代碼樣例如下

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();

        //提取url里的協(xié)議，如果為空則使用默認協(xié)議 dubbo 。 該行注釋不是生成出來的。       
        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);
    }
}

最后調(diào)用 JavassistCompiler.compile 方法進行編譯，需要將java源碼編譯成二進制class并利用classloader加載至內(nèi)存，這樣我們的程序才能調(diào)用這個類。

六、dubbo與spring的融合

容器的啟動
com.alibaba.dubbo.container.Main
dubbo啟動入口， Container的默認策略是spring

spring=com.alibaba.dubbo.container.spring.SpringContainer

main方法的實現(xiàn)體會調(diào)用 SpringContainer.start方法，方法的實現(xiàn)體就是常規(guī)的spring容器使用姿勢

public void start() {
    String configPath = ConfigUtils.getProperty(SPRING_CONFIG);
    if (configPath == null || configPath.length() == 0) {
        configPath = DEFAULT_SPRING_CONFIG;
    }
    context = new ClassPathXmlApplicationContext(configPath.split("[,\\s]+"));
    context.start();
}

dubbo schema

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
       xsi:schemaLocation="http://www.springframework.org/schema/beans        http://www.springframework.org/schema/beans/spring-beans.xsd        http://code.alibabatech.com/schema/dubbo        http://code.alibabatech.com/schema/dubbo/dubbo.xsd">


    <!-- 提供方應(yīng)用信息，用于計算依賴關(guān)系 -->
    <dubbo:application name="hello-world-app"/>

    <!-- 使用multicast廣播注冊中心暴露服務(wù)地址 -->
    <dubbo:registry address="zookeeper://127.0.0.1:2181" check="false" client="zkclient" />

    <!-- 用dubbo協(xié)議在20880端口暴露服務(wù) -->
    <dubbo:protocol name="dubbo" port="20880"/>

    <!-- 聲明需要暴露的服務(wù)接口 -->
    <dubbo:service interface="com.youzan.dubbo.api.DemoService"
                   class="com.youzan.dubbo.provider.DemoServiceImpl"/>

</beans>

這是一個常見的dubbo服務(wù) xml，這些dubbo標(biāo)簽是對spring的拓展。
spring的拓展約定，需要有三個文件

dubbo.xsd 定義 dubbo xml標(biāo)簽及xml節(jié)點約定
spring.schemas 定義 namespace和xsd的對應(yīng)關(guān)系
spring.handlers 指定 namespace的xml解析類

spring.handlers的文件內(nèi)容

http://code.alibabatech.com/schema/dubbo=com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandler

public class DubboNamespaceHandler extends NamespaceHandlerSupport {

    static {
        Version.checkDuplicate(DubboNamespaceHandler.class);
    }

    public void init() {
        registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));
        registerBeanDefinitionParser("module", new DubboBeanDefinitionParser(ModuleConfig.class, true));
        registerBeanDefinitionParser("registry", new DubboBeanDefinitionParser(RegistryConfig.class, true));
        registerBeanDefinitionParser("monitor", new DubboBeanDefinitionParser(MonitorConfig.class, true));
        registerBeanDefinitionParser("provider", new DubboBeanDefinitionParser(ProviderConfig.class, true));
        registerBeanDefinitionParser("consumer", new DubboBeanDefinitionParser(ConsumerConfig.class, true));
        registerBeanDefinitionParser("protocol", new DubboBeanDefinitionParser(ProtocolConfig.class, true));
        registerBeanDefinitionParser("service", new DubboBeanDefinitionParser(ServiceBean.class, true));
        registerBeanDefinitionParser("reference", new DubboBeanDefinitionParser(ReferenceBean.class, false));
        registerBeanDefinitionParser("annotation", new DubboBeanDefinitionParser(AnnotationBean.class, true));
    }

}

這里的各個標(biāo)簽對應(yīng)都有對應(yīng)的 parser，在parse方法里，走的spring的一套，將xml信息組裝成BeanDefinition返回，接著由spring容器把對應(yīng)的類進行實例化。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 前面我們了解過了Java的SPI擴展機制，對于Java擴展機制的原理以及優(yōu)缺點也有了大概的了解，這里繼續(xù)深入一下D...
    加大裝益達閱讀 5,247評論 2贊 20
  • Dubbo采用微內(nèi)核+插件體系，使得設(shè)計優(yōu)雅，擴展性強。那所謂的微內(nèi)核+插件體系是如何實現(xiàn)的呢！大家是否熟悉spi...
    carl_zhao閱讀 1,026評論 1贊 3
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,578評論 19贊 139
  • dubbo自定義SPI 為什么dubbo要自己設(shè)計一套SPI？ JDK標(biāo)準(zhǔn)的SPI會一次性實例化擴展點所有實現(xiàn)，如...
    半個橙子閱讀 727評論 0贊 9
  • 總結(jié)：Protocolrefprotocol = ExtensionLoader.getExtensionLoad...
    Ngcc閱讀 756評論 0贊 2

友情鏈接更多精彩內(nèi)容