Dubbo扩展点加载机制 - ExtensionLoader

概述

来源： 
Dubbo的扩展点加载从JDK标准的SPI(Service Provider Interface)扩展点发现机制加强而来。

Dubbo改进了JDK标准的SPI的以下问题：

• JDK标准的SPI会一次性实例化扩展点所有实现，如果有扩展实现初始化很耗时，但如果没用上也加载，会很浪费资源。

• 如果扩展点加载失败，连扩展点的名称都拿不到了。比如：JDK标准的ScriptEngine，通过getName();获取脚本类型的名称，但如果RubyScriptEngine因为所依赖的jruby.jar不存在，导致RubyScriptEngine类加载失败，这个失败原因被吃掉了，和ruby对应不起来，当用户执行ruby脚本时，会报不支持ruby，而不是真正失败的原因。

• 增加了对扩展点IoC和AOP的支持，一个扩展点可以直接setter注入其它扩展点。

约定： 
在扩展类的jar包内，放置扩展点配置文件：META-INF/dubbo/接口全限定名，内容为：配置名=扩展实现类全限定名，多个实现类用换行符分隔。 
(注意：这里的配置文件是放在你自己的jar包内，不是dubbo本身的jar包内，Dubbo会全ClassPath扫描所有jar包内同名的这个文件，然后进行合并)

扩展Dubbo的协议示例： 
在协议的实现jar包内放置文本文件：META-INF/dubbo/com.alibaba.dubbo.rpc.Protocol，内容为：

 

xxx=com.alibaba.xxx.XxxProtocol

 实现内容：

 

1. package com.alibaba.xxx;

2.  

3. import com.alibaba.dubbo.rpc.Protocol;

4. public class XxxProtocol implemenets Protocol {

5.  

6. // ...

7. }

 注意： 扩展点使用单一实例加载（请确保扩展实现的线程安全性），Cache在ExtensionLoader中

 

特性

• 扩展点自动包装
• 扩展点自动装配
• 扩展点自适应
• 扩展点自动激活

相关文档可以参考dubbo的官方文档 ，本文主要通过分析相关的源代码来体会dubbo的扩展点框架提供的特性。

---

源码分析

dubbo的扩展点框架主要位于这个包下：

    com.alibaba.dubbo.common.extension

大概结构如下：

 

[xml] view plain copy

1. com.alibaba.dubbo.common.extension  
2.  |  
3.  |--factory  
4.  |     |--AdaptiveExtensionFactory   #稍后解释  
5.  |     |--SpiExtensionFactory        #稍后解释  
6.  |  
7.  |--support  
8.  |     |--ActivateComparator  
9.  |  
10.  |--Activate  #自动激活加载扩展的注解  
11.  |--Adaptive  #自适应扩展点的注解  
12.  |--ExtensionFactory  #扩展点对象生成工厂接口  
13.  |--ExtensionLoader   #扩展点加载器，扩展点的查找，校验，加载等核心逻辑的实现类  
14.  |--SPI   #扩展点注解  

 其中最核心的类就是ExtensionLoader，几乎所有特性都在这个类中实现。

 

ExtensionLoader没有提供public的构造方法，但是提供了一个public static的getExtensionLoader，这个方法就是获取ExtensionLoader实例的工厂方法。其public成员方法中有三个比较重要的方法：

• getActivateExtension ：根据条件获取当前扩展可自动激活的实现
• getExtension ： 根据名称获取当前扩展的指定实现
• getAdaptiveExtension : 获取当前扩展的自适应实现

这三个方法将会是我们重点关注的方法；* 每一个ExtensionLoader实例仅负责加载特定SPI扩展的实现*。因此想要获取某个扩展的实现，首先要获取到该扩展对应的ExtensionLoader实例，下面我们就来看一下获取ExtensionLoader实例的工厂方法getExtensionLoader：

 

1. public static ExtensionLoader getExtensionLoader(Class type) {

2. if (type == null)

3. throw new IllegalArgumentException("Extension type == null");

4. if(!type.isInterface()) {

5. throw new IllegalArgumentException("Extension type(" + type + ") is not interface!");

6. }

7. if(!withExtensionAnnotation(type)) { // 只接受使用@SPI注解注释的接口类型

8. throw new IllegalArgumentException("Extension type(" + type +

9. ") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!");

10. }

11.  

12. // 先从静态缓存中获取对应的ExtensionLoader实例

13. ExtensionLoader loader = (ExtensionLoader) EXTENSION_LOADERS.get(type);

14. if (loader == null) {

15. EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader(type)); // 为Extension类型创建ExtensionLoader实例，并放入静态缓存

16. loader = (ExtensionLoader) EXTENSION_LOADERS.get(type);

17. }

