dubbo之可扩展机制SPI源码分析

dubbo特性

image.png

其中的高度可扩展能力就是针对Protocol、Transport、Serialization等被设计为扩展点。
扩展机制SPI测试效果：

image.png

SPI的可扩展机制的原理：
以Protocol为例，首先检查Protocol类是否添加了@SPI注解，然后查找Protocol依赖包中是否含有key值是http的实现类。

@SPI注解

org.apache.dubbo.rpc.Protocol.class
Protocol协议类添加了@SPI注解，@SPI("dubbo")中的dubbo表示Protocol的默认实现。其中export和refer添加了@Adaptive注解，是在服务导出和服务引用使用的

@SPI("dubbo")
public interface Protocol {
    int getDefaultPort();

    @Adaptive
     Exporter export(Invoker invoker) throws RpcException;

    @Adaptive
     Invoker refer(Class type, URL url) throws RpcException;

    void destroy();

}

http对应的类HttpProtocol

在测试SPI项目中，由于只在依赖中添加了dubbo-rpc-http

image.png

所以只能获取到\resources\META-INF\dubbo\internal目录下的org.apache.dubbo.rpc.Protocol文件的http和http1对应的值。

image.png

其中Adaptive注解表示自适应，Activate表示激活的

getExtensionLoader

获取指定类型的扩展类加载类对象
1、获取ExtensionLoader对象
org.apache.dubbo.common.extension.ExtensionLoader#getExtensionLoader

image.png

判断type是空、不是个接口、没有实现@SPI注解直接返回
2、创建ExtensionLoader
根据type类型创建ExtensionLoader类
org.apache.dubbo.common.extension.ExtensionLoader#ExtensionLoader

image.png

ExtensionFactory是扩展实例工厂，也是SPI实现。如果type不等于ExtensionFactory则objectFactory就是获取ExtensionFactory接口的Adaptive实现类。
ExtensionFactory的实现类：
①、SpiExtensionFactory SPI相关
②、SpringExtensionFactory 与spring相关的扩展类工厂

③、AdaptiveExtensionFactory 决定是用SpiExtensionFactory或SpringExtensionFactory来获取实例

image.png

3、getAdaptiveExtension
org.apache.dubbo.common.extension.ExtensionLoader#getAdaptiveExtension

image.png

得到Adaptive扩展示例并添加到cachedAdaptiveInstance缓存中
4、createAdaptiveExtension
org.apache.dubbo.common.extension.ExtensionLoader#createAdaptiveExtension

image.png

5、getAdaptiveExtensionClass
org.apache.dubbo.common.extension.ExtensionLoader#getAdaptiveExtensionClass
获取当前接口的所有扩展类、如果某个接口没有手动指定一个Adaptive类，那么就自动生成一个Adaptive类
6、getExtensionClasses
org.apache.dubbo.common.extension.ExtensionLoader#getExtensionClasses
加载

image.png

7、loadExtensionClasses
org.apache.dubbo.common.extension.ExtensionLoader#loadExtensionClasses
加载扩展类的文件夹dir
①、DUBBO_INTERNAL_DIRECTORY = META-INF/dubbo/internal/
②、DUBBO_DIRECTORY = META-INF/dubbo/
③、SERVICES_DIRECTORY = META-INF/services/

image.png

ExtensionFactory的扩展类

image.png

8、loadDirectory
org.apache.dubbo.common.extension.ExtensionLoader#loadDirectory
加载文件夹dir和type.getName()组成的文件中加载数据。
例如上面的测试代码就是从\resources\META-INF\dubbo\internal目录下的org.apache.dubbo.rpc.Protocol文件加载的

image.png

9、loadResource
org.apache.dubbo.common.extension.ExtensionLoader#loadResource
加载数据流

image.png

image.png

10、loadClass
org.apache.dubbo.common.extension.ExtensionLoader#loadClass

image.png

image.png

①、缓存Adaptive
把添加Adaptive注解的当前接口实现类添加到cachedAdaptiveClass中

image.png

②、Wrapper类
org.apache.dubbo.common.extension.ExtensionLoader#isWrapperClass
判断一个类是不是Wrapper类，根据构造方法判断。构造方法参数类型是当前接口，返回true

image.png

③、缓存Activate类
org.apache.dubbo.common.extension.ExtensionLoader#cacheActivateClass

image.png

11、createAdaptiveExtensionClass
所以在第五步⑤getAdaptiveExtensionClass方法得到Adaptive自适应的扩展类时，如果缓存中已经存在则直接返回，如果没有则会创建一个

image.png

org.apache.dubbo.common.extension.ExtensionLoader#createAdaptiveExtensionClass

image.png

12、得到getAdaptiveExtension
(与第三步对应)org.apache.dubbo.common.extension.ExtensionLoader#getAdaptiveExtension

image.png

13、ExtensionLoader
(与第一步对应)得到type=interface org.apache.dubbo.rpc.Protocol
new ExtensionLoader(type)得到的ExtensionLoader

image.png

getExtension

获取指定扩展类extensionLoader.getExtension("http")

image.png

org.apache.dubbo.common.extension.ExtensionLoader#createExtension
1、获取当前接口的所有扩展类

image.png

①、getExtensionClasses加载扩展类
org.apache.dubbo.common.extension.ExtensionLoader#getExtensionClasses

image.png

