Dubbo SPI之Adaptive详解

Posted 2023-03-29

参考技术A 为ThriftAdaptiveExt2类添加@Adaptive注解

下面我们带着上面的结论，看一下源码。首先我们从这句话开始讲起

下面是源码的注释

先检查有没有带SPI的注解，没有带，直接报错，从缓存中根据这个类型查询对应的ExtensionLoader，查不到就创建一个，再放入缓存中。dubbo中的spi部分大量利用了本地缓存，后续出现，不再着重讲解了。我们可以看一下他的创建该类型的ExtensionLoader的方法。

关注点有两个，第一个构造方法是私有的，说明不想通过外部实例化，将实例化的过程统一收紧。第二个是objectFactory这个在后面的ioc部分会发挥它的作用，敬请期待。好了，目前为止，ExtensionLoader<AdaptiveExt2> loader = ExtensionLoader.getExtensionLoader(AdaptiveExt2.class) 说的差不多了，下面进入我们的大头getAdaptiveExtension

第一次从缓存中获取就创建

获取到适配器类的Class,利用反射创建适配器类的实例。injectExtension是dubbo的DI，依赖注入。如果适配器类有属性的set方法，会自动注入，这个后续会开一个章节进行解释。看来我们最终要关注的是getAdaptiveExtensionClass方法。大家跟紧了，大片开始了。

按照顺序来吧，看下getExtensionClasses

从缓存中取，也就是说，加载的流程只触发一次，然后放入缓存，后续从缓存取。

获取type上的SPI注解，如果里面有值赋给cachedDefaultName这个变量，相当于是个默认的值。随后从META-INF/dubbo/internal/，META-INF/dubbo/，META-INF/services/这三个路径下搜索对应的文件，什么是对应的？就是命名是这个type类的全限定名称。下面这个方法有点长，希望不要看吐，还好加了注解，希望看起来会通畅点。

路径+文件名，组成了一个具体的文件名，根据 classLoader.getResources 方法获取到Enumeration<java.net.URL> 类型的对象，随后就是遍历,文件里面的格式是这样的。

如果有 # ，按照 # 分割，前面的是我们需要的业务数据，后面是注释。我们所需要的数据中如果有 = ,那么就按照 = 进行分割,前面是这个扩展的名称，后面是这个扩展的全限定类名，方便利用反射加载进来。加载进来之后会判断下是不是传入类（type）类型的实例，不是的话，报错！如果有的类上带有@Adaptive注解，那么将这个类赋值给cachedAdaptiveClass，注意这个点，查询type类型适配器类的时候会优先寻找cachedAdaptiveClass，因为是系统指定的适配器类，优先级最高，可以看下我们上面的测试三，说的就是这种情况。如果有多个实现再类上都打上了@Adaptive注解，会报错：标准的适配器类只能有一个。如果这个扩展类没有打上@Adaptive注解就更有意思了。首先第一步会验证下有没有type这个类型作为入参的构造方法，为什么要这么做？因为Wrapper，有的类型需要包装一下，例如type=Protocol.class 就会看到有DubboProtocol真实的Protocal类,还会有ProtocolFilterWrapper和ProtocolListenerWrapper这种Wrapper类，这种Wrapper类的共同点就是构造函数的入参是type类型，所以在解析的时候有这么一步。如果有这种构造函数的就是Warpper类，将这些Warpper类型的数据放到cachedWrapperClasses这个集合中缓存。如果没有这种类型的构造函数，就是正常的type类型的实例了，如果在文件中没有声明这个扩展的名称（ = 左边的部分），就会根据这个类名创建一个名称。然后进入下一个环节@Activate数据的解析，这个本来是下一节的内容，我们提前了解下吧。查看type类上有没有@Activate注解，如果有的话，将名称与注解放到cachedActivates这个Map中进行缓存。将扩展类和名称放入cachedNames这个Map中进行缓存，将名称和扩展类的class放入传递进来的extensionClasses中，最后这个extensionClasses会被返回出来被使用。OK，到目前为止我们结束了getExtensionClasses方法的讲解，是不是很绕，东西很多。再回来我们看下剩下的。

