dubbo之SPI模式

一 概述

   一大早来上班,准备写****博客,发现前面的文章下有人评价,有点欣喜,有点安慰。算是对我这段时间作品的回报和我前进的动力吧!继续写吧.. 前面阅读dubbo源码经常看到

[java] view plain copy
  1. Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();     
这种类型的代码来获取一个接口的代理类,比如我这里贴的代码反馈的了一个Protocol接口的代理实现。仔细翻看dubbo中的源码,Protocol接口的实现类有很多种,   那么在程序的执行中怎么得到对应的实现类,怎么去动态的扩展接口实现,这些问题就是今天讨论的重点。

二  什么是SPI技术

         感觉自己的语言描述不是很精准,就不再自己创造了,在网上拷贝了一段描述,讲明了什么是SPI技术,为什么要用SPI,用SPI有什么好处。内如下:  SPI的全名为Service Provider Interface.大多数开发人员可能不熟悉,因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。简单的总结下java spi机制的思想。我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。 java spi就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要,java spi的具体约定为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。 基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。jdk提供服务实现查找的一个工具类:java.util.ServiceLoader

三  JDK中的SPI技术

    JDK中拥有SPI的支持,主要涉及java.util.ServiceLoader类的使用,我写了一个小的DEMO让我们初步理解下SPI的使用。首先我写了一个接口代码如下:

[java] view plain copy
  1. package spi;  
  2.   
  3.     /** 
  4.      * Created by Administrator on 2017/8/28. 
  5.      */  
  6.     public interface DubboService {  
  7.   
  8.         public void sayHello();  
  9.     }  

然后写了这个接口的两个实现类

[java] view plain copy
  1. package spi;  
  2.   
  3. /** 
  4.  * Created by Administrator on 2017/8/28. 
  5.  */  
  6. public class RedService implements DubboService {  
  7.     public void sayHello() {  
  8.   
  9.         System.out.println("我是RedService服务实现");  
  10.   
  11.     }  
  12. }  
[java] view plain copy
  1. package spi;  
  2.   
  3. /** 
  4.  * Created by Administrator on 2017/8/28. 
  5.  */  
  6. public class YellowService implements DubboService {  
  7.     public void sayHello() {  
  8.         System.out.println("我是YellowService服务实现");  
  9.   
  10.     }  
  11. }  
然后写了一个main函数类
[java] view plain copy
  1. package spi;  
  2.     import java.util.Iterator;  
  3.     import java.util.ServiceLoader;  
  4.   
  5.     /** 
  6.      * Created by Administrator on 2017/8/28. 
  7.      */  
  8.     public class ServiceMain {  
  9.   
  10.         public  static void main(String[] args){  
  11.   
  12.             ServiceLoader<DubboService> spiLoader = ServiceLoader.load(DubboService.class);  
  13.             Iterator<DubboService>  iteratorSpi=spiLoader.iterator();  
  14.             while (iteratorSpi.hasNext()){  
  15.                 DubboService dubboService=iteratorSpi.next();  
  16.                 dubboService.sayHello();  
  17.             }  
  18.   
  19.         }  
  20.     }  
然后在META-INF文件夹下创建了services文件夹,并在services文件夹下创建了一个文件,文件名以接口的全限定名来命名,我这里是spi.DubboService。然后在这个文件中填入这个接口的两个实现类,类中间以换行隔开。到这里所有准备工作已经完成,开始执行ServiceMain的主函数吧! 执行以后输出了日志打印
1.我是RedService服务实现
2.我是YellowService服务实现
分析main函数中的代码,ServiceLoader类是JDK自带的哦!调用load方法即可加载接口参数的所有实现!看到这里是不是在想在META-INF文件夹下创建services/接口全限定名是不是固定写法!好吧,我们跟进到ServiceLoader类中。第一行代码就是private static final String PREFIX = "META-INF/services/"; 是不是立马就明白了ServiceLoader类中已经将配置路径固定好了(如果感兴趣也可以自己写个类来实现ServiceLoader的功能),调用load方法,根据传入的接口参数找到该接口的对应文件,然后一行一行的读取文件中的实现类,使用java反射机制实例化接口的实现对象。到这里SPI技术的原理应该理解了。也可以看看ServiceLoader类的源码能更深入的理解!看看我的目录接口如下图:

