本文基于dubbo 2.7.5版本代码
SPI核心类ExtensionLoader详解
提到dubbo必须介绍SPI。网络上有很多介绍SPI原理的文章,可以参见官方文档:
http://dubbo.apache.org/zh-cn/docs/source_code_guide/dubbo-spi.html
SPI提供了一种插件功能,可以对组件替换。dubbo的各层中,除了服务代理层和配置层之外,其他层组件都可以使用SPI替换。
本文介绍SPI的核心类ExtensionLoader中最常用的三个方法。
一、getExtension方法
dubbo中,每个Class有对应ExtensionLoader对象,通过静态方法getExtensionLoader得到,ExtensionLoader对象通过getExtension方法获得对应类型的组件对象,getExtension方法的入参是组件对象的名字。
比如下面的代码用于获得名字为“spring”的容器组件对象。
ExtensionLoader.getExtensionLoader(Container.class).getExtension("spring");
下面的流程图以代码上述代码为例。
在上图的中要搜索文件和目录,搜索的文件名为ExtensionLoader.getExtensionLoader方法入参的全限定类名。例如入参Container.class,那么对应的文件名是org.apache.dubbo.container.Container。目录可以参考代码ExtensionLoader.loadExtensionClasses,这个方法指定了搜索目录:
- META-INF/dubbo/internal/
- META-INF/dubbo/
- META-INF/services/
我们来看一下文件org.apache.dubbo.container.Container里面的内容:
spring=org.apache.dubbo.container.spring.SpringContainer
log4j=org.apache.dubbo.container.log4j.Log4jContainer
logback=org.apache.dubbo.container.logback.LogbackContainer
等号前面的是对象名字,所以就上面的例子来说,我们要找的是名字为spring的对象,也就是SpringContainer。如果在多个目录下有相同的文件名,且有多个相同的对象名字,那么后加载的会覆盖前面的。
方法getExtensionLoader的入参为接口,要使用SPI加载对象,接口必须有@SPI注解。SPI注解的value值表示要加载对象的默认名字。可以使用getDefaultExtension方法加载默认名字对应的对象。比如Container接口默认对象名字是spring,如果使用getDefaultExtension方法加载对象,那么和getExtension(“spring”)加载的对象是一样的。
除了getDefaultExtension,getExtension方法,还有getActivateExtension和getAdaptiveExtension。
二、getActivateExtension方法
getActivateExtension可以一次性加载多个对象,可以参考接口Filter。使用该方法要求接口的实现类必须有@Activate注解,如果@Activate的value和group与getActivateExtension入参一致,那么getActivateExtension方法会返回一个包含该对象的List集合。
三、getAdaptiveExtension方法
getAdaptiveExtension方法一般会通过代码生成模块生成一个Adaptive类型的类,并实例化对象。代码生成是AdaptiveClassCodeGenerator类完成的。Adaptive类的方法需要有@Adaptive注解,没有Adaptive注解的方法在自动生成的代码里面会抛出UnsupportedOperationException。Adaptive类型的对象是自适应对象,Adaptive注解的方法入参是URL或者包含URL属性的对象,Adaptive注解的value值为URL的属性名,属性名对应的值就是要加载的对象名,如果URL中不包含Adaptive注解指定的值,那么使用Adaptive类型类的接口的SPI注解的value值作为默认值。