用ExtensionLoader获取配置文件提供的接口实例
AdaptiveApi adaptiveExtension = ExtensionLoader.getExtensionLoader(AdaptiveApi.class).getAdaptiveExtension();
adaptiveExtension.doSomething();
源码解析
1.ExtensionLoader.getExtensionLoader(AdaptiveApi.class)
ExtensionLoader的静态方法getExtensionLoader返回了一个对应接口的ExtensionLoader。每一个接口类型都会创建一个与接口对应的ExtensionLoader类,用于获取配置文件配置的各种该接口的实现类实例
在ExtensionLoader大管家里维护了一个所有SPI提供的接口对应的ExtensionLoader的ConcurrentMap,先get,如果没有则创建一个,并放入缓存,下次进来直接从缓存。
getExtensionLoader(Class clazz)
1. getExtensionClasses() 加载所有本地文件配置的类
先从缓存拿，拿不到从本地文件中加载key和类的关系
loadExtensionClasses()
- 先看看接口上有没有@SPI注解,有的话,把这个注解里的value记下来,放在cachedDefaultName
其实是为这个api做准备的,用cachedDefaultName从key和class的map中拿对应的类实例
ExtensionLoader.getExtensionLoader(AdaptiveApi.class).getDefaultExtension()
- 接下来从三个路径中加载类,放extensionClasses这个容器中
- META-INF/services/
- META-INF/dubbo/
- META-INF/dubbo/internal
2.1. 根据路径,一个文件一个文件的读
比如：META-INF/dubbo/internal
[图片上传失败...(image-ef1d32-1625497807814)]
读单个文件 loadResource
[图片上传失败...(image-a55c9-1625497807814)]
读到key和对应的接口全限定名,判断实现类
- 如果类类型和接口类型不一致，报错
- 如果类上面有@Adaptive注解,那么放到Extension的cachedAdaptiveClass上，ExtensionLoader.getExtensionLoader(AdaptiveApi.class).getAdaptiveExtension()返回的就是这个类的实例
- 判断是否是一个包装类,所有包装类的格式都是持有目标接口的引用，并且有一个这样的构造函数
比如Protocol接口的本地文件的第一行配置的这个类
ProtocolFilterWrapper
判断是否是包装类,反射掉这个构造函数不报错,就是包装类
如果是包装类,加到一个容器中cachedWrapperClasses
- 建立名称和类的关系extensionClasses
先是获取name,
如果配置文件里没有配置name,比如说这两个
那么看你有没有@Extension,有就返回该注解配置的value，没有就用类名称的小写做为name
接下来判断该类上是否有@Activate注解,有的话放到cachedActivates这个map中
只有所有的类都会放到cachedNames这个容器中,保存的是建立类和名称的关系
到这里所有的类都加载到了Extension类的各种容器中。
cachedAdaptiveInstance ： 放置适合的接口实例
cachedAdaptiveClass ： 适合的接口实例的class对象
cachedClasses ： 所有该实现实现类的class对象
cachedNames ： 类和名称的关系
cachedWrapperClasses ： 所有的包装类class
cachedDefaultName : 接口上@SPI配置的默认实现类名
2.ExtensionLoader.getExtensionLoader(AdaptiveApi.class).getAdaptiveExtension()
获取到接口对应的ExtensionLoader实例之后,用getAdaptiveExtension获取一个适合的接口实例
一样的套路,先存缓存里拿,拿不到创建,再放入缓存
createAdaptiveExtension() : 创建接口实例
第一次进来肯定是拿不到的,看下如何创建接口实例的
分为两部,第一步获取实例,第二部属性依赖输入
- 获取实例类,并反射创建实例
getAdaptiveExtensionClass()
先加载所有的SPI配置文件里配置的类,如果找到@Adaptive注解的类,那么ExtensionLoader中的cachedAdaptiveClass会有值,直接返回
如果所有的实现类上都没有@Adaptive注解,那么,dubbo将会用StringBuilder拼接出接口实现类的代码字符串,并用javaassist编译拼凑出的类,反射实例化.前提是接口中的某个方法有@Adaptive 注解
导包,然后先搞一个头出来
public class 接口名$Adaptive implements 接口 {
后面就一个方法的代码,注意,如果你得方法上没有@Adaptive注解,那么生成的方法实现上是直接抛一个异常
最终生成的类是这样子的
package com.alibaba.dubbo.rpc;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
public class Protocol$Adaptive implements com.alibaba.dubbo.rpc.Protocol {
// 接口上有@Adaptive
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);
}
// 接口上有@Adaptive
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);
}
// 接口上没有@Adaptive,调这个方法的话都是直接抛异常的
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!");
}
//接口上没有@Adaptive,调这个方法的话都是直接抛异常的
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!");
}
}
可以看到,这个生成的类中,原来接口方法上有@Adaptive注解的话,都是用的spi根据名称去获取拓展类实例
com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol) ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName)
ExtensionLoader.getExtension(String name) 这个方法有可能返回的是个包装类
先是完成该类的实例的属性注入
然后获取这个接口的所有包装类,进行层层的包装
最后返回的是这样子的一个对象链,所有对该实例的调用都会先经过包装类进行其他操作。
总结 ： 最后如果你某个配置的实现类上有@Adaptive注解,或者接口的某个方法有@Adaptive注解,都会得到一个实现类的实例,剩下的就是属性注入.
最后如果你某个配置的实现类上有@Adaptive注解,或者接口的某个方法有@Adaptive注解,都会得到一个实现类的实例,剩下的就是属性注入.
injectExtension 属性注入
如果类的方法是以set开头的,那么反射调这个方法。
setXXX方法上有@DisableInject,不调
接下来先是获取参数类型,然后获取要赋值的属性名称,就是方法名去掉set后首字母小写
比如 ：
setUserName ==> userName
最后用变量objectFactory的getExtension根据参数类型和属性名称获取对应的值,用来反射setXXX方法
这里需要注意的是,objectFactory的实例化是在ExtensionFactory的构造方法里完成的,同样的是用的ExtensionLoader的api获取ExtensionFactory接口的拓展类
这里ExtensionFactory的拓展类目前只有两个dubbo内置的SpiExtensionFactory和spring方式的SpringExtensionFactory
- SpiExtensionFactory用dubbo spi的方式从本地文件中获取到需要注入的实例。
- SpringExtensionFactory 则是从spring容器中获取bean用来注入
如果你以后想从别的地方获取bean用来注入,那么请按照规则配置ExtensionFactory的实现类即可。
其他api
在Extension加载完所有的类之后,其他的api无非就是从Extension的各种容器里取。
总结
SPI是一种服务发现机制，提供了动态发现实现类的能力，体现了分层解耦的思想。
在架构设计和代码编写过程中，模块之间应该针对接口编程，避免直接引用具体的实现类，可达到可插拔的效果。