dubbo之SPI模式

新建的spi.DubboService中的内容如下:

dubbo之SPI模式


四 dubbo中SPI的应用

dubbo框架中大量使用了SPI技术,里面有很多个组件,每个组件在框架中都是以接口的形成抽象出来!具体的实现又分很多种,在程序执行时根据用户的配置来按需取接口的实现。方便了接口的各种实现灵活应用。不过dubbo使用的SPI技术不是源用jdk的实现,但是它们的思想仍然是一样的。我这里仍然以Protocol 协议接口来讲解,还是这段代码

[java] view plain copy
  1. Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();  
很熟悉吧!开篇就提到过它。 ExtensionLoader类有点类似JDK中的ServiceLoader类,也是用来加载指定路径下的接口实现不过实现别JDK的复杂了很多。首先看ExtensionLoader的静态方法getExtensionLoader。

[java] view plain copy
  1. public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> 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)) {  
  8.             throw new IllegalArgumentException("Extension type(" + type +   
  9.                     ") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!");  
  10.         }  
  11.         //根据接口对象取ExtensionLoader类  
  12.         ExtensionLoader<T> loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);  
  13.         if (loader == null) {  
  14.             //如果为空保存接口类对应的 新建的ExtensionLoader对象  
  15.             EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));  
  16.             loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);  
  17.         }  
  18.         return loader;  
  19.     }  
1.EXTENSION_LOADERS这个Map中以接口为key,以ExtensionLoader对象为value。
2.判断Map中根据接口get对象,如果没有就new个ExtensionLoader对象保存进去。并返回该ExtensionLoader对象。
3.注意创建ExtensionLoader对象的构造函数代码,将传入的接口type属性赋值给了ExtensionLoader类的type属性
4.创建ExtensionFactory objectFactory对象。怎么创建的,还是那个熟悉的写法,嘿嘿!出现的好频繁哇!
[java] view plain copy
  1. private ExtensionLoader(Class<?> type) {  
  2.         this.type = type;  
  3.         objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());  
  4.     }  
我们继续看getAdaptiveExtension()方法的实现。
[java] view plain copy
  1. /** 
  2.      * 动态生成接口或者点的代理类 
  3.      */  
  4.     public T getAdaptiveExtension() {  
  5.   
  6.         //取里面的Value  
  7.         Object instance = cachedAdaptiveInstance.get();  
  8.         //为null的处理  
  9.         if (instance == null) {  
  10.             //判断是否有异常处理  
  11.             if(createAdaptiveInstanceError == null) {  
  12.   
  13.                 //针对cachedAdaptiveInstance加锁处理  
  14.                 synchronized (cachedAdaptiveInstance) {  
  15.                     instance = cachedAdaptiveInstance.get();  
  16.                     if (instance == null) {  
  17.                         try {  
  18.                             instance = createAdaptiveExtension();//动态生成入口  
  19.                             cachedAdaptiveInstance.set(instance);//设置代理对象到value中  
  20.                         } catch (Throwable t) {  
  21.                             createAdaptiveInstanceError = t;  
  22.                             throw new IllegalStateException("fail to create adaptive instance: " + t.toString(), t);  
  23.                         }  
  24.                     }  
  25.                 }  
  26.             }  
  27.             else {  
  28.                 throw new IllegalStateException("fail to create adaptive instance: " + createAdaptiveInstanceError.toString(), createAdaptiveInstanceError);  
  29.             }  
  30.         }  
  31.   
  32.         return (T) instance;  
  33.     }  
