Java SPI 机制学习

一、什么是SPI

SPI的全名为Service Provider Interface。在java.util.ServiceLoader的文档里有比较详细的介绍。

Java SPI 实际上是“基于接口的编程＋策略模式＋配置文件”组合实现的动态加载机制。

一个已知的接口或者抽象类,有多个对这个接口或者抽象类的实现。按照SPI的标准在资源路径META-INF/services目录下创建一个文件名为该接口的全限定名。文件里面一行写一个对应调用的实现类全限定类名.然后调用该接口里方法时就可以调用对应的实现类中的实现方法。

二、使用SPI的好处

这种方式主要是针对不同的服务提供厂商，对不同场景的提供不同的解决方案制定的一套标准，举个简单的例子，如现在的JDK中有支持音乐播放，假设只支持mp3的播放，有些厂商想在这个基础之上支持mp4的播放，有的想支持mp5，而这些厂商都是第三方厂商，如果没有提供SPI这种实现标准，那就只有修改JAVA的源代码了.

三、SPI使用实例

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

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

实例文件路径如下

- src
    -main
        -resources
            - META-INF
                - services
                - java.util.Comparator -- 文件名(不是文件夹)

 文件内容只有一行：(这一行是你实现了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) {
        return o1.getName().compareTo(o2.getName()); //依据name排序 
    }
}

下面是主程序：

 //从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);
        
        Comparator<MyItem> myCompartor= getCompartor();
        Collections.sort(myList,myCompartor);
       
        showList(myList);   
    }
   

    private static Comparator<MyItem> getCompartor() {
       
        for(Comparator service : serviceLoader) {

           return (Comparator<MyItem>)service;

        }
              
        return null;
    }

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