Java:spi如何理解和实现

---

一、SPI基础概念

SPI全称Service Provider Interface，是Java提供的一套用来被第三方实现或者扩展的API，它可以用来启用框架扩展和替换组件。

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

系统设计的各个抽象，往往有很多不同的实现方案，在面向的对象的设计里，一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。
Java SPI就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。

二、SPI常见使用场景

概括地说，适用于：调用者根据实际使用需要，启用、扩展、或者替换框架的实现策略

• 数据库驱动加载接口实现类的加载JDBC加载不同类型数据库的驱动
• 日志门面接口实现类加载
• SLF4J加载不同提供商的日志实现类Spring，Spring中大量使用了SPI,比如：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等
• Dubbo，Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI做了封装，允许用户扩展实现Filter接口

三、SPI使用步骤

• 当服务提供者提供了接口的一种具体实现后，在jar包的META-INF/services目录下创建一个以“接口全限定名”为命名的文件，内容为实现类的全限定名；
• 接口实现类所在的jar包放在主程序的classpath中；
• 主程序通过java.util.ServiceLoder动态装载实现模块，它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名，把类加载到JVM；
• SPI的实现类必须携带一个不带参数的构造方法；

四、SPI使用Demo

首先我们定义我们要实现的接口

public interface SPIService {
    void execute();
}
1
2
3

然后定义相关实现类

public class SpiImpl1 implements SPIService{
    public void execute() {
        System.out.println("SpiImpl1.execute()");
    }
}


public class SpiImpl2 implements SPIService{
    public void execute() {
        System.out.println("SpiImpl2.execute()");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

在 src/main/resources/ 下建立 /META-INF/services 目录， 新增一个以接口命名的文件

- src
    -main
        -resources
            - META-INF
                - services
                    - org.xxx.SPIService
1
2
3
4
5
6

src/main/resource/META-INF/services/com.xxx.SPIService
1

com.viewscenes.netsupervisor.spi.SpiImpl1
com.viewscenes.netsupervisor.spi.SpiImpl2
1
2

而后通过ServiceLoader将相关实现类导入进来，调用相关方法

public class Test {
    public static void main(String[] args) {
        Iterator<SPIService> providers = Service.providers(SPIService.class);
        ServiceLoader<SPIService> load = ServiceLoader.load(SPIService.class);
        while(providers.hasNext()) {
            SPIService ser = providers.next();
            ser.execute();
        }
        System.out.println("--------------------------------");
        Iterator<SPIService> iterator = load.iterator();
        while(iterator.hasNext()) {
            SPIService ser = iterator.next();
            ser.execute();
        }
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

最终输出结果

SpiImpl1.execute()
SpiImpl2.execute()
--------------------------------
SpiImpl1.execute()
SpiImpl2.execute()
1
2
3
4
5

五、SPI原理

有关SPI的源码原理，网上相关资料很多，笔者这里就不过多进行赘述，其原理核心在于ServiceLoader，而ServiceLoader核心还是在于根据路径名和反射获取相关类