一.原理
java的spi可以实现多个实现类的定义，返回list.dubbo的spi实现了更多功能.
1.返回kv格式，可以获取指定key的接口实现类.
2.实现了ioc的功能.通过已有接口实现类或者接口代理类，注入到成员中。在调用方法参数的url的map中指定具体调用哪个实现类的方法。注入的成员类中必须Adaptive注解,标识注入时通过map的哪个key指定实现类.
3.实现了aop的功能.通过把接口实现类注入到wrapper类的构造方法的参数中，在wrapper类方法调用时，可以先调用wrapper的before功能，再调用真正实现类的功能.
二.测试用例
测试代码如下：
修改dubbo-demo包下,dubbo-demo-api包下的测试用例.
private static void testSpi() {
ExtensionLoader<UserService> extensionLoader = ExtensionLoader.getExtensionLoader(UserService.class);
UserService teachar = extensionLoader.getExtension("teacher");
teachar.callTelephone();
}
@SPI
public interface UserService {
int callTelephone();
}
public class TeacherService implements UserService {
//测试IOC注入,这里注入TelephoneService$Adaptive代理类
private TelephoneService telephoneService;
public void setTelephoneService(TelephoneService telephoneService) {
this.telephoneService = telephoneService;
}
@Override
public int callTelephone() {
System.out.println("teachar call telephone");
//通过URL里面的map区分调用成员接口的哪个实现类
Map<String, String> parameters = new HashMap<>();
parameters.put("telephoneService", "apple");
URL url = new URL("", "", 1, parameters);
telephoneService.call(url,123);
return 1;
}
}
@SPI
public interface TelephoneService {
// url的map中传入的key的名称
@Adaptive("telephoneService")
void call(URL url, int phonenum);
}
public class UserServiceWrapper implements UserService {
// 测试AOP
private UserService userService;
//传入aop拦截的接口的具体实现类
public UserServiceWrapper(UserService userService) {
this.userService = userService;
}
@Override
public int callTelephone() {
System.out.println("userService wrapper before");
return userService.callTelephone();
}
}
三.源码细节
(一).获取ExtensionLoader
进入ExtensionLoader.getExtensionLoader方法.3.2版本源码加了ExtensionAccessor、ExtensionDirector的封装，但不影响核心逻辑.
测试代码是ServiceConfig的成员protocl,初始化代码为
Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();
加载dubbo的Protocol接口的ExtensionLoader.
ExtensionLoader#getExtensionLoader()方法,入参为Protocol接口。代码如下:
public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type) {
//接口不能为空
if (type == null)
throw new IllegalArgumentException("Extension type == null");
//传入type必须是接口
if (!type.isInterface()) {
throw new IllegalArgumentException("Extension type(" + type + ") is not interface!");
}
//接口必须带有@spi注解
if (!withExtensionAnnotation(type)) {
throw new IllegalArgumentException("Extension type(" + type +
") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!");
}
//在缓存ExtensionLoader#EXTENSION_LOADERS是否已经有loader了，没有再创建
ExtensionLoader<T> loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
if (loader == null) {
//创建ExtensionLoader,操作都在构造方法里面.构造方法在下面代码.
EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
}
return loader;
}private ExtensionLoader(Class<?> type) {
this.type = type;
//第一次使用ExtensionLoader,先创建ExtensionFactory接口工厂的ExtensionLoader.
//然后调用ExtensionLoader#getAdaptiveExtension()获取ExtensionFactory的实例.
objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());
}(二).获取实例对象getExtension
1.进入ExtensionLoader.getExtension().
public T getExtension(String name, boolean wrap) {
checkDestroyed();
if (StringUtils.isEmpty(name)) {
throw new IllegalArgumentException("Extension name == null");
}
if ("true".equals(name)) {
return getDefaultExtension();
}
String cacheKey = name;
if (!wrap) {
cacheKey += "_origin";
}
final Holder<Object> holder = getOrCreateHolder(cacheKey);
Object instance = holder.get();
if (instance == null) {
synchronized (holder) {
instance = holder.get();
if (instance == null) {
// 创建目标接口的实例
instance = createExtension(name, wrap);
holder.set(instance);
}
}
}
return (T) instance;
}2.进入ExtensionLoader#createExtension方法.
类似spring的getBean方法，比2.X版本加入了实例化的before和after回调.
private T createExtension(String name, boolean wrap) {
Class<?> clazz = getExtensionClasses().get(name);
if (clazz == null || unacceptableExceptions.contains(name)) {
throw findException(name);
}
try {
T instance = (T) extensionInstances.get(clazz);
if (instance == null) {
extensionInstances.putIfAbsent(clazz, createExtensionInstance(clazz));
instance = (T) extensionInstances.get(clazz);
// 实例化before回调
instance = postProcessBeforeInitialization(instance, name);
// 接口实例化，注入成员属性
injectExtension(instance);
// 实例化after回调
instance = postProcessAfterInitialization(instance, name);
}
if (wrap) {
List<Class<?>> wrapperClassesList = new ArrayList<>();
if (cachedWrapperClasses != null) {
wrapperClassesList.addAll(cachedWrapperClasses);
wrapperClassesList.sort(WrapperComparator.COMPARATOR);
Collections.reverse(wrapperClassesList);
}
if (CollectionUtils.isNotEmpty(wrapperClassesList)) {
for (Class<?> wrapperClass : wrapperClassesList) {
Wrapper wrapper = wrapperClass.getAnnotation(Wrapper.class);
boolean match = (wrapper == null)
|| ((ArrayUtils.isEmpty(wrapper.matches())
|| ArrayUtils.contains(wrapper.matches(), name))
&& !ArrayUtils.contains(wrapper.mismatches(), name));
if (match) {
instance = injectExtension(
(T) wrapperClass.getConstructor(type).newInstance(instance));
instance = postProcessAfterInitialization(instance, name);
}
}
}
}
// Warning: After an instance of Lifecycle is wrapped by cachedWrapperClasses, it may not still be Lifecycle
// instance, this application may not invoke the lifecycle.initialize hook.
initExtension(instance);
return instance;
} catch (Throwable t) {
throw new IllegalStateException(
"Extension instance (name: " + name + ", class: " + type + ") couldn't be instantiated: "
+ t.getMessage(),
t);
}
}3.调用org.apache.dubbo.common.extension.ExtensionLoader#injectExtension方法注入成员
private T injectExtension(T instance) {
if (injector == null) {
return instance;
}
try {
for (Method method : instance.getClass().getMethods()) {
if (!isSetter(method)) {
continue;
}
/**
* Check {@link DisableInject} to see if we need auto-injection for this property
*/
if (method.isAnnotationPresent(DisableInject.class)) {
continue;
}
// When spiXXX implements ScopeModelAware, ExtensionAccessorAware,
// the setXXX of ScopeModelAware and ExtensionAccessorAware does not need to be injected
if (method.getDeclaringClass() == ScopeModelAware.class) {
continue;
}
if (instance instanceof ScopeModelAware || instance instanceof ExtensionAccessorAware) {
if (ignoredInjectMethodsDesc.contains(ReflectUtils.getDesc(method))) {
continue;
}
}
Class<?> pt = method.getParameterTypes()[0];
if (ReflectUtils.isPrimitives(pt)) {
continue;
}
try {
// 获取setter方法对应的具体成员属性名
String property = getSetterProperty(method);
//获取要注入的成员的实例对象，测试代码是UserService中有个telephoneService接口的成员
Object object = injector.getInstance(pt, property);
if (object != null) {
//调用成员的setter方法
method.invoke(instance, object);
}
} catch (Exception e) {
logger.error(
COMMON_ERROR_LOAD_EXTENSION,
"",
"",
"Failed to inject via method " + method.getName() + " of interface " + type.getName() + ": "
+ e.getMessage(),
e);
}
}
} catch (Exception e) {
logger.error(COMMON_ERROR_LOAD_EXTENSION, "", "", e.getMessage(), e);
}
return instance;
}4.进入org.apache.dubbo.common.extension.inject.SpiExtensionInjector#getInstance方法注入目标接口的实现类中，成员属性的实例.核心逻辑在ExtensionLoader#getAdaptiveExtension().
public <T> T getInstance(final Class<T> type, final String name) {
if (!type.isInterface() || !type.isAnnotationPresent(SPI.class)) {
return null;
}
ExtensionLoader<T> loader = extensionAccessor.getExtensionLoader(type);
if (loader == null) {
return null;
}
//getSupportedExtensions方法会扫描resource目录,创建注入成员的实例.
if (!loader.getSupportedExtensions().isEmpty()) {
// 获取注入的成员的实例
return loader.getAdaptiveExtension();
}
return null;
}
public T getAdaptiveExtension() {
checkDestroyed();
Object instance = cachedAdaptiveInstance.get();
if (instance == null) {
if (createAdaptiveInstanceError != null) {
throw new IllegalStateException(
"Failed to create adaptive instance: " + createAdaptiveInstanceError.toString(),
createAdaptiveInstanceError);
}
synchronized (cachedAdaptiveInstance) {
instance = cachedAdaptiveInstance.get();
if (instance == null) {
try {
// 获取注入的成员的实例
instance = createAdaptiveExtension();
cachedAdaptiveInstance.set(instance);
} catch (Throwable t) {
createAdaptiveInstanceError = t;
throw new IllegalStateException("Failed to create adaptive instance: " + t.toString(), t);
}
}
}
}
return (T) instance;
}5.创建目标接口的需要注入的成员的实例,入口 ExtensionLoader#createAdaptiveExtension.在这个方法中
实例化被注入的成员,这里是创建一个代理对象,如果成员接口中的实现类中没有Adaptive标识的类。代码如下图,这里先调用ExtensionLoader#getAdaptiveExtensionClass()方法调用成员的构造方法,然后一次调用实例化方法的before和after回调.
6.目标接口成员telephoneService的构造方法调用,入口ExtensionLoader#getAdaptiveExtensionClass()
private Class<?> getAdaptiveExtensionClass() {
//获取扩展类,在6.1处分析
getExtensionClasses();
if (cachedAdaptiveClass != null) {
//如果有带Adaptive注解的,优先返回有带Adaptive注解的实现类
return cachedAdaptiveClass;
}
//Protocol接口的实现类没有@Adaptive注解的，进到这里,创建代理类
return cachedAdaptiveClass = createAdaptiveExtensionClass();
}6.1.方法ExtensionLoader#getExtensionClasses()获取接口的所有实现类
private Map<String, Class<?>> getExtensionClasses() {
Map<String, Class<?>> classes = cachedClasses.get();
if (classes == null) {
synchronized (cachedClasses) {
classes = cachedClasses.get();
if (classes == null) {
//读取扩展接口文件,加载,代码在下面
classes = loadExtensionClasses();
//对于ExtensionFactory,这里有两个,SpiExtensionFactory和SpringExtensionFactory.
cachedClasses.set(classes);
}
}
}
return classes;
}6.1.1.读取spi文件的接口的所有的实现类
入口是ExtensionLoader#loadExtensionClasses(),
6.1.1.1 dubbo的2.X版本代码如下.
(1).
private Map<String, Class<?>> loadExtensionClasses() {
//获取接口的spi注解,比如ExtensionFactory,Protocol
final SPI defaultAnnotation = type.getAnnotation(SPI.class);
if (defaultAnnotation != null) {
//获取扩展默认加载哪个实现类.
String value = defaultAnnotation.value();
if (value != null && (value = value.trim()).length() > 0) {
String[] names = NAME_SEPARATOR.split(value);
if (names.length > 1) {
throw new IllegalStateException("more than 1 default extension name on extension " + type.getName()
+ ": " + Arrays.toString(names));
}
if (names.length == 1) cachedDefaultName = names[0];
}
}
Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();
//加载META-INF/dubbo/internal/目录下的扩展文件
loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY);
//加载META-INF/dubbo/目录下的扩展文件
loadFile(extensionClasses, DUBBO_DIRECTORY);
//加载META-INF/services/目录下的扩展文件
loadFile(extensionClasses, SERVICES_DIRECTORY);
return extensionClasses;
}(2).读取文件,入口是ExtensionLoader#loadFile().加载到的实现类都放到extensionClasses.key是别名，value是实现类.
private void loadFile(Map<String, Class<?>> extensionClasses, String dir) {
//格式是META-INF/dubbo/internal/com.alibaba.dubbo.common.extension.ExtensionFactory
//目录名+接口路径文件名
String fileName = dir + type.getName();
try {
Enumeration<java.net.URL> urls;
//调用ExtensionLoader.class.getClassLoader()获取ClassLoader
ClassLoader classLoader = findClassLoader();
if (classLoader != null) {
//获取文件路径的url格式
urls = classLoader.getResources(fileName);
} else {
urls = ClassLoader.getSystemResources(fileName);
}
if (urls != null) {
//遍历所有文件路径的url
while (urls.hasMoreElements()) {
/* 接口文件的本地磁盘路径file:/xxx/dubbo-config/xxx/internal/xxx.ExtensionFactory格式 */
java.net.URL url = urls.nextElement();
try {
BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), "utf-8"));
try {
/* 一行行遍历接口文件,对于ExtensionFactory接口，在dubbo-config只有下面一行 spring=com.alibaba.dubbo.config.spring.extension.SpringExtensionFactory
在dubbo-common下面有adaptive=com.alibaba.dubbo.common.extension.factory.AdaptiveExtensionFactory
spi=com.alibaba.dubbo.common.extension.factory.SpiExtensionFactory两行 */
String line = null;
while ((line = reader.readLine()) != null) {
// 切分#号隔开
final int ci = line.indexOf('#');
if (ci >= 0) line = line.substring(0, ci);
line = line.trim();
if (line.length() > 0) {
try {
String name = null;
int i = line.indexOf('=');
if (i > 0) {
//取出name别名部分
name = line.substring(0, i).trim();
//接口实现类赋值给line，这里是SpringExtensionFactory类全路径
line = line.substring(i + 1).trim();
}
if (line.length() > 0) {
//创建实现类的Class对象
Class<?> clazz = Class.forName(line, true, classLoader);
//判断实现类是否是该接口的
if (!type.isAssignableFrom(clazz)) {
throw new IllegalStateException("Error when load extension class(interface: " +
type + ", class line: " + clazz.getName() + "), class "
+ clazz.getName() + "is not subtype of interface.");
}
//实现类上是否有Adaptive注解
if (clazz.isAnnotationPresent(Adaptive.class)) {
if (cachedAdaptiveClass == null) {
//有Adaptive注解的放到成员cachedAdaptiveClass里面,这个优先级最高
cachedAdaptiveClass = clazz;
} else if (!cachedAdaptiveClass.equals(clazz)) {
throw new IllegalStateException("More than 1 adaptive class found: "
+ cachedAdaptiveClass.getClass().getName()
+ ", " + clazz.getClass().getName());
}
} else {
try {
//实现类是否有参数为本接口类型的构造方法，这样后面可以把多个实现类链接起来
clazz.getConstructor(type);
Set<Class<?>> wrappers = cachedWrapperClasses;
if (wrappers == null) {
cachedWrapperClasses = new ConcurrentHashSet<Class<?>>();
wrappers = cachedWrapperClasses;
}
wrappers.add(clazz);
} catch (NoSuchMethodException e) {
//实现类是否有无参构造方法
clazz.getConstructor();
if (name == null || name.length() == 0) {
name = findAnnotationName(clazz);
if (name == null || name.length() == 0) {
if (clazz.getSimpleName().length() > type.getSimpleName().length()
&& clazz.getSimpleName().endsWith(type.getSimpleName())) {
name = clazz.getSimpleName().substring(0, clazz.getSimpleName().length() - type.getSimpleName().length()).toLowerCase();
} else {
throw new IllegalStateException("No such extension name for the class " + clazz.getName() + " in the config " + url);
}
}
}
//做正则表达式匹配name,对于SpringExtensionFactory,这里是spring
String[] names = NAME_SEPARATOR.split(name);
if (names != null && names.length > 0) {
Activate activate = clazz.getAnnotation(Activate.class);
if (activate != null) {
//如果实现类有Activate注解，加入cachedActivates缓存.
cachedActivates.put(names[0], activate);
}
for (String n : names) {
if (!cachedNames.containsKey(clazz)) {
//加入已经解析的名称缓存cachedNames
cachedNames.put(clazz, n);
}
Class<?> c = extensionClasses.get(n);
if (c == null) {
//加入已经解析过得接口拓展类缓存
extensionClasses.put(n, clazz);
} else if (c != clazz) {
throw new IllegalStateException("Duplicate extension " + type.getName() + " name " + n + " on " + c.getName() + " and " + clazz.getName());
}
}
}
}
}
}
} catch (Throwable t) {
...
}
}
} // end of while read lines
} finally {
//关闭读文件句柄
reader.close();
}
} catch (Throwable t) {
...
}
} // end of while urls
}
} catch (Throwable t) {
...
}
}6.1.1.2 dubbo的3.X版本代码如下.
在上面4处ExtensionLoader#getSupportedExtensions()第一次进这个方法，扫描resource目录，创建url的set
.然后调用ExtensionLoader#getAdaptiveExtension创建注入成员的实例，这里取缓存中的对象.依次进入ExtensionLoader#getExtensionClasses->ExtensionLoader#loadExtensionClasses
6.2 创建接口的代理类，从前面的6处调用过来，
6.2.1 dubbo的2.X版本的代码如下.这里创建telephoneService接口的代理类.
private Class<?> createAdaptiveExtensionClass() {
//代码在下面分析,Protocol这里返回Protocol$Adaptive类的实现代码字串
String code = createAdaptiveExtensionClassCode();
//获取当前类的ClassLoader
ClassLoader classLoader = findClassLoader();
//获取Compiler接口的实现类JavassistCompiler
com.alibaba.dubbo.common.compiler.Compiler compiler = ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();
//调用Compiler接口的实现类JavassistCompiler把上面的字符串代码编译成Class
return compiler.compile(code, classLoader);
}创建扩展类的字符串代码最后生成的字符串如下图,
代码如下:
private String createAdaptiveExtensionClassCode() {
StringBuilder codeBuidler = new StringBuilder();
//获取接口内部的类，比如Protocol接口的类
Method[] methods = type.getMethods();
boolean hasAdaptiveAnnotation = false;
//遍历所有方法，判断是否有带@Adaptive注解的方法
for (Method m : methods) {
if (m.isAnnotationPresent(Adaptive.class)) {
hasAdaptiveAnnotation = true;
break;
}
}
// no need to generate adaptive class since there's no adaptive method found.
//所有类都没有adaptive方法，则抛出异常
if (!hasAdaptiveAnnotation)
throw new IllegalStateException("No adaptive method on extension " + type.getName() + ", refuse to create the adaptive class!");
codeBuidler.append("package " + type.getPackage().getName() + ";");
codeBuidler.append("\nimport " + ExtensionLoader.class.getName() + ";");
codeBuidler.append("\npublic class " + type.getSimpleName() + "$Adaptive" + " implements " + type.getCanonicalName() + " {");
for (Method method : methods) {
//返回值类型
Class<?> rt = method.getReturnType();
//参数类型
Class<?>[] pts = method.getParameterTypes();
//方法抛出的异常类型
Class<?>[] ets = method.getExceptionTypes();
//获取方法上的Adaptive注解
Adaptive adaptiveAnnotation = method.getAnnotation(Adaptive.class);
StringBuilder code = new StringBuilder(512);
if (adaptiveAnnotation == null) {
//没有Adaptive注解
code.append("throw new UnsupportedOperationException(\"method ")
.append(method.toString()).append(" of interface ")
.append(type.getName()).append(" is not adaptive method!\");");
} else {
//有Adaptive注解的
int urlTypeIndex = -1;
//取出参数类型是url的参数位置索引
for (int i = 0; i < pts.length; ++i) {
if (pts[i].equals(URL.class)) {
urlTypeIndex = i;
break;
}
}
// found parameter in URL type
if (urlTypeIndex != -1) {
//参数中有url类型的
// Null Point check
String s = String.format("\nif (arg%d == null) throw new IllegalArgumentException(\"url == null\");",
urlTypeIndex);
code.append(s);
s = String.format("\n%s url = arg%d;", URL.class.getName(), urlTypeIndex);
code.append(s);
}
// did not find parameter in URL type
else {
//参数中没有url类型的,比如Protocol#export(Invoker invoker).没有url参数,带有@Adaptive注解,返回Exporter
String attribMethod = null;
// find URL getter method
//遍历所有参数
LBL_PTS:
for (int i = 0; i < pts.length; ++i) {
Method[] ms = pts[i].getMethods();
//比如获取到Invoker类型的参数,遍历Invoker的所有成员方法
//找到一个getxxx方法，返回值是URL类型,记下方法名.
for (Method m : ms) {
String name = m.getName();
if ((name.startsWith("get") || name.length() > 3)
&& Modifier.isPublic(m.getModifiers())
&& !Modifier.isStatic(m.getModifiers())
&& m.getParameterTypes().length == 0
&& m.getReturnType() == URL.class) {
urlTypeIndex = i;
attribMethod = name;
break LBL_PTS;
}
}
}
...
}
//获取方法上@Adaptive注解的value值
String[] value = adaptiveAnnotation.value();
// value is not set, use the value generated from class name as the key
if (value.length == 0) {
//没有值的话，默认取dubbo接口的名称,比如protocol
char[] charArray = type.getSimpleName().toCharArray();
StringBuilder sb = new StringBuilder(128);
for (int i = 0; i < charArray.length; i++) {
if (Character.isUpperCase(charArray[i])) {
if (i != 0) {
sb.append(".");
}
sb.append(Character.toLowerCase(charArray[i]));
} else {
sb.append(charArray[i]);
}
}
value = new String[]{sb.toString()};
}
//获取方法的所有参数，看是否有Invocation类型.
boolean hasInvocation = false;
for (int i = 0; i < pts.length; ++i) {
if (pts[i].getName().equals("com.alibaba.dubbo.rpc.Invocation")) {
...
}
}
//获取接口的默认扩展的实现名
String defaultExtName = cachedDefaultName;
String getNameCode = null;
for (int i = value.length - 1; i >= 0; --i) {
if (i == value.length - 1) {
if (null != defaultExtName) {
if (!"protocol".equals(value[i]))
if (hasInvocation)
getNameCode = String.format("url.getMethodParameter(methodName, \"%s\", \"%s\")", value[i], defaultExtName);
else
getNameCode = String.format("url.getParameter(\"%s\", \"%s\")", value[i], defaultExtName);
else
getNameCode = String.format("( url.getProtocol() == null ? \"%s\" : url.getProtocol() )", defaultExtName);
} else {
if (!"protocol".equals(value[i]))
if (hasInvocation)
getNameCode = String.format("url.getMethodParameter(methodName, \"%s\", \"%s\")", value[i], defaultExtName);
else
getNameCode = String.format("url.getParameter(\"%s\")", value[i]);
else
getNameCode = "url.getProtocol()";
}
} else {
if (!"protocol".equals(value[i]))
if (hasInvocation)
getNameCode = String.format("url.getMethodParameter(methodName, \"%s\", \"%s\")", value[i], defaultExtName);
else
getNameCode = String.format("url.getParameter(\"%s\", %s)", value[i], getNameCode);
else
getNameCode = String.format("url.getProtocol() == null ? (%s) : url.getProtocol()", getNameCode);
}
}
...
}
...
}
codeBuidler.append("\n}");
return codeBuidler.toString();
}
扫一扫
1358
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