如果cachedAdaptiveClass不为空就返回，什么情况下不为空？当扩展类上打上@Adaptive注解的时候，就会将这个类直接返回。如果没有上注解，怎么办，就得自己生成了，也就是createAdaptiveExtensionClass

思路很简单，将类以字符串的形式拼接出来，然后利用编译器进行编译，返回编译后的class对象。寻找编译器的过程和具体编译的过程不是我们此次所要关心的，我们关心的是这个createAdaptiveExtensionClassCode方法创建的字符串格式的数据是啥样的，用到了哪些数据。又是一个大方法，也是要走起的，come on

首先寻找这个类中所有的方法，查看方法中有没有打@Adaptive注解的，一个没有，直接报错！对于那些没有加@Adaptive注解的方法，直接在要创建的Adaptive类上增加此方法不支持操作的异常。在方法中的@Adaptive是可以加上value值的，如果用户填了，使用此值，没有填将使用程序根据类名创建的值作为value值，这个value值通URL中的参数名保持一致。defaultExtName是SPI中的value值，这里可以看一下我们的测试四的方法。最后我们看一下，他生成的String是什么样子的

将上面这个字符串编译成Class对象，作为适配器类，返回，然后实例化后，进行依赖注入需要的属性，随后缓存，备下次使用。

基本上所有类型的动态导入都是使用adaptive,使用范围极广。

dubbo-test测试源码

下一篇: Dubbo SPI 之Activate详解

END

Dubbo点滴 SPI入门

spi(service providerinterface)，是DUBBO功能强大的保障。核心支持类ExtensionLoader。

具体分析可以参照<Dubbo原理解析-Dubbo内核实现之基于SPI思想Dubbo内核实现>.

1.比较重要的注解

@SPI:扩展点接口的标识 ：作用域在类上；

@Adaptive:为生成Adaptive实例提供参数，作用域在类或方法上；

@Activate：可以被框架中自动激活加载扩展，此Annotation用于配置扩展被自动激活加载条件。

1.1 测试对象代码

#1.声明SPI 默认为imp1
@SPI("impl1")
public interface SimpleExt {
    // 没有使用key的@Adaptive ！
    @Adaptive
    String echo(URL url, String s);
    
    @Adaptive({"key1", "key2"})
    String yell(URL url, String s);

    // 无@Adaptive ！
    String bang(URL url, int i);
}

//实现类1
public class SimpleExtImpl1 implements SimpleExt {
    public String echo(URL url, String s) {
        return "Ext1Impl1-echo";
    }
    
    public String yell(URL url, String s) {
        return "Ext1Impl1-yell";
    }
    
    public String bang(URL url, int i) {
        return "bang1";
    }
}
//实现类2
public class SimpleExtImpl2 implements SimpleExt {
    public String echo(URL url, String s) {
        return "Ext1Impl2-echo";
    }
    
    public String yell(URL url, String s) {
        return "Ext1Impl2-yell";
    }

    public String bang(URL url, int i) {
        return "bang2";
    }
    
}
//实现类3
public class SimpleExtImpl3 implements SimpleExt {
    public String echo(URL url, String s) {
        return "Ext1Impl3-echo";
    }
    
    public String yell(URL url, String s) {
        return "Ext1Impl3-yell";
    }

    public String bang(URL url, int i) {
        return "bang3";
    }
    
}

1.2 配置文件com.alibaba.dubbo.common.extensionloader.ext1.SimpleExt

位置要放在如下位置

private static final String SERVICES_DIRECTORY = "META-INF/services/";

private static final String DUBBO_DIRECTORY = "META-INF/dubbo/";

private static final String DUBBO_INTERNAL_DIRECTORY = DUBBO_DIRECTORY + "internal/";

具体内容如下

# Comment 1
impl1=com.alibaba.dubbo.common.extensionloader.ext1.impl.SimpleExtImpl1#Hello World
impl2=com.alibaba.dubbo.common.extensionloader.ext1.impl.SimpleExtImpl2  # Comment 2
   impl3=com.alibaba.dubbo.common.extensionloader.ext1.impl.SimpleExtImpl3 # with head space