我们重点看createAdaptiveExtension()方法的实现,这里是动态代理生成的入口
[java] view plain copy
  1. private T createAdaptiveExtension() {  
  2.         try {  
  3.             //(T) getAdaptiveExtensionClass().newInstance()创建class对象实例  
  4.             return injectExtension((T) getAdaptiveExtensionClass().newInstance());//接口的代理实现class创建一个实体对象  
  5.         } catch (Exception e) {  
  6.             throw new IllegalStateException("Can not create adaptive extenstion " + type + ", cause: " + e.getMessage(), e);  
  7.         }  
  8.     }  
我们采用由内到外的顺序来看吧,关注getAdaptiveExtensionClass().newInstance()。
[java] view plain copy
  1. private Class<?> getAdaptiveExtensionClass() {  
  2.         getExtensionClasses();//通过SPI加载接口延伸的所有实现到map中保存  
  3.         if (cachedAdaptiveClass != null) {  
  4.             return cachedAdaptiveClass;  
  5.         }  
  6.         return cachedAdaptiveClass = createAdaptiveExtensionClass();//动态生成接口的代理实现class对象  
  7.     }  

[java] view plain copy
  1. /** 
  2.      * 通过SPI加载当前传入接口延伸的所有实现到map中保存 
  3.      * @return 
  4.      */  
  5.     private Map<String, Class<?>> getExtensionClasses() {  
  6.         Map<String, Class<?>> classes = cachedClasses.get();  
  7.         if (classes == null) {  
  8.             synchronized (cachedClasses) {  
  9.                 classes = cachedClasses.get();  
  10.                 if (classes == null) {  
  11.                     classes = loadExtensionClasses();  
  12.                     cachedClasses.set(classes);  
  13.                 }  
  14.             }  
  15.         }  
  16.         return classes;  
  17.     }  

[java] view plain copy
  1. //通过SPI加载接口对应的所有实现类  
  2.     // 此方法已经getExtensionClasses方法同步过。  
  3.     private Map<String, Class<?>> loadExtensionClasses() {  
  4.         //解析type接口上的SPI注解  
  5.         final SPI defaultAnnotation = type.getAnnotation(SPI.class);  
  6.         if(defaultAnnotation != null) {  
  7.             //获取注解标记值  
  8.             String value = defaultAnnotation.value();  
  9.             if(value != null && (value = value.trim()).length() > 0) {  
  10.                 String[] names = NAME_SEPARATOR.split(value);  
  11.                 if(names.length > 1) {  
  12.                     throw new IllegalStateException("more than 1 default extension name on extension " + type.getName()  
  13.                             + ": " + Arrays.toString(names));  
  14.                 }  
  15.                 if(names.length == 1) cachedDefaultName = names[0];  
  16.             }  
  17.         }  
  18.           
  19.         Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();  
  20.         loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY);  
  21.         loadFile(extensionClasses, DUBBO_DIRECTORY);  
  22.         loadFile(extensionClasses, SERVICES_DIRECTORY);  
  23.         return extensionClasses;  
  24.     }  