18. return loader;

19. }

 该方法需要一个Class类型的参数，该参数表示希望加载的扩展点类型，该参数必须是接口，且该接口必须被@SPI注解注释，否则拒绝处理。检查通过之后首先会检查ExtensionLoader缓存中是否已经存在该扩展对应的ExtensionLoader，如果有则直接返回，否则创建一个新的ExtensionLoader负责加载该扩展实现，同时将其缓存起来。可以看到对于每一个扩展，dubbo中只会有一个对应的ExtensionLoader实例。

 

接下来看下ExtensionLoader的私有构造函数：

 

1. private ExtensionLoader(Class type) {

2. this.type = type;

3.  

4. // 如果扩展类型是ExtensionFactory,那么则设置为null

5. // 这里通过getAdaptiveExtension方法获取一个运行时自适应的扩展类型(每个Extension只能有一个@Adaptive类型的实现，如果没有dubbo会动态生成一个类)

6. objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());

7. }

 这里保存了对应的扩展类型，并且设置了一个额外的objectFactory属性，他是一个ExtensionFactory类型，ExtensionFactory主要用于加载扩展的实现：

 

1. @SPI

2. public interface ExtensionFactory {

3.  

4. /**

5. * Get extension.

6. *

7. * @param type object type.

8. * @param name object name.

9. * @return object instance.

10. */

11. T getExtension(Class type, String name);

12.  

13. }

 同时ExtensionFactory也被@SPI注解注释，说明他也是一个扩展点，从前面com.alibaba.dubbo.common.extension包的结构图中可以看到，dubbo内部提供了两个实现类：SpiExtensionFactory 和 AdaptiveExtensionFactory，实际上还有一个SpringExtensionFactory，不同的实现可以已不同的方式来完成扩展点实现的加载，这块稍后再来学习。从ExtensionLoader的构造函数中可以看到，如果要加载的扩展点类型是ExtensionFactory是，object字段被设置为null。由于ExtensionLoader的使用范围有限(基本上局限在ExtensionLoader中)，因此对他做了特殊对待：在需要使用ExtensionFactory的地方，都是通过对应的自适应实现来代替。

 

默认的ExtensionFactory实现中，AdaptiveExtensionFactotry被@Adaptive注解注释，也就是它就是ExtensionFactory对应的自适应扩展实现(每个扩展点最多只能有一个自适应实现，如果所有实现中没有被@Adaptive注释的，那么dubbo会动态生成一个自适应实现类)，也就是说，所有对ExtensionFactory调用的地方，实际上调用的都是AdpativeExtensionFactory，那么我们看下他的实现代码：

 

1. @Adaptive

2. public class AdaptiveExtensionFactory implements ExtensionFactory {

3.  

4. private final List factories;

5.  

6. public AdaptiveExtensionFactory() {

7. ExtensionLoader loader = ExtensionLoader.getExtensionLoader(ExtensionFactory.class);

8. List list = new ArrayList();

9. for (String name : loader.getSupportedExtensions()) { // 将所有ExtensionFactory实现保存起来

10. list.add(loader.getExtension(name));

11. }

12. factories = Collections.unmodifiableList(list);

13. }

14.  

15. public T getExtension(Class type, String name) {

16. // 依次遍历各个ExtensionFactory实现的getExtension方法，一旦获取到Extension即返回

17. // 如果遍历完所有的ExtensionFactory实现均无法找到Extension,则返回null

18. for (ExtensionFactory factory : factories) {

19. T extension = factory.getExtension(type, name);

20. if (extension != null) {

21. return extension;

22. }

23. }

24. return null;

25. }

26.  

27. }

 看完代码大家都知道是怎么回事了，这货就相当于一个代理入口，他会遍历当前系统中所有的ExtensionFactory实现来获取指定的扩展实现，获取到扩展实现或遍历完所有的ExtensionFactory实现。这里调用了ExtensionLoader的getSupportedExtensions方法来获取ExtensionFactory的所有实现，又回到了ExtensionLoader类，下面我们就来分析ExtensionLoader的几个重要的实例方法。

 

方法调用流程

getExtension

 

[xml] view plain copy

1. getExtension(name)  
2.     -> createExtension(name) #如果无缓存则创建  
3.         -> getExtensionClasses().get(name) #获取name对应的扩展类型  
4.         -> 实例化扩展类  
5.         -> injectExtension(instance) # 扩展点注入  
6.         -> instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance)) #循环遍历所有wrapper实现，实例化wrapper并进行扩展点注入  

 getAdaptiveExtension

 