②、loadExtensionClasses从资源文件加载扩展类
org.apache.dubbo.common.extension.ExtensionLoader#loadExtensionClasses

image.png

Dubbo的IOC

2、依赖注入。属性注入，通过setXxx方法
依赖注入

image.png

org.apache.dubbo.common.extension.ExtensionLoader#injectExtension

image.png

①、遍历当前实例的所有方法，这里注入是通过set方法注入的，所以在找set方法

image.png

②、setter方法的参数类型pt

③、截取setter方法所对应的属性名property
property值是setXxx中的Xxx
④、objectFactory工厂得到一个对象，会从Spring容器或通过SPI机制得到一个对象(Adaptive对象)
⑤、反射调用setter方法进行注入
method.invoke把需要注入对象通过执行setXxx方法设置到当前instance对象的属性值中(与spring中的Autowire效果相同)

Dubbo中的AOP

3、Wrapper实例进行依赖注入
Wrapper实现了AOP的效果
从cachedWrapperClasses缓存中获取Wrapper对当前实例进行包裹传入的参数是instance对象，可一层层包裹

Adaptive

AdaptiveClass表示自适应类，自适应类可以通过getAdaptiveExtension获取。只要在类上添加一个@Adaptive注解，就表示当前类是这个实现类接口的自适应类，如果没有添加了Adaptive注解的类，在我们获取这个类的自适应类时，就会通过createAdaptiveExtensionClass代码自动生成的一个自适应类。

package org.apache.dubbo.rpc;
import org.apache.dubbo.common.extension.ExtensionLoader;
public class Protocol$Adaptive implements org.apache.dubbo.rpc.Protocol {
    
    public void destroy()  {
        throw new UnsupportedOperationException("The method public abstract void org.apache.dubbo.rpc.Protocol.destroy() of interface org.apache.dubbo.rpc.Protocol is not adaptive method!");
    }

    public int getDefaultPort()  {
        throw new UnsupportedOperationException("The method public abstract int org.apache.dubbo.rpc.Protocol.getDefaultPort() of interface org.apache.dubbo.rpc.Protocol is not adaptive method!");
    }
    
    public org.apache.dubbo.rpc.Exporter export(org.apache.dubbo.rpc.Invoker arg0) throws org.apache.dubbo.rpc.RpcException {
        if (arg0 == null) 
            throw new IllegalArgumentException("org.apache.dubbo.rpc.Invoker argument == null");
        if (arg0.getUrl() == null) 
            throw new IllegalArgumentException("org.apache.dubbo.rpc.Invoker argument getUrl() == null");
        
        org.apache.dubbo.common.URL url = arg0.getUrl();
        
        String extName = ( url.getProtocol() == null ? "dubbo" : url.getProtocol() );

        if(extName == null) 
            throw new IllegalStateException("Failed to get extension (org.apache.dubbo.rpc.Protocol) name from url (" + url.toString() + ") use keys([protocol])");
        
        org.apache.dubbo.rpc.Protocol extension = (org.apache.dubbo.rpc.Protocol)ExtensionLoader.getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName);
        
        return extension.export(arg0);
    }

    public org.apache.dubbo.rpc.Invoker refer(java.lang.Class arg0, org.apache.dubbo.common.URL arg1) throws org.apache.dubbo.rpc.RpcException {

        if (arg1 == null) throw new IllegalArgumentException("url == null");

        org.apache.dubbo.common.URL url = arg1;

        String extName = ( url.getProtocol() == null ? "dubbo" : url.getProtocol() );

        if(extName == null) throw new IllegalStateException("Failed to get extension (org.apache.dubbo.rpc.Protocol) name from url (" + url.toString() + ") use keys([protocol])");

        org.apache.dubbo.rpc.Protocol extension = (org.apache.dubbo.rpc.Protocol)ExtensionLoader.getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName);

        return extension.refer(arg0, arg1);
    }
}

这里获取的Protocol/$Adaptive自适应类中，只有export导出服务和refer引入服务进行了Adaptive代理。是因为这两个方法添加了Adaptive注解。通过refer和export的比较可以看出，并不是加了Adaptive注解的就一定可以Adaptive代理，arg1表示资源URL，arg1不能为空也就是说必须包含资源URL对象(无论是直接传入还是其类中存在getUrl方法可以获取到url），其关键就是URL包含的key(extName)的传入。

Activate

Activate注解包含group和value的区分，就是为了匹配得到适用于不同场景的扩展类。
group组分为PROVIDER和CONSUMER，表示该扩展点能在服务提供者端，或消费端使用。
value表示参数的键，当调用getActivateExtension方法来获取扩展类时，如果传入的url中的参数的key中，包括value的值，那么则表示当前url可以使用这个扩展点。

image.png

总结：

dubbo的高度可扩展能力体现在SPI上，SPI的源码实现机制就是通过ExtensionLoader获取指定的实现扩展类。
ExtensionLoader扩展加载类具体的实现就是加载对应的资源文件( 通过目录META-INF/dubbo/internal/、META-INF/dubbo/、META-INF/dubbo/与接口名字拼接的文件)得到扩展类集合。
Adaptive类的生成和作用，Adaptive表示一个Adaptive代理类，可以通过资源URL调用指定扩展类
Activate表示扩展类的使用范围用group组和url参数的键是否含有value来判断
如果需要自定义扩展只要遵循这个规则就可以了。