[java] view plain copy
  1. private void loadFile(Map<String, Class<?>> extensionClasses, String dir) {  
  2.         String fileName = dir + type.getName();  
  3.         try {  
  4.             Enumeration<java.net.URL> urls;  
  5.             ClassLoader classLoader = findClassLoader();  
  6.             if (classLoader != null) {  
  7.                 urls = classLoader.getResources(fileName);  
  8.             } else {  
  9.                 urls = ClassLoader.getSystemResources(fileName);  
  10.             }  
  11.             if (urls != null) {  
  12.                 while (urls.hasMoreElements()) {  
  13.                     java.net.URL url = urls.nextElement();  
  14.                     try {  
  15.                         BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), "utf-8"));  
  16.                         try {  
  17.                             String line = null;  
  18.                             while ((line = reader.readLine()) != null) {  
  19.                                 final int ci = line.indexOf('#');  
  20.                                 if (ci >= 0) line = line.substring(0, ci);  
  21.                                 line = line.trim();  
  22.                                 if (line.length() > 0) {  
  23.                                     try {  
  24.                                         String name = null;  
  25.                                         int i = line.indexOf('=');  
  26.                                         if (i > 0) {  
  27.                                             name = line.substring(0, i).trim();  
  28.                                             line = line.substring(i + 1).trim();  
  29.                                         }  
  30.                                         if (line.length() > 0) {  
  31.                                             Class<?> clazz = Class.forName(line, true, classLoader);  
  32.                                             //判断type接口是clazz类的接口  
  33.                                             if (! type.isAssignableFrom(clazz)) {  
  34.                                                 throw new IllegalStateException("Error when load extension class(interface: " +  
  35.                                                         type + ", class line: " + clazz.getName() + "), class "   
  36.                                                         + clazz.getName() + "is not subtype of interface.");  
  37.                                             }  
  38.                                             //判断接口实现类是否标注了该注解  
  39.                                             if (clazz.isAnnotationPresent(Adaptive.class)) {  
  40.                                                 if(cachedAdaptiveClass == null) {  
  41.                                                     cachedAdaptiveClass = clazz;  
  42.                                                 } else if (! cachedAdaptiveClass.equals(clazz)) {  
  43.                                                     throw new IllegalStateException("More than 1 adaptive class found: "  
  44.                                                             + cachedAdaptiveClass.getClass().getName()  
  45.                                                             + ", " + clazz.getClass().getName());  
  46.                                                 }  
  47.                                             } else {  
  48.                                                 try {  
  49.                                                     clazz.getConstructor(type);  
  50.                                                     Set<Class<?>> wrappers = cachedWrapperClasses;  
  51.                                                     if (wrappers == null) {  
  52.                                                         cachedWrapperClasses = new ConcurrentHashSet<Class<?>>();  
  53.                                                         wrappers = cachedWrapperClasses;  
  54.                                                     }  
  55.                                                     wrappers.add(clazz);  
  56.                                                 } catch (NoSuchMethodException e) {  
  57.                                                     clazz.getConstructor();  
  58.                                                     if (name == null || name.length() == 0) {  
  59.                                                         name = findAnnotationName(clazz);  
  60.                                                         if (name == null || name.length() == 0) {  
  61.                                                             if (clazz.getSimpleName().length() > type.getSimpleName().length()  
  62.                                                                     && clazz.getSimpleName().endsWith(type.getSimpleName())) {  
  63.                                                                 name = clazz.getSimpleName().substring(0, clazz.getSimpleName().length() - type.getSimpleName().length()).toLowerCase();  
  64.                                                             } else {  
  65.                                                                 throw new IllegalStateException("No such extension name for the class " + clazz.getName() + " in the config " + url);  
  66.                                                             }  
  67.                                                         }  
  68.                                                     }  
  69.                                                     String[] names = NAME_SEPARATOR.split(name);  
  70.                                                     if (names != null && names.length > 0) {  
  71.                                                         Activate activate = clazz.getAnnotation(Activate.class);  
  72.                                                         if (activate != null) {  
  73.                                                             cachedActivates.put(names[0], activate);  
  74.                                                         }  
  75.                                                         for (String n : names) {  
  76.                                                             if (! cachedNames.containsKey(clazz)) {  
  77.                                                                 cachedNames.put(clazz, n);  
  78.                                                             }  
  79.                                                             Class<?> c = extensionClasses.get(n);  
  80.                                                             if (c == null) {  
  81.                                                                 extensionClasses.put(n, clazz);  
  82.                                                             } else if (c != clazz) {  
  83.                                                                 throw new IllegalStateException("Duplicate extension " + type.getName() + " name " + n + " on " + c.getName() + " and " + clazz.getName());  
  84.                                                             }  
  85.                                                         }  
  86.                                                     }  
  87.                                                 }  
  88.                                             }  
  89.                                         }  
  90.                                     } catch (Throwable t) {  
  91.                                         IllegalStateException e = new IllegalStateException("Failed to load extension class(interface: " + type + ", class line: " + line + ") in " + url + ", cause: " + t.getMessage(), t);  
  92.                                         exceptions.put(line, e);  
  93.                                     }  
  94.                                 }  
  95.                             } // end of while read lines  
  96.                         } finally {  
  97.                             reader.close();  
  98.                         }  
  99.                     } catch (Throwable t) {  
  100.                         logger.error("Exception when load extension class(interface: " +  
  101.                                             type + ", class file: " + url + ") in " + url, t);  
  102.                     }  
  103.                 } // end of while urls  
  104.             }  
  105.         } catch (Throwable t) {  
  106.             logger.error("Exception when load extension class(interface: " +  
  107.                     type + ", description file: " + fileName + ").", t);  
  108.         }  
  109.     }  