[xml] view plain copy

1. public T getAdaptiveExtension()  
2.     -> createAdaptiveExtension() #如果无缓存则创建  
3.         -> getAdaptiveExtensionClass().newInstance() #获取AdaptiveExtensionClass  
4.             -> getExtensionClasses() # 加载当前扩展所有实现，看是否有实现被标注为@Adaptive  
5.             -> createAdaptiveExtensionClass() #如果没有实现被标注为@Adaptive，则动态创建一个Adaptive实现类  
6.                 -> createAdaptiveExtensionClassCode() #动态生成实现类java代码  
7.                 -> compiler.compile(code, classLoader) #动态编译java代码，加载类并实例化  
8.         -> injectExtension(instance)  

 getActivateExtesion 

 

该方法有多个重载方法，不过最终都是调用了三个参数的那一个重载形式。其代码结构也相对剪短，就不需要在列出概要流程了。

---

详细代码分析

getAdaptiveExtension 
从前面ExtensionLoader的私有构造函数中可以看出，在选择ExtensionFactory的时候，并不是调用getExtension(name)来获取某个具体的实现类，而是调用getAdaptiveExtension来获取一个自适应的实现。那么首先我们就来分析一下getAdaptiveExtension这个方法的实现吧：

 

1. public T getAdaptiveExtension() {

2. Object instance = cachedAdaptiveInstance.get(); // 首先判断是否已经有缓存的实例对象

3. if (instance == null) {

4. if(createAdaptiveInstanceError == null) {

5. synchronized (cachedAdaptiveInstance) {

6. instance = cachedAdaptiveInstance.get();

7. if (instance == null) {

8. try {

9. instance = createAdaptiveExtension(); // 没有缓存的实例，创建新的AdaptiveExtension实例

10. cachedAdaptiveInstance.set(instance);

11. } catch (Throwable t) {

12. createAdaptiveInstanceError = t;

13. throw new IllegalStateException("fail to create adaptive instance: " + t.toString(), t);

14. }

15. }

16. }

17. }

18. else {

19. throw new IllegalStateException("fail to create adaptive instance: " + createAdaptiveInstanceError.toString(), createAdaptiveInstanceError);

20. }

21. }

22.  

23. return (T) instance;

24. }

 首先检查缓存的adaptiveInstance是否存在，如果存在则直接使用，否则的话调用createAdaptiveExtension方法来创建新的adaptiveInstance并且缓存起来。也就是说对于某个扩展点，每次调用ExtensionLoader.getAdaptiveExtension获取到的都是同一个实例。

 

1. private T createAdaptiveExtension() {

2. try {

3. return injectExtension((T) getAdaptiveExtensionClass().newInstance()); // 先获取AdaptiveExtensionClass，在获取其实例，最后进行注入处理

4. } catch (Exception e) {

5. throw new IllegalStateException("Can not create adaptive extenstion " + type + ", cause: " + e.getMessage(), e);

6. }

7. }

 在createAdaptiveExtension方法中，首先通过getAdaptiveExtensionClass方法获取到最终的自适应实现类型，然后实例化一个自适应扩展实现的实例，最后进行扩展点注入操作。先看一个getAdaptiveExtensionClass方法的实现：

 

1. private Class getAdaptiveExtensionClass() {

2. getExtensionClasses(); // 加载当前Extension的所有实现,如果有@Adaptive类型，则会赋值为cachedAdaptiveClass属性缓存起来

3. if (cachedAdaptiveClass != null) {

4. return cachedAdaptiveClass;

5. }

6. return cachedAdaptiveClass = createAdaptiveExtensionClass(); // 没有找到@Adaptive类型实现，则动态创建一个AdaptiveExtensionClass

7. }

 他只是简单的调用了getExtensionClasses方法，然后在判adaptiveCalss缓存是否被设置，如果被设置那么直接返回，否则调用createAdaptiveExntesionClass方法动态生成一个自适应实现，关于动态生成自适应实现类然后编译加载并且实例化的过程这里暂时不分析，留到后面在分析吧。这里我们看getExtensionClassses方法：

