SPI机制理解与ServiceLoader

---

前言

最近项目中有看到使用ServiceLoader来进行服务类的加载，感觉新奇学习记录一下。

一、理论部分

1、SPI机制原理

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

Java SPI 实际上是“基于接口的编程＋策略模式＋配置文件”组合实现的动态加载机制。所以其具备面向接口编程、策略模式的优势，在实际应用中达到接口间充分解耦的目的。

2、ServiceLoader原理

2.1、应用程序调用ServiceLoader.load方法

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

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

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

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

1. 读取META-INF/services/下的配置文件，获得所有能被实例化的类的名称，值得注意的是，ServiceLoader可以跨越jar包获取META-INF下的配置文件。
2. 通过反射方法Class.forName()加载类对象，并用instance()方法将类实例化。
3. 把实例化后的类缓存到providers对象中，(LinkedHashMap<String,S>类型） 然后返回实例对象。

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;
  
    ......
}

3、ServiceLoader与ClassLoader

ServiceLoader与ClassLoader是Java中2个即相互区别又相互联系的加载器.JVM利用ClassLoader将类载入内存，这是一个类声明周期的第一步（一个java类的完整的生命周期会经历加载、连接、初始化、使用、和卸载五个阶段，当然也有在加载或者连接之后没有被初始化就直接被使用的情况）。而ServiceLoader是一个简单的服务提供者加载设施，及对特定配置的服务类进行加载。

具体区别：

1. ServiceLoader装载的是一系列有某种共同特征的实现类，而ClassLoader是个万能加载器；
2. ServiceLoader装载时需要特殊的配置，使用时也与ClassLoader有所区别；
3. ServiceLoader还实现了Iterator接口。

4、SPI机制的使用场景

• 数据库驱动加载接口实现类的加载
• JDBC加载不同类型数据库的驱动
• 日志门面接口实现类加载
• SLF4J加载不同提供商的日志实现类

Spring

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

Dubbo

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

SPI机制因为是面向接口编程和策略模式的思想，所以根据不同业务场景可以灵活应用。实际应用中在涉及与第三方交互的情况，可以提供接口给第三方，第三方根据接口编程，从而不用关注第三方的具体实现。

5、SPI使用要点

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

二、实践部分

1.SPI机制的简单使用

目录结构:
spi_interface:服务接口
spi_weixin:服务实例1，假设为微信支付场景
spi_zfb:服务实例2，假设为支付宝支付场景
spi_core:服务加载，使用ServiceLoader加载各个服务实例
spi_test:测试模块

1.1 spi_interface模块

接口：

public interface PayWay {
    void pay();
}

1.2 spi_weixin 模块

服务类：

public class WeixinPay implements PayWay {
    public void pay() {
        System.out.println("调用微信支付接口完成支付...");
    }
}

配置：

1.3 spi_zfb模块

省略了，同spi_weixin模块…

1.4 spi_core模块

服务加载类：

import com.inter.PayWay;

import java.util.Iterator;
import java.util.ServiceLoader;

/**
 * TODO：
 *
 * @Version 1.0
 * @Author HJL
 * @Date 2022/3/5 11:05
 */
public class PayFactory {

    public void invoke(){
        ServiceLoader<PayWay> serviceLoader = ServiceLoader.load(PayWay.class);
        Iterator<PayWay> iterator = serviceLoader.iterator();

        boolean notFound = true;
        while (iterator.hasNext()){
            notFound = false;
            PayWay payWay = iterator.next();
            payWay.pay();
        }

        if(notFound){
            System.out.println("未发现具体实现...");
        }
    }
}

1.5 spi_test 模块

public class SPITest {
    public static void main(String[] args) {
        PayFactory factory = new PayFactory();
        factory.invoke();
    }
}

测试结果：

说明已成功实现服务加载。

2、SPI机制深入

基于上面测试的结果，将spi_interface,spi_weixin,spi_zfb三个模块打jar包，在新的项目中引入，即可真实模范三方应用的接入使用。

总结

优点：

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

缺点：

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