一下子罗列了好几段代码,看着比较多。其实还是比较好理解的。主要做了以下几件事情:
1.loadExtensionClasses方法判断ExtensionLoader类中的传入的type接口是否标注了SPI注解,并获取SPI注解的值,这个值为接口的默认实现标记。
2.loadFile方法用来加载配置路径下的接口的实现类。比如在调用loadFile方法时,传入的参数DUBBO_INTERNAL_DIRECTORY,DUBBO_DIRECTORY,SERVICES_DIRECTORY。他们都描述了接口实现类配置文件路径,看看3个属性的值如下:

[java] view plain copy
  1. private static final String SERVICES_DIRECTORY = "META-INF/services/";  
  2. private static final String DUBBO_DIRECTORY = "META-INF/dubbo/";   
  3. private static final String DUBBO_INTERNAL_DIRECTORY = DUBBO_DIRECTORY + "internal/";  

是不是感觉跟JDK里面SPI技术路径描述很类型。讲到这里我们来看看dubbo框架的接口实现配置是怎么玩的,这里我就以com.alibaba.dubbo.rpc.Protocol接口来研究!哟!是不是感觉跟JDK里面配置不太一样,它按照key=value的形式来保存的,在分析下loadFile方法中的代码,它也是按照key=value的格式来解析出接口的具体实现,将最终解析的数据保存到了传入的map参数extensionClasses中。大家应该感到好奇为什么要做个key=value的配置。打个比方Protocol协议接口在dubbo框架里实现有hession,http,rmi,webservice,dubbo等好几种实现,在程序运行中我们根据配置来使用具体的协议,比方我要使用rmi协议,那我就配置rmi,我想使用dubbo 我就配置dubbo。配置好以后会根据这个属性配置取找相关的具体协议实现。所以这里的key=value应该就是做这个事情的。我这里贴几张图看看Protocol接口的实现配置,图下几个图:

rmi协议实现:

dubbo之SPI模式


hession协议实现:

dubbo之SPI模式


dubbo协议实现,也就是默认的协议:

dubbo之SPI模式

我们再次回到getAdaptiveExtensionClass方法中。继续看createAdaptiveExtensionClass方法

[java] view plain copy
  1. private Class<?> createAdaptiveExtensionClass() {  
  2.         String code = createAdaptiveExtensionClassCode();//创建接口的代理类实现  
  3.         ClassLoader classLoader = findClassLoader();//获取当前使用的类加载器  
  4.         com.alibaba.dubbo.common.compiler.Compiler compiler = ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();//获取代码编译器  
  5.         return compiler.compile(code, classLoader);//加载代理  
  6.     }  
