Java的SPI机制和例子

 

参考文档很好：http://blog.csdn.net/fenglibing/article/details/7083526

 

============================================================================

本文出自：冯立彬的博客http://blog.csdn.net/fenglibing/article/details/7083071

    一个服务(service)通常指的是已知的接口或者抽象类，服务提供方就是对这个接口或者抽象类的实现，然后按spi标准存放到资源路径META-INF/services目录下，文件的命名为该服务接口的全限定名。如有一个服务接口com.test.Service，其服务实现类为com.test.ChildService，那此时需要在META-INF/services中放置文件com.test.Service，其中的内容就为该实现类的全限定名com.test.ChildService，有多个服务实现，每一行写一个服务实现，#后面的内容为注释，并且该文件只能够是以UTF-8编码。
    这种实现方式，感觉和我们通常的开发方式差不多，都是定义一个接口，然后子类实现父类中定义的方法，为什么要搞这么一套标准以及单独搞一个配置文件？这种方式主要是针对不同的服务提供厂商，对不同场景的提供不同的解决方案制定的一套标准，举个简单的例子，如现在的JDK中有支持音乐播放，假设只支持mp3的播放，有些厂商想在这个基础之上支持mp4的播放，有的想支持mp5，而这些厂商都是第三方厂商，如果没有提供SPI这种实现标准，那就只有修改JAVA的源代码了，那这个弊端也是显而易见的，也就是不能够随着JDK的升级而升级现在的应用了，而有了SPI标准，SUN公司只需要提供一个播放接口，在实现播放的功能上通过ServiceLoad的方式加载服务，那么第三方只需要实现这个播放接口，再按SPI标准进行打包成jar，再放到classpath下面就OK了，没有一点代码的侵入性。

    以下是找到的几篇文章：

    1、http://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html，这个是官方的文档，有对service的详细介绍，包括规范以及一个简单的示例，这个是学习SPI必须看的文档；

    注：http://docs.oracle.com/javase/1.4.2/docs/guide/jar/jar.html#Service%20Provider，这个是1.4中对Service Provider的介绍，加载服务是通过sun.misc.Service进行加载的，这个也有相应的示例，照做就OK；

    2、Java的SPI机制：http://www.2cto.com/kf/201012/79868.html，这个是国人写的一篇示例文章，也挺不错，里面也有一个简单的示例；

    3、Developing a Service Provider using Java API(Service Provider Interface)：http://blog.csdn.net/fenglibing/article/details/7083526，这篇文章是转的alexa发表在blogspot上面的，也是一个开发SPI的示例，有兴趣的也可以看看；

    4、Add Mp3 capabilities to Java Sound with SPI：http://www.javaworld.com/javaworld/jw-11-2000/jw-1103-mp3.html，这是一个比较老的例子，基于jdk1.3的，因为在jdk1.3的时候还没有支持mp3格式，只支持AU, AIF, MIDI, and WAV等格式，也是一个值得参考的示例。

    我这边也写了一个简单得不能够再简单的示例，源码可以这里下载：http://download.csdn.net/detail/fenglibing/3939882

 

 

============================================================================

例子From：http://www.2cto.com/kf/201012/79868.html

 SPI的全名为Service Provider Interface.普通开发人员可能不熟悉，因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。究其思想，其实是和"Callback"差不多。“Callback”的思想是在我们调用API的时候，我们可以自己写一段逻辑代码，传入到API里面，API内部在合适的时候会调用它，从而实现某种程度的“定制”。

    典型的是Collections.sort（List<T> list,Comparator<? super T> c）这个方法，它的第二个参数是一个实现Comparator接口的实例。我们可以根据自己的排序规则写一个类，实现此接口，传入此方法，那么这个方法就会根据我们的规则对list进行排序。

    把这个思想扩展开来，我们用SPI来重新实现上面的例子。客户把自己的排序规则写成一个类，并且打包成Jar文件，这个Jar文件里面必须有META-INF目录，其下又有services目录，其下有一个文本文件，文件名即为接口的全名：java.util.Comparator。

--META-INF
  --services
    --java.util.Comparator

文件内容只有一行：
com.company1.ComparatorProvider

这一行是你实现了Comparator接口的类的全名，它的代码如下：

package com.company1;
import java.util.Comparator;
import com.mycompany.myapp.MyItem;
public class ComparatorProvider implements Comparator<MyItem>{

    @Override
    public int compare(MyItem o1, MyItem o2) {
                //依据name排序  
        return o1.getName().compareTo(o2.getName());
    }

}

编译打包后，把它放到你的主程序的class path里。下面是你的主程序：

      //从class path中所有Jar的META-INF目录中搜索，找到合适的类并加载。
    private static ServiceLoader<Comparator> serviceLoader
    = ServiceLoader.load(Comparator.class);
    
    public static void main(String[] args)
    {
        List<MyItem> myList = new ArrayList<MyItem>();
        myList.add(new MyItem(2,"c","hhh"));
        myList.add(new MyItem(3,"k","ooo"));
        myList.add(new MyItem(4,"d","ppp"));
        myList.add(new MyItem(5,"b","ggg"));
        
        showList(myList);
        
        Collections.sort(myList,getCompartor());
        
        showList(myList);    
    }
    
    @SuppressWarnings("unchecked")
    private static Comparator<MyItem> getCompartor() {
        
        for(Comparator service : serviceLoader)
        {
           return (Comparator<MyItem>)service;
        }
               
        return null;
    }

要注意的是serviceLoader开始只是加载类，实例化要到第一次用的时候。类MyItem和方法showList并不重要，所以你不必在意。你可以按照这个规则，写另外一个排序规则的Jar,随时可以更换你的排序规则.

 

+

+

+

finished

=

=

=