1. private Map> getExtensionClasses() {

2. Map> classes = cachedClasses.get(); // 判断是否已经加载了当前Extension的所有实现类

3. if (classes == null) {

4. synchronized (cachedClasses) {

5. classes = cachedClasses.get();

6. if (classes == null) {

7. classes = loadExtensionClasses(); // 如果还没有加载Extension的实现，则进行扫描加载,完成后赋值给cachedClasses变量

8. cachedClasses.set(classes);

9. }

10. }

11. }

12. return classes;

13. }

 在getExtensionClasses方法中，首先检查缓存的cachedClasses，如果没有再调用loadExtensionClasses方法来加载，加载完成之后就会进行缓存。也就是说对于每个扩展点，其实现的加载只会执行一次。我们看下loadExtensionClasses方法：

1. private Map> loadExtensionClasses() {

2. final SPI defaultAnnotation = type.getAnnotation(SPI.class);

3. if(defaultAnnotation != null) {

4. String value = defaultAnnotation.value(); // 解析当前Extension配置的默认实现名，赋值给cachedDefaultName属性

5. if(value != null && (value = value.trim()).length() > 0) {

6. String[] names = NAME_SEPARATOR.split(value);

7. if(names.length > 1) { // 每个扩展实现只能配置一个名称

8. throw new IllegalStateException("more than 1 default extension name on extension " + type.getName()

9. + ": " + Arrays.toString(names));

10. }

11. if(names.length == 1) cachedDefaultName = names[0];

12. }

13. }

14.  

15. // 从配置文件中加载扩展实现类

16. Map> extensionClasses = new HashMap>();

17. loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY);

18. loadFile(extensionClasses, DUBBO_DIRECTORY);

19. loadFile(extensionClasses, SERVICES_DIRECTORY);

20. return extensionClasses;

21. }

 从代码里面可以看到，在loadExtensionClasses中首先会检测扩展点在@SPI注解中配置的默认扩展实现的名称，并将其赋值给cachedDefaultName属性进行缓存，后面想要获取该扩展点的默认实现名称就可以直接通过访问cachedDefaultName字段来完成，比如getDefaultExtensionName方法就是这么实现的。从这里的代码中又可以看到，具体的扩展实现类型，是通过调用loadFile方法来加载，分别从一下三个地方加载：

• META-INF/dubbo/internal/
• META-INF/dubbo/
• META-INF/services/

那么这个loadFile方法则至关重要了，看看其源代码：

