java SPI

什么是SPI

SPI的全名为Service Provider Interface.它是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。 java spi就是提供这样的一个机制：为某个接口寻找服务实现的机制。在模块化设计中这个机制尤其重要。

实现机制：

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

代码示例

编写接口：

public interface Hello {
    void sayHello();
}

两个实现类

public class ChineseHello implements Hello {
    @Override
    public void sayHello() {
        System.out.println("你好！");
    }
}
public class EnglishHello implements Hello {
    @Override
    public void sayHello() {
        System.out.println("hello!");
    }
}

配置文件

META-INF/services/目录下建立文件

com.lcq.service.Hello内容如下：

com.lcq.service.impl.ChineseHello
com.lcq.service.impl.EnglishHello

测试类

public class HelloTest {

    @Test
    public void testHello(){
        ServiceLoader<Hello> hellos = ServiceLoader.load(Hello.class);
        for (Hello h : hellos){
            h.sayHello();
        }
    }

}

运行结果：

你好！

hello!

在框架中经常使用SPI，能够更好的实现插件化管理配置，实现服务接口和具体实现的隔离。