由于createAdaptiveExtensionClassCode方法的代码太长了,我就不贴出来啦。主要就是根据JAVA的反射机制去读出接口中的所有方法,形成该接口的代理。注意createAdaptiveExtensionClassCode方法返回的是字符串,这个字符串保存了代理类的动态生成的代码。然后经过编译加载到虚拟机中。我抓取了一个Protocol接口的代理类代码如下:
[java] view plain copy
  1. //动态生成的协议代理类  
  2.     public class Protocol$Adpative implements com.alibaba.dubbo.rpc.Protocol {  
  3.         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!");  
  4.         }  
  5.         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!");  
  6.         }  
  7.         public com.alibaba.dubbo.rpc.Exporter export(com.alibaba.dubbo.rpc.Invoker arg0) throws com.alibaba.dubbo.rpc.RpcException {  
  8.             if (arg0 == nullthrow new IllegalArgumentException("com.alibaba.dubbo.rpc.Invoker argument == null");  
  9.   
  10.             if (arg0.getUrl() == nullthrow new IllegalArgumentException("com.alibaba.dubbo.rpc.Invoker argument getUrl() == null");  
  11.   
  12.             com.alibaba.dubbo.common.URL url = arg0.getUrl();  
  13.   
  14.             //默认选择dubbo协议,否则根据url中带的协议属性来选择对应的协议处理对象,这样可以动态选择不同的协议  
  15.             String extName = ( url.getProtocol() == null ? "dubbo" : url.getProtocol() );  
  16.   
  17.             if(extName == nullthrow new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.Protocol) name from url(" + url.toString() + ") use keys([protocol])");  
  18.   
  19.             //根据拿到的协议key从缓存的map中取协议对象  
  20.             com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol)ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName);  
  21.   
  22.             return extension.export(arg0);  
  23.         }  
  24.         public com.alibaba.dubbo.rpc.Invoker refer(java.lang.Class arg0, com.alibaba.dubbo.common.URL arg1) throws com.alibaba.dubbo.rpc.RpcException {  
  25.   
  26.             if (arg1 == nullthrow new IllegalArgumentException("url == null");  
  27.   
  28.             com.alibaba.dubbo.common.URL url = arg1;  
  29.   
  30.             String extName = ( url.getProtocol() == null ? "dubbo" : url.getProtocol() );  
  31.   
  32.             if(extName == nullthrow new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.Protocol) name from url(" + url.toString() + ") use keys([protocol])");  
  33.   
  34.             //根据拿到的协议key从缓存的map中取协议对象  
  35.             com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol)ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName);  
  36.   
  37.             return extension.refer(arg0, arg1);  
  38.         }  
  39.     }  
到这里接口的代理已经生成啦!我再回退到createAdaptiveExtension方法中。
[java] view plain copy
  1. injectExtension((T) getAdaptiveExtensionClass().newInstance());  
getAdaptiveExtensionClass().newInstance()创建了这个接口代理类的实例,并传入到injectExtension方法中
[java] view plain copy
  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())) {  
  8.                         Class<?> pt = method.getParameterTypes()[0];  
  9.                         try {  
  10.                             String property = method.getName().length() > 3 ? method.getName().substring(34).toLowerCase() + method.getName().substring(4) : "";  
  11.                             Object object = objectFactory.getExtension(pt, property);  
  12.                             if (object != null) {  
  13.                                 method.invoke(instance, object);  
  14.                             }  
  15.                         } catch (Exception e) {  
  16.                             logger.error("fail to inject via method " + method.getName()  
  17.                                     + " of interface " + type.getName() + ": " + e.getMessage(), e);  
  18.                         }  
  19.                     }  
  20.                 }  
  21.             }  
  22.         } catch (Exception e) {  
  23.             logger.error(e.getMessage(), e);  
  24.         }  
  25.         return instance;  
  26.     }  

貌似没做什么太多的操作,只是利用反射机制判断接口代理类中是否有需要注入的属性。然后就结束啦!我们再次回退到getAdaptiveExtension方法中,最终反馈的就是该接口的代理实现。是不是有点疑惑,看了这么半天

[java] view plain copy
  1. Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();  

