Dubbo的自适应扩展原理
- Dubbo支持多种协议,多种序列化方式,多注册中心等等,使用起来非常的灵活简便。内置了很多常见的组件,比如协议支持dubbo, redis,thrift,grpc,hessian等,也支持用户自定义协议去完成业务功能。这种灵活便捷,正是Dubbo的SPI带来的好处。有时,有些扩展我们不想在框架启动时就直接加载,而是希望在扩展方法被调用的时候,根据运行时的参数去加载具体的扩展类。这么一说,是不是很快就想到了一种实现方式:动态代理。我们可以直接根据每一个SPI接口,封装出一个代理类,由代理类去找到对应的扩展实现,然后调用扩展方法。我们来举一个例子说明这个问题:
/**
* 接口:Reporter,有两个实现类ChineseReporter, EnglishReporter
*/
interface Reporter {
String report(URL url);
}
class ChineseReporter implements Reporter {
@Override
String report(URL url) {
return "你好";
}
}
class EnglishReporter implements Reporter {
@Override
String report(URL url) {
return "hello";
}
}
- 现在我们如果想根据传入的url参数中属性nation,来决定初始化对应实例,调用该方法,应该怎么做呢,是不是要新编写一个代理类,来帮助我们完成这个功能
public class AdaptiveReporter implements Reporter {
@Override
public String report(URL url) {
if (url == null) {
throw new IllegalArgumentException("url == null");
}
// 1.从 URL 中获取 nation 名称
String nation = url.getParameter("nation");
if (nation == null) {
throw new IllegalArgumentException("nation == null");
}
// 2.通过 SPI 加载具体的 Reporter, 如果传入的nation是chinese,得到就是ChineseReporter,如果传入的是english,得到的就是EnglishReporter
Reporter reporter = ExtensionLoader
.getExtensionLoader(Reporter.class).getExtension(nation);
// 3.调用目标方法
return reporter.report(url);
}
}
- Dubbo的自适应扩展正是这么实现的,只不过这里我们不需要主动为每一个SPI接口编写代理类,而是由Dubbo自动为我们生成具有代理功能的代码,通过javassist或者jdk编译这个代理类,得到Class对象,通过反射创建出代理实例。
源码分析(apache dubbo 2.7.8)
- 自使用扩展实现中有一个很重要的注解@Adaptive,先来看一下它的说明
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({
ElementType.TYPE, ElementType.METHOD})
public @interface Adaptive {
/**
* Decide which target extension to be injected. The name of the target extension is decided by the parameter * passed in the URL, and the parameter names are given by this method.
* 决定要注入哪个目标扩展。目标扩展名由URL中传递的参数决定,参数名由该方法给出。
* If the specified parameters are not found from URL, then the default extension will be used for dependency *injection (specified in its interface's SPI).
* 如果在URL中找不到指定的参数,那么默认扩展将用于依赖项注入(在其接口的SPI中指定)。
* For example, given String[] {"key1", "key2"}:
* 1. find parameter 'key1' in URL, use its value as the extension's name
* 在url上找到key1对应的value,作为扩展类的name
* 2. try 'key2' for extension's name if 'key1' is not found (or its value is empty) in URL
* 如果key1对应的value为空或者key1不存在,尝试使用key2
* 3. use default extension if 'key2' doesn't exist either
* key2也不存在,那么使用默认的扩展name,SPI上指定的
* 4. otherwise, throw IllegalStateException
* 否则,抛出异常
* If the parameter names are empty, then a default parameter name is generated from interface's class name with *the rule: divide classname from capital char into several parts, and separate the parts with dot '.', for *example, for org.apache.dubbo.xxx.YyyInvokerWrapper, the generated name is String[] {"yyy.invoker.wrapper"}.
* 如果该参数为空,会从接口的名称上生成一个name
* @return parameter names in URL 返回URL对应的参数名
*/
String[] value() default {
};
- Adaptive注解