Java SPI机制_spi机制适用于抽象类吗-CSDN博客

本文链接：https://blog.csdn.net/u013096088/article/details/86660242

SPI是什么

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

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

系统设计的各个抽象，往往有很多不同的实现方案，在面向的对象的设计里，一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。

一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。

Java SPI就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。

使用场景

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

比较常见的例子：

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

使用SPI

我们已经知道JDBC就是一个SPI的典型实现。关于数据库连接，JDK提供了一整套相关的类和接口的完整体系，而具体的实现是由相应的数据库厂商来提供的。看下面的例子，通过Java的SPI去加载mysql驱动。

import java.sql.Driver;
import java.util.Iterator;
import java.util.ServiceLoader;

public class SPITest {
    public static void main(String[] args) {
		// 这个Driver类就是jdk内置的接口
        // 我们通过JDK内置的ServiceLoader组件去加载相应接口的实现类
        ServiceLoader<Driver> serviceLoader = ServiceLoader.load(Driver.class);

        Iterator<Driver> iterable = serviceLoader.iterator();
        while (iterable.hasNext()) {
            Driver driver = iterable.next();
            System.out.println("加载mysql驱动：" + driver.getClass());
        }
    }
}

当然，运行此程序前，需要先把mysql驱动放到类路径下。我们得到的结果是：

加载mysql驱动：class com.mysql.jdbc.Driver
加载mysql驱动：class com.mysql.fabric.jdbc.FabricMySQLDriver

显然，我们已经加载到了mysql的驱动。上面代码很简单，仅仅一行代码ServiceLoader.load(Driver.class)

如何定义一个SPI

步骤1：定义一组接口（假设是org.foo.demo.IShout），并写出接口的一个或多个实现，（假设是org.foo.demo.animal.Dog、org.foo.demo.animal.Cat）。

public interface IShout {
    void shout();
}

public class Cat implements IShout {
    @Override
    public void shout() {
        System.out.println("miao miao");
    }
}

public class Dog implements IShout {
    @Override
    public void shout() {
        System.out.println("wang wang");
    }
}

步骤2：在 src/main/resources/ 下建立 /META-INF/services 目录，新增一个以接口命名的文件（org.foo.demo.IShout文件），内容是要应用的实现类（这里是org.foo.demo.animal.Dog和org.foo.demo.animal.Cat，每行一个类）。

org.foo.demo.animal.Dog
org.foo.demo.animal.Cat

步骤3：使用 ServiceLoader来加载配置文件中指定的实现。

public class SPIMain {
    public static void main(String[] args) {
        ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
        for (IShout s : shouts) {
            s.shout();
        }
    }
}

代码输出：

wang wang
miao miao

我们就能拿到所有的具体实现类了。所以想要弄懂Java的SPI，我们需要从ServcieLoader这个类入手。

ServiceLoader

以下内容介绍来源ServiceLoader的Java doc。建议大家自己去读一遍。

ServiceLoader是一个简单的服务提供者加载组件。（注意，从JDK1.6开始，Java平台才提供了该组件。）

Service和Service-Provider

所谓服务，就是一个熟知的接口和类（通常为抽象类）的集合。提供者中的类通常实现服务接口，或者继承这个服务抽象类。服务提供者可以以扩展的形式安装在 Java 平台的实现中，也就是将 jar 文件放入任意常用的扩展目录中。也可通过将提供者加入应用程序类路径下。

在上面的例子里，java.sql.Driver就是服务接口，mysql驱动的jar包就是服务提供者。

加载的机制

为了达到加载的目的，服务应该由单个类型表示，也就是单个接口或抽象类（可以使用具体类，但建议不要这样做）。一个指定服务的提供者包含一个或多个具体类，这些类扩展了这个服务类型，具有特定于提供者的数据和代码。提供者类的细节是与特定的服务高度相关的。使用该组件的唯一强制要求的是，提供者类必须具有不带参数的构造方法，以便它们可以在加载中被实例化。

通过在资源目录 META-INF/services 中放置提供者配置文件来标识服务提供者。配置文件的名称必须是服务类型的全限定的二进制名称。该文件包含一个具体提供者类的全限定二进制名称的列表。然后文件必须使用 UTF-8 编码。

由此我们知道，要使用Java的SPI，需要遵循如下约定：