代码只是反馈了接口的代理,那我在实际使用中怎么得到接口的具体实现呢?

额! 在仔细看看Protocol接口代理的具体实现,在使用接口代理中的方法时,都会根据URL来确定接口的具体实现,因为URL中携带了用户大部分的参数配置,根据里面的属性来获取。里面关键代码
[java] view plain copy
  1. com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol)ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName);  
参数extName就是用户配置的协议参数。
[java] view plain copy
  1. /** 
  2.      * 返回指定名字的扩展。如果指定名字的扩展不存在,则抛异常 {@link IllegalStateException}. 
  3.      * 
  4.      * @param name 
  5.      * @return 
  6.      */  
  7.     @SuppressWarnings("unchecked")  
  8.     public T getExtension(String name) {  
  9.         if (name == null || name.length() == 0)  
  10.             throw new IllegalArgumentException("Extension name == null");  
  11.         if ("true".equals(name)) {  
  12.             return getDefaultExtension();  
  13.         }  
  14.         //根据传入的name参数确定接口的具体实现类  
  15.         Holder<Object> holder = cachedInstances.get(name);  
  16.         if (holder == null) {  
  17.             cachedInstances.putIfAbsent(name, new Holder<Object>());  
  18.             holder = cachedInstances.get(name);  
  19.         }  
  20.         //判断接口实现类是否存在  
  21.         Object instance = holder.get();  
  22.         if (instance == null) {  
  23.             synchronized (holder) {  
  24.                 instance = holder.get();  
  25.                 if (instance == null) {  
  26.                     //不存在那么创建一个接口实现类  
  27.                     instance = createExtension(name);  
  28.                     holder.set(instance);  
  29.                 }  
  30.             }  
  31.         }  
  32.         return (T) instance;  
  33.     }  
  34.       
  35.       
  36.     private T createExtension(String name) {  
  37.         //根据参数获取接口的Class对象  
  38.         Class<?> clazz = getExtensionClasses().get(name);  
  39.         if (clazz == null) {  
  40.             throw findException(name);  
  41.         }  
  42.         try {  
  43.             //判断Map中是否存在改Class的实例  
  44.             T instance = (T) EXTENSION_INSTANCES.get(clazz);  
  45.             if (instance == null) {  
  46.                 //创建一个实例并保存到map中  
  47.                 EXTENSION_INSTANCES.putIfAbsent(clazz, (T) clazz.newInstance());  
  48.                 instance = (T) EXTENSION_INSTANCES.get(clazz);  
  49.             }  
  50.             //注入属性到实例中  
  51.             injectExtension(instance);  
  52.             Set<Class<?>> wrapperClasses = cachedWrapperClasses;  
  53.             if (wrapperClasses != null && wrapperClasses.size() > 0) {  
  54.                 for (Class<?> wrapperClass : wrapperClasses) {  
  55.                     instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));  
  56.                 }  
  57.             }  
  58.             return instance;  
  59.         } catch (Throwable t) {  
  60.             throw new IllegalStateException("Extension instance(name: " + name + ", class: " +  
  61.                     type + ")  could not be instantiated: " + t.getMessage(), t);  
  62.         }  
  63.     }  

看到这里思路应该比较清晰了!所有的接口代理中,并没有给定具体的实现,全部根据用户的参数配置来动态创建接口的具体实现。这样做让程序非常的灵活,让接口的实现插拔更加方便。如果想增加一个接口的实现,只需要按照SPI的配置方式增加配置文件,xml标签配置指定新接口实现的标记即可。

五 总结

终于写完了,累死宝宝了!  从分析中,接口代理的生成是不是有点动态代理的感觉。然后用户在XML中配置的dubbo标签属性都保存在了URL中,URL携带的参数贯穿了整个dubbo架构,所有的组件调用都根据URL中配置的参数做处理。其实SPI技术在很多地方都有用到,比如数据库的驱动,日志的处理,原理不是很复杂,仔细研究下就明白了。