Java 的 SPI 机制

原创

EicroSoft 2023-04-23 12:13:44 博主文章分类：JAVA ©著作权

©著作权归作者所有：来自51CTO博客作者EicroSoft的原创作品，请联系作者获取转载授权，否则将追究法律责任

什么是SPI机制？

SPI机制（ Service Provider Interface）是Java的一种服务发现机制，为了方便应用扩展。那什么是服务发现机制？简单来说，就是你定义了一个接口，但是不提供实现，接口实现由其他系统应用实现。你只需要提供一种可以找到其他系统提供的接口实现类的能力或者说机制.
SPI机制在Java中有很广泛的运用，比如：eclipse和idea里的插件使用就是通过SPI机制实现的。开发工具提供一个扩展接口，具体的实现由插件开发者实现，开发工具提供一种服务发现机制来找到具体插件的实现，这就达到了插件的安装效果。从而可以使用插件服务。如果不需要某一插件，只需要删除某一插件的实现类，开发工具找不到具体的插件实现，这就达到了插件的卸载效果。不管是安装还是卸载都不会影响其他代码，其他服务。非常方便的实现了可插拔的效果。

JDBC中数据库连接驱动也使用了SPI机制，来达到适配不同DB数据库的效果。

SPI机制除了在jdk里有运用，在springboot中也用到了。springboot自动装配中"查找spring.factories 文件步骤"就是基于SPI的部分设计思想实现的。

SPI 有如下的好处：

不需要改动源码就可以实现扩展，解耦。
实现扩展对原来的代码几乎没有侵入性。
只需要添加配置就可以实现扩展，符合开闭原则。

API 和 SPI 区别

API：大多数情况下，都是实现方制定接口并完成对接口的实现，调用方仅仅依赖接口调用。

SPI ：是调用方来制定接口规范，提供给外部来实现，调用方在调用时则选择自己需要的外部实现。

Java 的 SPI 机制_ide

SPI实现服务接口与服务实现的解耦：

服务提供者（如 springboot starter）提供出 SPI 接口，让客户端去自定义实现。
客户端（普通的 springboot 项目）即可通过本地注册的形式，将实现类注册到服务端，轻松实现可插拔。

简单实现

定义接口

package com.test.service;

public interface ISpi {
    void say();
}

第一个实现类：

package com.test.service.impl;

import com.test.service.ISpi;

public class FirstSpiImpl implements ISpi {

    @Override
    public void say() {
        System.out.println("我是第一个SPI实现类");
    }
}

第二个实现类：

package com.test.service.impl;

import com.test.service.ISpi;

public class SecondSpiImpl implements ISpi {

    @Override
    public void say() {
        System.out.println("我是第二个SPI实现类");
    }
}

在resources目录下新建META-INF/services目录，并且在这个目录下新建一个与上述接口的全限定名一致的文件，在这个文件中写入接口的实现类的全限定名，并写上需要动态加载的实现类的全路径名。

#com.test.service.impl.FirstSpiImpl
com.test.service.impl.SecondSpiImpl

ServiceLoader

ServiceLoader是JDK提供的专门用于实现SPI机制的类。位于java.util.ServiceLoader
ServiceLoader类的构造函数被私有化了。所以构建ServiceLoader对象只能通过ServiceLoader.load()方法。该方法有两个重载
使用ServiceLoader时可选择是否用自定义类加载器来加载目标类。也可默认使用应用程序类加载器加载。

jdk通过ServiceLoader类去ClassPath下的 “META-INF/services/”（此路径约定成俗）路径里查找相应的接口实现类。ServiceLoader类核心功能就两个点，都在ServiceLoader的内部类LazyIterator中：

查找相应接口对应实现类:hasNextService()
加载相应接口实现类到虚拟机内:nextService()

public final class ServiceLoader<S> implements Iterable<S> {


    //扫描目录前缀
    private static final String PREFIX = "META-INF/services/";

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

    // 用于定位、加载和实例化实现方实现的类的类加载器
    private final ClassLoader loader;

    // 上下文对象
    private final AccessControlContext acc;

    // 按照实例化的顺序缓存已经实例化的类
    private LinkedHashMap<String, S> providers = new LinkedHashMap<>();

    // 懒查找迭代器
    private java.util.ServiceLoader.LazyIterator lookupIterator;

    // 私有内部类，提供对所有的service的类的加载与实例化
    private class LazyIterator implements Iterator<S> {
        Class<S> service;
        ClassLoader loader;
        Enumeration<URL> configs = null;
        String nextName = null;

        //...
        private boolean hasNextService() {
            if (configs == null) {
                try {
                    //获取目录下所有的类 扫描目录前缀（META-INF/services/）+ 相应接口全限定名
                    String fullName = PREFIX + service.getName();
                    //该loader是构造ServiceLoader类时设置。可传入自定义类加载器，如未传入，则默认应用程序类加载器  
                    if (loader == null)
                        //在系统中查找资源，注意查找资源的加载器是从当前线程上下文中获取。也就是默认的应用程序类加载器。所以能加载到第三方jar包下的classpath路径。
                        configs = ClassLoader.getSystemResources(fullName);
                    else
                        configs = loader.getResources(fullName);
                } catch (IOException x) {
                    //...
                }
                //....
            }
        }

        private S nextService() {
            String cn = nextName;
            nextName = null;
            Class<?> c = null;
            try {
                //反射加载类
                c = Class.forName(cn, false, loader);
            } catch (ClassNotFoundException x) {
            }
            try {
                //实例化
                S p = service.cast(c.newInstance());
                //放进缓存
                providers.put(cn, p);
                return p;
            } catch (Throwable x) {
                //..
            }
            //..
        }
    }
}

应用程序通过迭代器接口获取对象实例，这里首先会判断 providers 对象中是否有实例对象：