private void loadFile(Map> extensionClasses, String dir) { String fileName = dir + type.getName(); // 配置文件名称,扫描整个classpath try { // 先获取该路径下所有文件 Enumeration urls; ClassLoader classLoader = findClassLoader(); if (classLoader != null) { urls = classLoader.getResources(fileName); } else { urls = ClassLoader.getSystemResources(fileName); } if (urls != null) { // 遍历这些文件并进行处理 while (urls.hasMoreElements()) { java.net.URL url = urls.nextElement(); // 获取配置文件路径 try { BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), "utf-8")); try { 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 = line.substring(0, i).trim(); // 扩展名称 line = line.substring(i + 1).trim(); // 扩展实现类 } if (line.length() > 0) { 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."); } if (clazz.isAnnotationPresent(Adaptive.class)) { // 判断该实现类是否@Adaptive,是的话不会放入extensionClasses/cachedClasses缓存 if(cachedAdaptiveClass == null) { // 第一个赋值给cachedAdaptiveClass属性 cachedAdaptiveClass = clazz; } else if (! cachedAdaptiveClass.equals(clazz)) { // 只能有一个@Adaptive实现,出现第二个就报错了 throw new IllegalStateException("More than 1 adaptive class found: " + cachedAdaptiveClass.getClass().getName() + ", " + clazz.getClass().getName()); } } else { // 不是@Adaptive类型 try { clazz.getConstructor(type); // 判断是否Wrapper类型 Set> wrappers = cachedWrapperClasses; if (wrappers == null) { cachedWrapperClasses = new ConcurrentHashSet>(); wrappers = cachedWrapperClasses; } wrappers.add(clazz); //放入到Wrapper实现类缓存中 } catch (NoSuchMethodException e) { //不是Wrapper类型，普通实现类型 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); } } } String[] names = NAME_SEPARATOR.split(name); // 看是否配置了多个name if (names != null && names.length > 0) { Activate activate = clazz.getAnnotation(Activate.class); // 是否@Activate类型 if (activate != null) { cachedActivates.put(names[0], activate);// 是则放入cachedActivates缓存 } // 遍历所有name for (String n : names) { if (! cachedNames.containsKey(clazz)) { cachedNames.put(clazz, n); // 放入Extension实现类与名称映射缓存,每个class只对应第一个名称有效 } Class c = extensionClasses.get(n); if (c == null) { extensionClasses.put(n, clazz); // 放入到extensionClasses缓存,多个name可能对应一个Class } else if (c != clazz) { // 存在重名 throw new IllegalStateException("Duplicate extension " + type.getName() + " name " + n + " on " + c.getName() + " and " + clazz.getName()); } } } } } } } catch (Throwable t) { IllegalStateException e = new IllegalStateException("Failed to load extension class(interface: " + type + ", class line: " + line + ") in " + url + ", cause: " + t.getMessage(), t); exceptions.put(line, e); } } } // end of while read lines } finally { reader.close(); } } catch (Throwable t) { logger.error("Exception when load extension class(interface: " + type + ", class file: " + url + ") in " + url, t); } } // end of while urls } } catch (Throwable t) { logger.error("Exception when load extension class(interface: " + type + ", description file: " + fileName + ").", t); } }

 

 代码比较长，大概的事情呢就是解析配置文件，获取扩展点实现对应的名称和实现类，并进行分类处理和缓存。当loadFile方法执行完成之后，以下几个变量就会被附上值：

• cachedAdaptiveClass : 当前Extension类型对应的AdaptiveExtension类型(只能一个)
• cachedWrapperClasses : 当前Extension类型对应的所有Wrapper实现类型(无顺序)
• cachedActivates : 当前Extension实现自动激活实现缓存(map,无序)
• cachedNames : 扩展点实现类对应的名称(如配置多个名称则值为第一个)

当loadExtensionClasses方法执行完成之后，还有一下变量被赋值：

• cachedDefaultName : 当前扩展点的默认实现名称

当getExtensionClasses方法执行完成之后，除了上述变量被赋值之外，还有以下变量被赋值：

• cachedClasses : 扩展点实现名称对应的实现类(一个实现类可能有多个名称)

其实也就是说，在调用了getExtensionClasses方法之后，当前扩展点对应的实现类的一些信息就已经加载进来了并且被缓存了。后面的许多操作都可以直接通过这些缓存数据来进行处理了。

回到createAdaptiveExtension方法，他调用了getExtesionClasses方法加载扩展点实现信息完成之后，就可以直接通过判断cachedAdaptiveClass缓存字段是否被赋值盘确定当前扩展点是否有默认的AdaptiveExtension实现。如果没有，那么就调用createAdaptiveExtensionClass方法来动态生成一个。在dubbo的扩展点框架中大量的使用了缓存技术。

创建自适应扩展点实现类型和实例化就已经完成了，下面就来看下扩展点自动注入的实现injectExtension：

1. private T injectExtension(T instance) {

2. try {

3. if (objectFactory != null) {

4. for (Method method : instance.getClass().getMethods()) {

5. if (method.getName().startsWith("set")

6. && method.getParameterTypes().length == 1

7. && Modifier.isPublic(method.getModifiers())) {// 处理所有set方法

8. Class pt = method.getParameterTypes()[0];// 获取set方法参数类型

9. try {

10. // 获取setter对应的property名称

11. String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";

12. Object object = objectFactory.getExtension(pt, property); // 根据类型，名称信息从ExtensionFactory获取

13. if (object != null) { // 如果不为空，说set方法的参数是扩展点类型，那么进行注入

14. method.invoke(instance, object);

15. }

16. } catch (Exception e) {

17. logger.error("fail to inject via method " + method.getName()

18. + " of interface " + type.getName() + ": " + e.getMessage(), e);

19. }

20. }

21. }

22. }

23. } catch (Exception e) {

24. logger.error(e.getMessage(), e);

25. }

26. return instance;

27. }

 这里可以看到，扩展点自动注入的一句就是根据setter方法对应的参数类型和property名称从ExtensionFactory中查询，如果有返回扩展点实例，那么就进行注入操作。到这里getAdaptiveExtension方法就分析完毕了。

 

getExtension

这个方法的主要作用是用来获取ExtensionLoader实例代表的扩展的指定实现。已扩展实现的名字作为参数，结合前面学习getAdaptiveExtension的代码，我们可以推测，这方法中也使用了在调用getExtensionClasses方法的时候收集并缓存的数据，其中涉及到名字和具体实现类型对应关系的缓存属性是cachedClasses。具体是是否如我们猜想的那样呢，学习一下相关代码就知道了：

1. public T getExtension(String name) {

2. if (name == null || name.length() == 0)

3. throw new IllegalArgumentException("Extension name == null");

4. if ("true".equals(name)) { // 判断是否是获取默认实现

5. return getDefaultExtension();

6. }

7. Holder