聊聊 Java SPI 机制，你会了吗？

2023-02-28

java 接口 spi

vaSPI是基于接口的编程+策略模式+约定配置文件组合实现的动态加载机制，能够很方便的为某个接口寻找服务实现的机制。今天这篇文章就来深入聊一下SPI。什么是SPI?SPI全称：ServiceProviderInterface，是Java提供的一套用来被第三方实现或者扩展的接口，它可以用来启用框架扩展

va SPI 是基于接口的编程+策略模式+约定配置文件组合实现的动态加载机制，能够很方便的为某个接口寻找服务实现的机制。

今天这篇文章就来深入聊一下SPI。

什么是SPI?

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

面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。

为了实现在模块装配的时候不用在程序里动态指明，这就需要一种服务发现机制。java spi就是提供这样的一个机制：为某个接口寻找服务实现的机制。这有点类似IOC的思想，将装配的控制权移到了程序之外。

这是一种JDK内置的一种服务发现的机制，用于制定一些规范，实际实现方式交给不同的服务厂商。如下图：

解耦、可拔插、面向接口编程、动态类加载。

当服务的提供者提供了一种接口的实现之后，需要在classpath下的 META-INF/services/ 目录里创建一个以服务接口命名的文件，这个文件里的内容就是这个接口的具体的实现类。

当其他的程序需要这个服务的时候，就可以通过查找这个jar包(一般都是以jar包做依赖)的META-INF/services/中的配置文件，配置文件中有接口的具体实现类名，可以根据这个类名进行加载实例化，就可以使用该服务了。JDK中查找服务的实现的工具类是：java.util.ServiceLoader。

SPI 的不足

不能按需加载，需要遍历所有的实现，并实例化，然后在循环中才能找到我们需要的实现。如果不想用某些实现类，或者某些类实例化很耗时，它也被载入并实例化了，这就造成了浪费。

获取某个实现类的方式不够灵活，只能通过 Iterator 形式获取，不能根据某个参数来获取对应的实现类。(Spring 的BeanFactory，ApplicationContext 就要高级一些了。)

多个并发多线程使用 ServiceLoader 类的实例是不安全的。

API 与 SPI 区别?

API是调用并用于实现目标的类、接口、方法等的描述;

SPI是扩展和实现以实现目标的类、接口、方法等的描述;

换句话说，API 为操作提供特定的类、方法，SPI 通过操作来符合特定的类、方法。

SPI和API的使用场景解析：

API (Application Programming Interface)在大多数情况下，都是实现方制定接口并完成对接口的实现，调用方仅仅依赖接口调用，且无权选择不同实现。从使用人员上来说，API 直接被应用开发人员使用。
SPI (Service Provider Interface)是调用方来制定接口规范，提供给外部来实现，调用方在调用时则选择自己需要的外部实现。从使用人员上来说，SPI 被框架扩展人员使用。

SPI 案例实现

下面来一个简单的案例实现：比如每个动物都有不同的叫声，作为声纹系统会定义一个接口，如下：

public interface AnimalSay {
    void say();
}1.
2.
3.

在这个系统中并没有实现具体的实现，但是在处理业务逻辑时有需要用到该实例，此时就需要用到SPI去加载实现类，定义一个AnimalManagerLoader，实现如下：

@Data
public class AnimalManagerLoader {
    private static final AnimalManagerLoader INSTANCE = new AnimalManagerLoader();

    private final List<AnimalSay> animalSays;

    private AnimalManagerLoader() {
        animalSays = load();
    }

    /**
     * 通过SPI加载实现类
     */
    private List<AnimalSay> load() {
        ArrayList<AnimalSay> animalSays = new ArrayList<>();
        Iterator<AnimalSay> iterator = ServiceLoader.load(AnimalSay.class).iterator();
        while (iterator.hasNext()){
            animalSays.add(iterator.next());
        }
        return animalSays;
    }

    public static AnimalManagerLoader getInstance() {
        return INSTANCE;
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.

此时就可以通过AnimalManagerLoader中的load方法去加载对应的实现类，封装到List集合中，调用如下：

public static void main(String[] args) {
        AnimalManagerLoader animalManagerLoader = AnimalManagerLoader.getInstance();
        List<AnimalSay> animalSays = animalManagerLoader.getAnimalSays();
        for (AnimalSay animalSay : animalSays) {
            animalSay.say();
        }
   }1.
2.
3.
4.
5.
6.
7.

那么此时提供声音的厂家就需要实现这个接口，比如狗狗的声纹厂家，实现如下：

/**
 * 狗狗的声纹
 */
public class DogSay implements AnimalSay {
    public void say() {
        System.out.println("wang wang ~");
    }
}1.
2.
3.
4.
5.
6.
7.
8.

猫咪的声纹如下：

/**
 * 猫咪的声纹
 */
public class CatSay implements AnimalSay {
    @Override
    public void say() {
        System.out.println("miao miao ~");
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.

实现类定义了，就需要在 /META-INF/services 中定义一个 com.myjszl.animal.api.AnimalSay文件，内容如下：

com.myjszl.dog.api.DogSay
com.myjszl.dog.api.CatSay1.
2.

SPI 应用场景

SPI扩展机制应用场景有很多，比如Common-Logging，JDBC，Dubbo、ShardingSphere等等。

1. JDBC场景

java中定义的java.sql.Driver接口，并没有具体的实现，实现方式而是交给不同的服务厂商：

在MySQL的jar包mysql-connector-java-6.0.6.jar中，可以找到META-INF/services目录，该目录下会有一个名字为java.sql.Driver的文件，文件内容是com.mysql.cj.jdbc.Driver，这里面的内容就是针对Java中定义的接口的实现。
PostgreSQL的jar包PostgreSQL-42.0.0.jar中，也可以找到同样的配置文件，文件内容是org.postgresql.Driver，这是PostgreSQL对Java的java.sql.Driver的实现。

2. ShardingSphere的场景

在ShardingSphere中为了实现分布式事务提供了一个接口ShardingTransactionManager，但是在其架构中并未对其做出具体的实现，而是交给不同的厂商去实现，比如JTA强一致性事务的XAShardingTransactionManager，在其中META-INF/services就有一个org.apache.shardingsphere.transaction.spi.ShardingTransactionManager文件，如下图：