Java中SPI机制详解

本文来说下Java中SPI机制

---

SPI是什么

SPI全称Service Provider Interface，是Java提供的一套用来被第三方实现或者扩展的API，它可以用来启用框架扩展和替换组件。大多数开发人员可能不熟悉，因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。

整体机制图如下：

---

什么是策略模式

策略模式：https://blog.csdn.net/qq_31960623/article/details/118423398

---

使用场景

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

比较常见的例子：

1. 数据库驱动加载接口实现类的加载，JDBC加载不同类型数据库的驱动。
2. 日志门面接口实现类加载，SLF4J加载不同提供商的日志实现类。
3. Spring中大量使用了SPI，比如：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等。
4. springboot中的自动配置原理，即SpringFactoriesLoader类读取配置文件 spring.factories 中的配置文件的这种方式是一种 SPI 的思想。
5. Dubbo中也大量使用SPI的方式实现框架的扩展，不过它对Java提供的原生SPI做了封装，允许用户扩展实现Filter接口。

---

使用介绍

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

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

---

示例代码

定义一组接口 ，并写出接口的一个或多个实现

cn.wideth.spi.IShout接口

package cn.wideth.spi;

public interface IShout {

    void shout();
}

接口的一个实现类

package cn.wideth.spi;

public class Cat implements IShout{

    @Override
    public void shout() {

        System.out.println("miao miao");
    }
}

接口另外一个实现类

package cn.wideth.spi;

public class Dog implements IShout{

    @Override
    public void shout() {

        System.out.println("wang wang");
    }
}

在 src/main/resources/ 下建立 /META-INF/services 目录。新增一个以接口命名的文件 (cn.wideth.spi.IShout文件)，内容是要应用的实现类（这里是cn.wideth.spi.Cat和cn.wideth.spi.Dog，每行一个类）

测试程序

package cn.wideth.spi;

import java.util.ServiceLoader;

public class Main {

    public static void main(String[] args) {

        ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
        for (IShout s : shouts) {
            s.shout();
        }
    }
}

程序结果

---

原理解析

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

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;

    ......
}

参考具体源码，梳理了一下，实现的流程如下：

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

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

• loader(ClassLoader类型，类加载器)
• acc(AccessControlContext类型，访问控制器)
• providers(LinkedHashMap类型，用于缓存加载成功的类)
• lookupIterator(实现迭代器功能)

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

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

• 读取META-INF/services/下的配置文件，获得所有能被实例化的类的名称
• 通过反射方法Class.forName()加载类对象，并用instance()方法将类实例化
• 把实例化后的类缓存到providers对象中(LinkedHashMap类型），然后返回实例对象。

---

本文小结

本文详细介绍了JDK中的spi机制，这种机制在springboot和dubbo中都有被使用到。