Dubbo 微内核 + 插件 模式,得益于 Dubbo SPI 。其中 ExtentionLoader是 Dubbo SPI 最核心的类,它负责扩展点的加载和生命周期管理。
ExtensionLoader 类似于 Java SPI 的 ServiceLoader,负责扩展的加载和生命周期维护,它是 Dubbo SPI 最核心的类。
使用最频繁的 API 有如下几个:
public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type)
-- 获取 type 类对应的 ExtensionLoader
public T getAdaptiveExtension()
-- 获取扩展自适应实例(扩展适配器)。扩展点适配器的实现中,一般会调用下面的 API 来获取指定的扩展点实例
warn: dubbo 中大多数的扩展实例,都是通过扩展点匹配器 AdaptiveExtension 来获取的
public T getExtension(String name)
-- 根据 name 获取指定的扩展实例
public T getDefaultExtension()
-- 获取 @SPI value 中指定的默认扩展点
public List<T> getActivateExtension(URL url, String key)
-- 获取被激活的扩展点集合
举例:
扩展点(Extension Point)
是一个Java的接口。
扩展(Extension)
扩展点的实现类。
扩展实例(Extension Instance)
扩展点实现类的实例。
扩展自适应实例(Extension Adaptive Instance)
扩展适配器。扩展适配器实例就是一个 Extension 的代理,它实现了扩展点接口。在调用扩展点的接口方法时,会根据实际的参数来决定要使用哪个扩展。
@SPI
@SPI 注解作用于扩展点的接口上,表明该接口是一个扩展点,可以被 Dubbo 的ExtentionLoader 加载。如果没有此注解的话, ExtensionLoader.getExtensionLoader(type) 调用会异常。
@Adaptive
com.alibaba.dubbo.rpc.Protocol
为例@SPI("dubbo")
public interface Protocol {
int getDefaultPort();
@Adaptive
<T> Exporter<T> export(Invoker<T> invoker) throws RpcException;
@Adaptive
<T> Invoker<T> refer(Class<T> type, URL url) throws RpcException;
void destroy();
}
Protocol 类上有 @SPI("dubbo"), 含有 4 个方法,其中有 2 个有 @Adaptive 注解。
@SPI("dubbo")
@SPI 表示 Protocol 是一个扩展点。如果 Protocol 类上没有 @SPI 注解的话,试图去加载扩展时,会抛出异常。
"dubbo" 表示 Protocol 的默认扩展点的名称是 "dubbo"
@Adaptive
这里 @Adaptive 用在方法上,表示 export() 与 refer() 方法都是适配方法,Dubbo 会自动为该方法生成适配实现。
而 getDefaultPort() 和 destroy() 方法上没有 @Adaptive 注解,则 Dubbo 在自动生成扩展适配器时,会让这类方法抛出异常。
说明:
Dubbo 自动生成扩展实现的代码参考 ExtensionLoader#createAdaptiveExtensionClassCode()
方法
通过阅读源码,我们可以发现,Dubbo 是通过扩展点适配器在运行时动态选择扩展点实现的,而动态选择的策略是通过 URL 中的参数来决定的。
Duubo 为 Protocol 生成的扩展点适配器(Protocol$Adaptive.class)的代码如下:
package com.alibaba.dubbo.rpc;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
public class Protocol$Adaptive implements com.alibaba.dubbo.rpc.Protocol {
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!");
}
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!");
}
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);
}
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);
}
}
com.alibaba.dubbo.rpc.ProxyFactory
为例@SPI("javassist")
public interface ProxyFactory {
@Adaptive({"proxy"})
<T> T getProxy(Invoker<T> invoker) throws RpcException;
@Adaptive({"proxy"})
<T> T getProxy(Invoker<T> invoker, boolean generic) throws RpcException;
@Adaptive({"proxy"})
<T> Invoker<T> getInvoker(T proxy, Class<T> type, URL url) throws RpcException;
}
ProxyFactory 类上有 @SPI("javassist") 注解,含有 3 个方法,方法上都有 @Adaptive 注解。
url.getParameter("proxy", "javassist")
的扩展点(具体逻辑可以参看源码)。它表示会从 URL 中取参数名为 proxy 对应的值作为最终使用的扩展点名称,如果取不到的话,就默认使用 @SPI("javassist") 中指定的 "javassist" 作为最终使用的扩展点名称。dubbo 为 ProxyFactory 自动生成的扩展适配器(扩展自适应类) ProxyFactory$Adaptive.java 的代码如下 :
package com.alibaba.dubbo.rpc;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
public class ProxyFactory$Adaptive implements com.alibaba.dubbo.rpc.ProxyFactory {
public java.lang.Object getProxy(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.getParameter("proxy", "javassist");
if(extName == null) throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.ProxyFactory) name from url(" + url.toString() + ") use keys([proxy])");
com.alibaba.dubbo.rpc.ProxyFactory extension = (com.alibaba.dubbo.rpc.ProxyFactory)ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.ProxyFactory.class).getExtension(extName);
return extension.getProxy(arg0);
}
public java.lang.Object getProxy(com.alibaba.dubbo.rpc.Invoker arg0, boolean arg1) 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.getParameter("proxy", "javassist");
if(extName == null) throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.ProxyFactory) name from url(" + url.toString() + ") use keys([proxy])");
com.alibaba.dubbo.rpc.ProxyFactory extension = (com.alibaba.dubbo.rpc.ProxyFactory)ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.ProxyFactory.class).getExtension(extName);
return extension.getProxy(arg0, arg1);
}
public com.alibaba.dubbo.rpc.Invoker getInvoker(java.lang.Object arg0, java.lang.Class arg1, com.alibaba.dubbo.common.URL arg2) throws com.alibaba.dubbo.rpc.RpcException {
if (arg2 == null) throw new IllegalArgumentException("url == null");
com.alibaba.dubbo.common.URL url = arg2;
String extName = url.getParameter("proxy", "javassist");
if(extName == null) throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.ProxyFactory) name from url(" + url.toString() + ") use keys([proxy])");
com.alibaba.dubbo.rpc.ProxyFactory extension = (com.alibaba.dubbo.rpc.ProxyFactory)ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.ProxyFactory.class).getExtension(extName);
return extension.getInvoker(arg0, arg1, arg2);
}
}
根据代码 ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension()
来分析 SPI 的加载过程:
a. 如果 v 类上有 @Adaptive 注解,就将 v 赋值给 cachedAdaptiveClass
b. 如果 v 类是装饰类,那么就将 v 添加到 cachedWrapperClasses 中
装饰类:v 类含有一个参数的构造函数,且这个参数为 SPI 接口 type,这里为 Protocol.class
clazz.getConstructor(type);
c. 如果前端的情况都不满足,且 v 有默认的构造函数
则检查扩展点的 name 是否有值,没有值的话就,取 v 上的 @Extension 注解的 value();没有 @Extension 注解,就取 v 类的简称的小写(simpleName - type.simpleName)
获取 v 类上的 @Activate 注解,有值的话就存放到 cachedActivates 里面(cachedActivates.put(names[0], activate),@Activate 是用来激活指定的扩展点的)
将 v 缓存到 cachedNames 中 (cachedNames.put(clazz, name))
将 v 缓存到 cachedClasses 中 (extensionClasses.put(name, clazz))
public List<T> getActivateExtension(URL url, String[] values, String group) {
List<T> exts = new ArrayList<T>();
List<String> names = values == null ? new ArrayList<String>(0) : Arrays.asList(values);
// 添加框架默认激活的扩展点
if (!names.contains(Constants.REMOVE_VALUE_PREFIX + Constants.DEFAULT_KEY)) {
getExtensionClasses();
for (Map.Entry<String, Activate> entry : cachedActivates.entrySet()) {
String name = entry.getKey();
Activate activate = entry.getValue();
if (isMatchGroup(group, activate.group())) {
T ext = getExtension(name);
if (!names.contains(name) /* 添加默认激活的扩展点,需要排除指定激活的 */
&& !names.contains(Constants.REMOVE_VALUE_PREFIX + name)
&& isActive(activate, url)) {
exts.add(ext);
}
}
}
Collections.sort(exts, ActivateComparator.COMPARATOR);
}
// 添加 url 中指定激活的扩展点
List<T> usrs = new ArrayList<T>();
for (int i = 0; i < names.size(); i++) {
String name = names.get(i);
if (!name.startsWith(Constants.REMOVE_VALUE_PREFIX)
&& !names.contains(Constants.REMOVE_VALUE_PREFIX + name)) {
if (Constants.DEFAULT_KEY.equals(name)) {
if (!usrs.isEmpty()) {
exts.addAll(0, usrs);
usrs.clear();
}
} else {
T ext = getExtension(name);
usrs.add(ext);
}
}
}
if (!usrs.isEmpty()) {
exts.addAll(usrs);
}
return exts;
}
参考:
@see: http://dubbo.apache.org/zh-cn/blog/introduction-to-dubbo-spi.html
@see: http://dubbo.apache.org/zh-cn/blog/introduction-to-dubbo-spi-2.html
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。