定义3个实现。

1.4 测试

@Test
public void test_getDefaultExtension() throws Exception {
    SimpleExt ext = ExtensionLoader.getExtensionLoader(SimpleExt.class).getDefaultExtension();
    assertThat(ext, instanceOf(SimpleExtImpl1.class));
    
    String name = ExtensionLoader.getExtensionLoader(SimpleExt.class).getDefaultExtensionName();
    assertEquals("impl1", name);
}

由于@SPI("impl1")，定义了默认实现的名称为imp1.

@Test
public void test_getExtension() throws Exception {
    assertTrue(ExtensionLoader.getExtensionLoader(SimpleExt.class).getExtension("impl1") instanceof SimpleExtImpl1);
    assertTrue(ExtensionLoader.getExtensionLoader(SimpleExt.class).getExtension("impl2") instanceof SimpleExtImpl2);
}

getExtensionLoader(Class<T> type):根据类名，返回具体实现类。这些配置信息在META对应文件中配置。当然，也可以使用@Extention注解配置（只不过，这个注解已经废弃了）

@Test
public void test_getAdaptiveExtension_defaultAdaptiveKey() throws Exception {
    {
        SimpleExt ext = ExtensionLoader.getExtensionLoader(SimpleExt.class).getAdaptiveExtension();

        Map<String, String> map = new HashMap<String, String>();
        //没有指定具体parameters参数，所以选用默认实现，最后返回impl1
        URL url = new URL("p1", "1.2.3.4", 1010, "path1", map);
        //如果不设置默认的SPI实现类，则报异常
        //java.lang.IllegalStateException: Fail to get extension(com.alibaba.dubbo.common.extensionloader.ext1.SimpleExt) name from url(p1://1.2.3.4:1010/path1) use keys([simple.ext])
        String echo = ext.echo(url, "haha");
        assertEquals("Ext1Impl1-echo", echo);
    }

    {
        SimpleExt ext = ExtensionLoader.getExtensionLoader(SimpleExt.class).getAdaptiveExtension();

        Map<String, String> map = new HashMap<String, String>();
        map.put("simple.ext", "impl2");//手动在参数中配置impl2,参数为simple.ext
        URL url = new URL("p1", "1.2.3.4", 1010, "path1", map);

        String echo = ext.echo(url, "haha");
        assertEquals("Ext1Impl2-echo", echo);
    }
}

@Adaptive 测试

由于 yell方法声明了，@Adaptive({"key1", "key2"})

@Test
public void test_getAdaptiveExtension_customizeAdaptiveKey() throws Exception {
    SimpleExt ext = ExtensionLoader.getExtensionLoader(SimpleExt.class).getAdaptiveExtension();

    Map<String, String> map = new HashMap<String, String>();
    map.put("key2", "impl2");
    URL url = new URL("p1", "1.2.3.4", 1010, "path1", map);

    String echo = ext.yell(url, "haha");
    assertEquals("Ext1Impl2-yell", echo);

    url = url.addParameter("key1", "impl3"); // 注意： URL是值类型
    echo = ext.yell(url, "haha");
    assertEquals("Ext1Impl3-yell", echo);
}

如果参数不是key1,key2,即使参数值输入impl1,impl2也是无意义的。

由于bang方法，没有被@Adaptive 修饰，所以以下代码，会报异常

ExtensionLoader.getExtensionLoader(SimpleExt.class).getAdaptiveExtension().bang(..);

of interface com.alibaba.dubbo.common.extensionloader.ext1.SimpleExt is not adaptive method!

以上内容，是通过代码演练的方式，讲解了dubbo SPI机制的威力。
如果对底层实现感兴趣，可参看博客。

参照：Dubbo原理解析-Dubbo内核实现之基于SPI思想Dubbo内核实现

本文出自 “简单” 博客，请务必保留此出处http://dba10g.blog.51cto.com/764602/1880962