Java之SPI机制

之前开阿里的HSF框架，里面用到了Java的SPI机制，今天闲暇的时候去了解了一下，通过写博客来记录一下

 

SPI的全名为Service Provider Interface，我对于该机制的理解是为接口寻找服务实现类。现在公司的系统都是进行了模块的划分，系统抽象为多个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。于是就有了SPI这种服务发现机制。

 

java spi的具体使用如下  ：

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

基于这样一个约定就能很好的找到服务接口的实现类，而不需要再代码里制定。

jdk提供服务实现查找的一个工具类：java.util.ServiceLoader

 

参考案例：

项目文件结构：

 

参考代码：

Developer.java

package cn.edu.knowledge.spi;

public interface Developer {

    public String getPrograme();

}

 

 

JavaDeveloper.java

package cn.edu.knowledge.spi;

public class JavaDeveloper implements Developer {

    @Override

    public String getPrograme() {

        return "Java";
    }
}

 

 

META-INF\services文件下的cn.edu.knowledge.spi.Developer文件内容是服务类的全限命名：

cn.edu.knowledge.spi.JavaDeveloper

 

将文件导出为jar包，新建一个项目，在项目中导入该jar,下面的测试类的代码

Test.java

import java.util.ServiceLoader;
import cn.edu.knowledge.spi.Developer;
public class Test {

    public ServiceLoader<Developer> serviceloader = ServiceLoader.load(Developer.class);

    public static void main(String[] arg) {

        Test devClient = new Test();

        Developer dev = devClient.getDeveloper();

        System.out.println(dev.getPrograme());

    }
    private Developer getDeveloper() {

        Developer lastdev = null;

        for (Developer dev : serviceloader) {

            System.out.println("out." + dev.getPrograme());

            lastdev = dev;

        }
        if(lastdev==null)
            System.out.println("why...");
        return lastdev;

    }

}

 

我们在开发中都有用到SPI机制，但是我们没有意识到比如：

1.common-logging

apache最早提供的日志的门面接口。只有接口，没有实现。具体方案由各提供商实现，发现日志提供商是通过扫描  META-INF/services/org.apache.commons.logging.LogFactory 配置文件，通过读取该文件的内容找到日志提工商实现类。只要我们的日志实现里包含了这个文件，并在文件里制定   LogFactory工厂接口的实现类即可。

2.jdbc

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

学习到的知识：面向接口编程可以实现接口和实现的分离，这样做的最大好处就是能够在客户端未知的情况下修改实现代码。那么什么时候应该抽象出Java接口呢？一种是用在层和层之问的调用。层和层之间是最忌讳耦合度过高或是改变过于频繁。设计优秀的接口能够解决这个问题。另一种是用在那些不稳定的部分上。如果某些需求的变化性很大，那么定义接口也是一种解决之道。设计良好的接口就像是我们日常使用的万用插座一样，不论插头如何变化，都可以使用。