Dubbo(Java SPI机制)

发表回复


  2. 什么是SPI

    SPI即Service Provider Interface，服务提供接口. 
    SPI思想 
    我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。

    为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。Java spi就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。
    JAVA中SPI的约定

    当服务的提供者，提供了服务接口的一种实现之后，在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候，就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名，并装载实例化，完成模块的注入。 

    基于这样一个约定就能很好的找到服务接口的实现类，而不需要再代码里制定。jdk提供服务实现查找的一个工具类：java.util.ServiceLoader. 
    代表性例子 

    jdbc:在jdbc4以前，开发人员还需要基于Class.forName("xxx")的方式来装载驱动。jdbc4也基于spi的机制来发现驱动提供商了，可以通过META-INF/services/java.sql.Driver文件里指定实现类的方式来暴露驱动提供者,比如下图中的ojdbc6。





    通过一个简单例子来说明SPI是如何使用的。 首先通过一张图来看看，用SPI需要遵循哪些规范，因为spi毕竟是JDK的一种标准。

    而后，把新加的实现，描述给JDK知道就行啦（通过改一个文本文件即可）公司内部，目前Dubbo框架就基于SPI机制提供扩展功能。




    DEMO     

    假设有一个内容搜索系统，搜索模块基于接口编程。搜索的实现可能是基于文件系统的搜索，也可能是基于数据库的搜索。

    Search.java: 搜索接口

    [java] view plain copy
    1. package spi;  
    2. public interface Search {  
    3.   public void search();  
    4. }  

    FileSearch.java:文件系统搜索的实现

    [java] view plain copy
    1. package spi;  
    2. public class FileSearch implements Search {  
    3.   @Override  
    4.   public void search() {  
    5.     System.out.println("哥是文件搜索");  
    6.   }  
    7. }  

    DatabaseSearch.java 数据库系统的搜索实现

    [java] view plain copy
    1. package spi;  
    2. public class DataBaseSearch implements Search {  
    3.   @Override  
    4.   public void search() {  
    5.     System.out.println("哥是database搜索");  
    6.   }  
    7. }  

    DoSearch.java

    [java] view plain copy
    1. public class DoSearch {  
    2.   public static void main(String[] args) {  
    3.     ServiceLoader<Search> sl = ServiceLoader.load(Search.class);  
    4.     Iterator<Search> s = sl.iterator();  
    5.     if (s.hasNext()) {  
    6.       Search ss = s.next();  
    7.       ss.search();  
    8.     }  
    9.   }  
    10. }  

    最后在META-INF/services目录下创建spi.Search(包名+接口名)文件，

    当文件内容为spi.FileSearch（包名+实现类名）时，程序输出结果为：哥是文件搜索

    当内容为spi.DataBaseSearch时，程序输出结果为：哥是database搜索.

    由此可以看出DOSearch类中没有任何和具体实现有关的代码，而是基于spi的机制去查找服务的实现。

     


  1. dubbo中基于SPI思想的实现

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

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

    • JDK标准的SPI会一次性实例化扩展点所有实现，如果有扩展实现初始化很耗时，但如果没用上也加载，会很浪费资源。
    • 如果扩展点加载失败，连扩展点的名称都拿不到了。比如：JDK标准的ScriptEngine，通过getName();获取脚本类型的名称，但如果RubyScriptEngine因为所依赖的jruby.jar不存在，导致RubyScriptEngine类加载失败，这个失败原因被吃掉了，和ruby对应不起来，当用户执行ruby脚本时，会报不支持ruby，而不是真正失败的原因。
    • 增加了对扩展点IoC和AOP的支持，一个扩展点可以直接setter注入其它扩展点。

     

    SPI接口定义

    dubbo定义了注解@SPI用于扩展

    [java] view plain copy
    1. public @interface SPI {  
    2.     /**  
    3.      * 缺省扩展点名。  
    4.      */   
    5.     String value() default "";  
    6. }  

    当接口上打了该注解时，dubbo会在META-INF/dubbo/internal/接口全名文件下读取扩展点。

    以Container接口为例，该接口打了SPI注解，

    [java] view plain copy
    1. @SPI("spring")   
    2. public interface Container {  
    3. }  

    dubbo中内置实现了各种Container 如：JettyContainer Log4JContainer SpringContainer 等等（@SPI("spring") 表示默认执行SpringContainer）,我们可以在META-INF/dubbo/internal文件夹中找到以Container全名命名的文件(如下图)，内容就是以key-value的方法保存的各个Container的现实，当dubbo启动时会读取该文件里的内容，加载相应的扩展点。


  2. ExtensionLoader类
    当dubbo启动时，通过ExtensionLoader类来读取扩展点中的实现类，

    如上图，首先读取SPI注解的value值，如果有值作为默认扩展实现的key，
    然后通过loadFile()依次逐行读取
    META-INF/dubbo/internal/com.alibaba.dubbo.XXX.XXX
    META-INF/dubbo/com.alibaba.dubbo.XXX.XXX
    META-INF/services/ com.alibaba.dubb    .XXX.XXX
    文件中的内容.
    其中的扩展点自动适配、包装将在以后的章节中做进一步介绍。