MUYI · 后端工程师的生产级知识体系

Appearance

SPI ​

看在前面 ​

本文探析JDK提供的、在开源项目中常用的Java SPI机制。希望给大家在实际开发实践、学习开源项目提供参考。

一、SPI是什么 ​

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

整体机制图如下：

SPI机制图

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

系统设计的各个抽象，往往有很多不同的实现方案。在面向对象的设计里，一般推荐模块之间基于接口编程，模块之间不对实现类硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。

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

二、使用场景 ​

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

常见的例子：

  • 数据库驱动加载接口实现类的加载

JDBC加载不同类型数据库的驱动

  • 日志门面接口实现类加载

SLF4J加载不同提供商的日志实现类

  • Spring

Spring中使用了SPI,比如：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)

  • Dubbo

Dubbo中也使用SPI的方式实现框架的扩展。不过它对Java提供的原生SPI做了封装，允许用户扩展实现Filter接口

三、使用介绍 ​

要使用Java SPI，需要遵循如下约定：

  • 当服务提供者提供了接口的一种具体实现后，在jar包的META-INF/services目录下创建文件。文件以“接口全限定名”命名，内容为实现类的全限定名；

  • 接口实现类所在的jar包放在主程序的classpath中；

  • 主程序通过java.util.ServiceLoder动态装载实现模块。它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名，把类加载到JVM；

  • SPI的实现类必须携带一个不带参数的构造方法；

示例代码 ​

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

java
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，每行一个类）。

文件位置

java
- src
    -main
        -resources
            - META-INF
                - services
                    - org.foo.demo.IShout

文件内容

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

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

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

代码输出：

java
wang wang
miao miao

四、原理解析 ​

首先看ServiceLoader类的签名类的成员变量：

java
public final class ServiceLoader<S> implements Iterable<S>{
private static final String PREFIX = "META-INF/services/";

    // 代表被加载的类或者接口
    private final Class<S> service;

    // 用于定位，加载和实例化providers的类加载器
    private final ClassLoader loader;

    // 创建ServiceLoader时采用的访问控制上下文
    private final AccessControlContext acc;

    // 缓存providers，按实例化的顺序排列
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

    // 懒查找迭代器
    private LazyIterator lookupIterator;
  
    ......
}

参考具体ServiceLoader具体源码，代码量不多，加上注释一共587行，梳理后的实现流程如下：

  • 应用程序调用ServiceLoader.load方法

    ServiceLoader.load方法内先创建一个新的ServiceLoader，并实例化该类中的成员变量，包括：

    • loader(ClassLoader类型，类加载器)

    • acc(AccessControlContext类型，访问控制器)

    • providers(LinkedHashMap<String,S>类型，用于缓存加载成功的类)

    • lookupIterator(实现迭代器功能)

  • 应用程序通过迭代器接口获取对象实例

ServiceLoader先判断成员变量providers对象中(LinkedHashMap<String,S>类型)是否有缓存实例对象，如果有缓存，直接返回。如果没有缓存，执行类的装载，实现如下：

  1. 读取META-INF/services/下的配置文件，获得所有能被实例化的类的名称。值得注意的是，ServiceLoader可以跨越jar包获取META-INF下的配置文件。具体加载配置的实现代码如下：
java
private boolean hasNextService() {
	if (nextName != null) {
		return true;
	}
	if (configs == null) {
		try {
			String fullName = PREFIX + service.getName();
			if (loader == null)
				configs = ClassLoader.getSystemResources(fullName);
			else
				configs = loader.getResources(fullName);
		} catch (IOException x) {
			fail(service, "Error locating configuration files", x);
		}
	}
	while ((pending == null) || !pending.hasNext()) {
		if (!configs.hasMoreElements()) {
			return false;
		}
		pending = parse(service, configs.nextElement());
	}
	nextName = pending.next();
	return true;
}

  1. 通过反射方法Class.forName()加载类对象，并用instance()方法将类实例化。

  2. 把实例化后的类缓存到providers对象中，(LinkedHashMap<String,S>类型）然后返回实例对象。

java
// Cached providers, in instantiation order
private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

五、总结 ​

优点 ​

使用Java SPI机制的优势是实现解耦。它使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离，而不是耦合在一起。应用程序可以根据实际业务情况启用框架扩展或替换框架组件。

相比使用提供接口 jar 包、供第三方服务模块实现接口的方式，SPI 使源框架不必关心实现类的路径。源框架可以不用下面的方式获取接口实现类： [为什么Java的main方法必须是public static void？.md](Java main方法为什么是public static void.md)

  • 代码硬编码import 导入实现类

  • 指定类全路径反射获取：例如在JDBC4.0之前，JDBC中获取数据库驱动类需要通过Class.forName("com.mysql.jdbc.Driver")。类似语句先动态加载数据库相关的驱动，再执行获取连接这类操作。 [为什么Java的main方法必须是public static void？.md](Java main方法为什么是public static void.md)

  • 第三方服务模块把接口实现类实例注册到指定地方，源框架从该处访问实例

通过SPI的方式，第三方服务模块实现接口后，在配置文件中指定实现类的全路径名。配置文件位于第三方项目代码的 META-INF/services 目录下。源码框架即可找到实现类。

缺点 ​

  • 虽然ServiceLoader也算是延迟加载，但是只能通过遍历全部获取。即接口的实现类全部加载并实例化一遍。如果你并不想用某些实现类，它也被加载并实例化了，这就造成了浪费。获取某个实现类的方式不够灵活，只能通过Iterator形式获取，不能根据某个参数来获取对应的实现类。

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