Java 基础 008：SPI机制详解

SPI（Service Provider Interface）是 JDK 内置的服务提供发现机制，也是 JDBC 驱动自动加载、Spring Boot 自动装配背后的共同思想。本文从一个简单示例入手，逐步拆解 SPI 的使用、广泛应用场景与实现原理。

什么是 SPI 机制

SPI（Service Provider Interface），是 JDK 内置的一种服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用。比如 java.sql.Driver 接口，其他不同厂商可以针对同一接口做出不同的实现，MySQL 和 PostgreSQL 都有不同的实现提供给用户，而 Java 的 SPI 机制可以为某个接口寻找服务实现。

Java 中 SPI 机制主要思想是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要，其核心思想就是解耦。

SPI 整体机制图如下：

flowchart TD
    A["服务提供者 Provider"] -->|"实现服务接口，并在 jar 包的 META-INF/services 目录下创建以接口全限定名命名的文件，写入实现类"| B["包含配置的 jar 包"]
    C["调用方程序"] -->|"ServiceLoader.load 接口.class"| D["java.util.ServiceLoader"]
    B --> D
    D -->|"查找并解析 META-INF/services 配置，加载并实例化实现类"| E["返回接口实现的实例"]
    E --> C

当服务的提供者提供了一种接口的实现之后，需要在 classpath 下的 META-INF/services/ 目录里创建一个以服务接口命名的文件，这个文件里的内容就是这个接口的具体的实现类。当其他的程序需要这个服务的时候，就可以通过查找这个 jar 包（一般都是以 jar 包做依赖）的 META-INF/services/ 中的配置文件，配置文件中有接口的具体实现类名，可以根据这个类名进行加载实例化，就可以使用该服务了。JDK 中查找服务的实现的工具类是：java.util.ServiceLoader。

SPI 机制的简单示例

我们现在需要使用一个内容搜索接口，搜索的实现可能是基于文件系统的搜索，也可能是基于数据库的搜索。

先定义好接口：

public interface Search {
    public List<String> searchDoc(String keyword);
}

文件搜索实现：

public class FileSearch implements Search {
    @Override
    public List<String> searchDoc(String keyword) {
        System.out.println("文件搜索 " + keyword);
        return null;
    }
}

数据库搜索实现：

public class DatabaseSearch implements Search {
    @Override
    public List<String> searchDoc(String keyword) {
        System.out.println("数据搜索 " + keyword);
        return null;
    }
}

接下来可以在 resources 下新建 META-INF/services/ 目录，然后新建接口全限定名的文件：com.cainiao.ys.spi.learn.Search，里面加上我们需要用到的实现类：

com.cainiao.ys.spi.learn.FileSearch

测试方法：

public class TestCase {
    public static void main(String[] args) {
        ServiceLoader<Search> s = ServiceLoader.load(Search.class);
        Iterator<Search> iterator = s.iterator();
        while (iterator.hasNext()) {
            Search search = iterator.next();
            search.searchDoc("hello world");
        }
    }
}

可以看到输出结果：文件搜索 hello world。

如果在 com.cainiao.ys.spi.learn.Search 文件里写上两个实现类，那最后的输出结果就是两行了。这就是因为 ServiceLoader.load(Search.class) 在加载某接口时，会去 META-INF/services 下找接口的全限定名文件，再根据里面的内容加载相应的实现类。

这就是 SPI 的思想：接口的实现由 provider 实现，provider 只用在提交的 jar 包里的 META-INF/services 下根据平台定义的接口新建文件，并添加进相应的实现类内容就好。

SPI 机制的广泛应用

SPI 机制 - JDBC DriverManager

在 JDBC 4.0 之前，我们开发有连接数据库的时候，通常会用 Class.forName("com.mysql.jdbc.Driver") 这句先加载数据库相关的驱动，然后再进行获取连接等的操作。而 JDBC 4.0 之后不需要用 Class.forName("com.mysql.jdbc.Driver") 来加载驱动，直接获取连接就可以了，现在这种方式就是使用了 Java 的 SPI 扩展机制来实现。

JDBC 接口定义：首先在 java 中定义了接口 java.sql.Driver，并没有具体的实现，具体的实现都是由不同厂商来提供的。

mysql 实现：在 mysql 的 jar 包 mysql-connector-java-6.0.6.jar 中，可以找到 META-INF/services 目录，该目录下会有一个名字为 java.sql.Driver 的文件，文件内容是 com.mysql.cj.jdbc.Driver，这里面的内容就是针对 Java 中定义的接口的实现。

postgresql 实现：同样在 postgresql 的 jar 包 postgresql-42.0.0.jar 中，也可以找到同样的配置文件，文件内容是 org.postgresql.Driver，这是 postgresql 对 Java 的 java.sql.Driver 的实现。

使用方法：上面说了，现在使用 SPI 扩展来加载具体的驱动，我们在 Java 中写连接数据库的代码的时候，不需要再使用 Class.forName("com.mysql.jdbc.Driver") 来加载驱动了，而是直接使用如下代码：

String url = "jdbc:xxxx://xxxx:xxxx/xxxx";
Connection conn = DriverManager.getConnection(url, username, password);
// .....

这里并没有涉及到 SPI 的使用，接着看下面的解析。

源码实现：上面的使用方法，就是我们普通的连接数据库的代码，并没有涉及到 SPI 的东西，但是有一点我们可以确定的是，我们没有写有关具体驱动的硬编码 Class.forName("com.mysql.jdbc.Driver")！

上面的代码可以直接获取数据库连接进行操作，但是跟 SPI 有啥关系呢？上面代码没有了加载驱动的代码，我们怎么去确定使用哪个数据库连接的驱动呢？这里就涉及到使用 Java 的 SPI 扩展机制来查找相关驱动的东西了。关于驱动的查找其实都在 DriverManager 中，DriverManager 是 Java 中的实现，用来获取数据库连接，在 DriverManager 中有一个静态代码块如下：

static {
    loadInitialDrivers();
    println("JDBC DriverManager initialized");
}

可以看到是加载实例化驱动的，接着看 loadInitialDrivers 方法：

private static void loadInitialDrivers() {
    String drivers;
    try {
        drivers = AccessController.doPrivileged(new PrivilegedAction<String>() {
            public String run() {
                return System.getProperty("jdbc.drivers");
            }
        });
    } catch (Exception ex) {
        drivers = null;
    }

    AccessController.doPrivileged(new PrivilegedAction<Void>() {
        public Void run() {
            // 使用SPI的ServiceLoader来加载接口的实现
            ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
            Iterator<Driver> driversIterator = loadedDrivers.iterator();
            try {
                while (driversIterator.hasNext()) {
                    driversIterator.next();
                }
            } catch (Throwable t) {
                // Do nothing
            }
            return null;
        }
    });

    println("DriverManager.initialize: jdbc.drivers = " + drivers);

    if (drivers == null || drivers.equals("")) {
        return;
    }
    String[] driversList = drivers.split(":");
    println("number of Drivers:" + driversList.length);
    for (String aDriver : driversList) {
        try {
            println("DriverManager.Initialize: loading " + aDriver);
            Class.forName(aDriver, true,
                    ClassLoader.getSystemClassLoader());
        } catch (Exception ex) {
            println("DriverManager.Initialize: load failed: " + ex);
        }
    }
}

上面的代码主要步骤是：

从系统变量中获取有关驱动的定义；
使用 SPI 来获取驱动的实现；
遍历使用 SPI 获取到的具体实现，实例化各个实现类；
根据第一步获取到的驱动列表来实例化具体实现类。

我们主要关注 2、3 步，这两步是 SPI 的用法。首先看第二步，使用 SPI 来获取驱动的实现，对应的代码是：

ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
// 获取迭代器
Iterator<Driver> driversIterator = loadedDrivers.iterator();
// 遍历所有的驱动实现
while (driversIterator.hasNext()) {
    driversIterator.next();
}

这里没有去 META-INF/services 目录下查找配置文件，也没有加载具体实现类，做的事情就是封装了我们的接口类型和类加载器，并初始化了一个迭代器。

接着看第三步，遍历使用 SPI 获取到的具体实现，实例化各个实现类：在遍历的时候，首先调用 driversIterator.hasNext() 方法，这里会搜索 classpath 下以及 jar 包中所有的 META-INF/services 目录下的 java.sql.Driver 文件，并找到文件中的实现类的名字，此时并没有实例化具体的实现类（ServiceLoader 具体的源码实现在下面）。然后是调用 driversIterator.next() 方法，此时就会根据驱动名字具体实例化各个实现类了。现在驱动就被找到并实例化了。

我在测试项目中添加了两个 jar 包：mysql-connector-java-6.0.6.jar 和 postgresql-42.0.0.0.jar，跟踪到 DriverManager 中之后，可以看到此时迭代器中有两个驱动，mysql 和 postgresql 的都被加载了。

SPI 机制 - Common-Logging

common-logging（也称 Jakarta Commons Logging，缩写 JCL）是常用的日志库门面。我们看下它是怎么解耦的。

首先，日志实例是通过 LogFactory 的 getLog(String) 方法创建的：

public static Log getLog(Class clazz) throws LogConfigurationException {
    return getFactory().getInstance(clazz);
}

LogFactory 是一个抽象类，它负责加载具体的日志实现，分析其 getFactory() 方法（较长，省略了部分仅用于诊断输出的代码）：

public static org.apache.commons.logging.LogFactory getFactory() throws LogConfigurationException {
    // Identify the class loader we will be using
    ClassLoader contextClassLoader = getContextClassLoaderInternal();

    // Return any previously registered factory for this class loader
    org.apache.commons.logging.LogFactory factory = getCachedFactory(contextClassLoader);
    if (factory != null) {
        return factory;
    }

    // Load properties file.
    // classpath根目录下寻找commons-logging.properties
    Properties props = getConfigurationFile(contextClassLoader, FACTORY_PROPERTIES);

    // classpath根目录下commons-logging.properties是否配置use_tccl
    ClassLoader baseClassLoader = contextClassLoader;
    if (props != null) {
        String useTCCLStr = props.getProperty(TCCL_KEY);
        if (useTCCLStr != null) {
            // The Boolean.valueOf(useTCCLStr).booleanValue() formulation
            // is required for Java 1.2 compatibility.
            if (Boolean.valueOf(useTCCLStr).booleanValue() == false) {
                baseClassLoader = thisClassLoader;
            }
        }
    }

    // 这里真正开始决定使用哪个factory
    // 首先，尝试查找vm系统属性org.apache.commons.logging.LogFactory，其是否指定factory
    try {
        String factoryClass = getSystemProperty(FACTORY_PROPERTY, null);
        if (factoryClass != null) {
            factory = newFactory(factoryClass, baseClassLoader, contextClassLoader);
        }
    } catch (SecurityException e) {
        // ignore
    } catch (RuntimeException e) {
        throw e;
    }

    // 第二，尝试使用java spi服务发现机制，在META-INF/services下寻找org.apache.commons.logging.LogFactory实现
    if (factory == null) {
        try {
            // META-INF/services/org.apache.commons.logging.LogFactory, SERVICE_ID
            final InputStream is = getResourceAsStream(contextClassLoader, SERVICE_ID);
            if (is != null) {
                // This code is needed by EBCDIC and other strange systems.
                // It's a fix for bugs reported in xerces
                BufferedReader rd;
                try {
                    rd = new BufferedReader(new InputStreamReader(is, "UTF-8"));
                } catch (java.io.UnsupportedEncodingException e) {
                    rd = new BufferedReader(new InputStreamReader(is));
                }
                String factoryClassName = rd.readLine();
                rd.close();
                if (factoryClassName != null && !"".equals(factoryClassName)) {
                    factory = newFactory(factoryClassName, baseClassLoader, contextClassLoader);
                }
            }
        } catch (Exception ex) {
            // note: if the specified LogFactory class wasn't compatible with LogFactory
            // for some reason, a ClassCastException will be caught here, and attempts will
            // continue to find a compatible class.
            // ignore
        }
    }

    // 第三，尝试从classpath根目录下的commons-logging.properties中查找org.apache.commons.logging.LogFactory属性指定的factory
    if (factory == null) {
        if (props != null) {
            String factoryClass = props.getProperty(FACTORY_PROPERTY);
            if (factoryClass != null) {
                // TODO: think about whether we need to handle exceptions from newFactory
                factory = newFactory(factoryClass, baseClassLoader, contextClassLoader);
            }
        }
    }

    // 最后，使用后备factory实现，org.apache.commons.logging.impl.LogFactoryImpl
    if (factory == null) {
        // Note: unlike the above code which can try to load custom LogFactory
        // implementations via the TCCL, we don't try to load the default LogFactory
        // implementation via the context classloader.
        factory = newFactory(FACTORY_DEFAULT, thisClassLoader, contextClassLoader);
    }

    if (factory != null) {
        /**
         * Always cache using context class loader.
         */
        cacheFactory(contextClassLoader, factory);
        if (props != null) {
            Enumeration names = props.propertyNames();
            while (names.hasMoreElements()) {
                String name = (String) names.nextElement();
                String value = props.getProperty(name);
                factory.setAttribute(name, value);
            }
        }
    }

    return factory;
}

可以看出，抽象类 LogFactory 加载具体实现的步骤如下：

从 vm 系统属性 org.apache.commons.logging.LogFactory 查找；
使用 SPI 服务发现机制，发现 org.apache.commons.logging.LogFactory 的实现；
查找 classpath 根目录 commons-logging.properties 的 org.apache.commons.logging.LogFactory 属性是否指定 factory 实现；
使用默认 factory 实现，org.apache.commons.logging.impl.LogFactoryImpl。

LogFactory 的 getLog() 方法返回类型是 org.apache.commons.logging.Log 接口，提供了从 trace 到 fatal 方法。可以确定，如果日志实现提供者只要实现该接口，并且使用继承自 org.apache.commons.logging.LogFactory 的子类创建 Log，必然可以构建一个松耦合的日志系统。

SPI 机制 - 插件体系

其实最具 SPI 思想的应该属于插件开发，我们项目中也用到这种思想，这里具体说一下 eclipse 的插件思想。

Eclipse 使用 OSGi 作为插件系统的基础，动态添加新插件和停止现有插件，以动态的方式管理组件生命周期。

一般来说，插件的文件结构必须在指定目录下包含以下三个文件：

META-INF/MANIFEST.MF：项目基本配置信息，版本、名称、启动器等；
build.properties：项目的编译配置信息，包括源代码路径、输出路径；
plugin.xml：插件的操作配置信息，包含弹出菜单及点击菜单后对应的操作执行类等。

当 eclipse 启动时，会遍历 plugins 文件夹中的目录，扫描每个插件的清单文件 MANIFEST.MF，并建立一个内部模型来记录它所找到的每个插件的信息，就实现了动态添加新的插件。

这也意味着是 eclipse 制定了一系列的规则，像是文件结构、类型、参数等。插件开发者遵循这些规则去开发自己的插件，eclipse 并不需要知道插件具体是怎样开发的，只需要在启动的时候根据配置文件解析、加载到系统里就好了，是 SPI 思想的一种体现。

SPI 机制 - Spring 中 SPI 机制

在 springboot 的自动装配过程中，最终会加载 META-INF/spring.factories 文件，而加载的过程是由 SpringFactoriesLoader 加载的：从 CLASSPATH 下的每个 Jar 包中搜寻所有 META-INF/spring.factories 配置文件，然后将解析 properties 文件，找到指定名称的配置后返回。需要注意的是，其实这里不仅仅是会去 ClassPath 路径下查找，会扫描所有路径下的 Jar 包，只不过这个文件只会在 Classpath 下的 jar 包中。

public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";

// spring.factories文件的格式为：key=value1,value2,value3
// 从所有的jar包中找到META-INF/spring.factories文件
// 然后从文件中解析出key=factoryClass类名称的所有value值
public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
    String factoryClassName = factoryClass.getName();
    // 取得资源文件的URL
    Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
    List<String> result = new ArrayList<String>();
    // 遍历所有的URL
    while (urls.hasMoreElements()) {
        URL url = urls.nextElement();
        // 根据资源文件URL解析properties文件，得到对应的一组@Configuration类
        Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
        String factoryClassNames = properties.getProperty(factoryClassName);
        // 组装数据，并返回
        result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
    }
    return result;
}

SPI 机制深入理解

接下来，我们深入理解下 SPI 相关内容。

SPI 机制通常怎么使用

看完上面的几个例子解析，应该都能知道大概的流程了：

有关组织或者公司定义标准；
具体厂商或者框架开发者实现；
程序猿使用。

定义标准：定义标准，就是定义接口。比如接口 java.sql.Driver。

具体厂商或者框架开发者实现：厂商或者框架开发者开发具体的实现：

在 META-INF/services 目录下定义一个名字为接口全限定名的文件，比如 java.sql.Driver 文件，文件内容是具体的实现名字，比如 me.cxis.sql.MyDriver；
写具体的实现 me.cxis.sql.MyDriver，都是对接口 Driver 的实现。

程序猿使用：我们会引用具体厂商的 jar 包来实现我们的功能：

ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
// 获取迭代器
Iterator<Driver> driversIterator = loadedDrivers.iterator();
// 遍历
while (driversIterator.hasNext()) {
    driversIterator.next();
    // 可以做具体的业务逻辑
}

使用规范：最后总结一下 JDK SPI 需要遵循的规范——即上面示例中的做法：接口实现方在 jar 包的 META-INF/services/ 目录下放置以”接口全限定名”命名的文件，内容为实现类的全限定名，调用方通过 ServiceLoader.load(接口.class) 获取所有实现。

SPI 和 API 的区别是什么

这里实际包含两个问题：第一个 SPI 和 API 的区别？第二个什么时候用 API，什么时候用 SPI？

	SPI	API
接口的位置	“接口”位于”调用方”所在的”包”中，实现位于独立的包中	“接口”位于”实现方”所在的”包”中，实现和接口在一个包中
概念上	更依赖调用方	更接近实现方
常见的例子	插件模式的插件	常规的类库接口

参考：

difference-between-spi-and-api（https://stackoverflow.com/questions/2954372/difference-between-spi-and-api）
设计原则：小议 SPI 和 API

SPI 机制实现原理

不妨看下 JDK 中 ServiceLoader<S> 的具体实现：

// ServiceLoader实现了Iterable接口，可以遍历所有的服务实现者
public final class ServiceLoader<S>
        implements Iterable<S> {

    // 查找配置文件的目录
    private static final String PREFIX = "META-INF/services/";

    // 表示要被加载的服务的类或接口
    private final Class<S> service;

    // 这个ClassLoader用来定位，加载，实例化服务提供者
    private final ClassLoader loader;

    // 访问控制上下文
    private final AccessControlContext acc;

    // 缓存已经被实例化的服务提供者，按照实例化的顺序存储
    private LinkedHashMap<String, S> providers = new LinkedHashMap<>();

    // 迭代器
    private LazyIterator lookupIterator;

    // 重新加载，就相当于重新创建ServiceLoader了，用于新的服务提供者安装到正在运行的Java虚拟机中的情况。
    public void reload() {
        // 清空缓存中所有已实例化的服务提供者
        providers.clear();
        // 新建一个迭代器，该迭代器会从头查找和实例化服务提供者
        lookupIterator = new LazyIterator(service, loader);
    }

    // 私有构造器
    // 使用指定的类加载器和服务创建服务加载器
    // 如果没有指定类加载器，使用系统类加载器，就是应用类加载器。
    private ServiceLoader(Class<S> svc, ClassLoader cl) {
        service = Objects.requireNonNull(svc, "Service interface cannot be null");
        loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
        acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
        reload();
    }

    // 解析失败处理的方法
    private static void fail(Class<?> service, String msg, Throwable cause)
            throws ServiceConfigurationError {
        throw new ServiceConfigurationError(service.getName() + ": " + msg,
                cause);
    }

    private static void fail(Class<?> service, String msg)
            throws ServiceConfigurationError {
        throw new ServiceConfigurationError(service.getName() + ": " + msg);
    }

    private static void fail(Class<?> service, URL u, int line, String msg)
            throws ServiceConfigurationError {
        fail(service, u + ":" + line + ": " + msg);
    }

    // 解析服务提供者配置文件中的一行
    // 首先去掉注释校验，然后保存
    // 返回下一行行号
    // 重复的配置项和已经被实例化的配置项不会被保存
    private int parseLine(Class<?> service, URL u, BufferedReader r, int lc,
                          List<String> names)
            throws IOException, ServiceConfigurationError {
        // 读取一行
        String ln = r.readLine();
        if (ln == null) {
            return -1;
        }
        // #号代表注释行
        int ci = ln.indexOf('#');
        if (ci >= 0) ln = ln.substring(0, ci);
        ln = ln.trim();
        int n = ln.length();
        if (n != 0) {
            if ((ln.indexOf(' ') >= 0) || (ln.indexOf('\t') >= 0))
                fail(service, u, lc, "Illegal configuration-file syntax");
            int cp = ln.codePointAt(0);
            if (!Character.isJavaIdentifierStart(cp))
                fail(service, u, lc, "Illegal provider-class name: " + ln);
            for (int i = Character.charCount(cp); i < n; i += Character.charCount(cp)) {
                cp = ln.codePointAt(i);
                if (!Character.isJavaIdentifierPart(cp) && (cp != '.'))
                    fail(service, u, lc, "Illegal provider-class name: " + ln);
            }
            if (!providers.containsKey(ln) && !names.contains(ln))
                names.add(ln);
        }
        return lc + 1;
    }

    // 解析配置文件，解析指定的url配置文件
    // 使用parseLine方法进行解析，未被实例化的服务提供者会被保存到缓存中去
    private Iterator<String> parse(Class<?> service, URL u)
            throws ServiceConfigurationError {
        InputStream in = null;
        BufferedReader r = null;
        ArrayList<String> names = new ArrayList<>();
        try {
            in = u.openStream();
            r = new BufferedReader(new InputStreamReader(in, "utf-8"));
            int lc = 1;
            while ((lc = parseLine(service, u, r, lc, names)) >= 0) ;
        } catch (IOException x) {
            fail(service, "Error reading configuration file", x);
        } finally {
            try {
                if (r != null) r.close();
                if (in != null) in.close();
            } catch (IOException y) {
                fail(service, "Error closing configuration file", y);
            }
        }
        return names.iterator();
    }

    // 服务提供者查找的迭代器
    private class LazyIterator
            implements Iterator<S> {
        Class<S> service;      // 服务提供者接口
        ClassLoader loader;    // 类加载器
        Enumeration<URL> configs = null;  // 保存实现类的url
        Iterator<String> pending = null;  // 保存实现类的全名
        String nextName = null;            // 迭代器中下一个实现类的全名

        private LazyIterator(Class<S> service, ClassLoader loader) {
            this.service = service;
            this.loader = loader;
        }

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

        private S nextService() {
            if (!hasNextService())
                throw new NoSuchElementException();
            String cn = nextName;
            nextName = null;
            Class<?> c = null;
            try {
                c = Class.forName(cn, false, loader);
            } catch (ClassNotFoundException x) {
                fail(service, "Provider " + cn + " not found");
            }
            if (!service.isAssignableFrom(c)) {
                fail(service, "Provider " + cn + " not a subtype");
            }
            try {
                S p = service.cast(c.newInstance());
                providers.put(cn, p);
                return p;
            } catch (Throwable x) {
                fail(service, "Provider " + cn + " could not be instantiated", x);
            }
            throw new Error();        // Not reached
        }

        public boolean hasNext() {
            if (acc == null) {
                return hasNextService();
            } else {
                PrivilegedAction<Boolean> action = new PrivilegedAction<Boolean>() {
                    public Boolean run() {
                        return hasNextService();
                    }
                };
                return AccessController.doPrivileged(action, acc);
            }
        }

        public S next() {
            if (acc == null) {
                return nextService();
            } else {
                PrivilegedAction<S> action = new PrivilegedAction<S>() {
                    public S run() {
                        return nextService();
                    }
                };
                return AccessController.doPrivileged(action, acc);
            }
        }

        public void remove() {
            throw new UnsupportedOperationException();
        }
    }

    // 获取迭代器
    // 返回遍历服务提供者的迭代器
    // 以懒加载的方式加载可用的服务提供者
    // 懒加载的实现是：解析配置文件和实例化服务提供者的工作由迭代器本身完成
    public Iterator<S> iterator() {
        return new Iterator<S>() {
            // 按照实例化顺序返回已经缓存的服务提供者实例
            Iterator<Map.Entry<String, S>> knownProviders
                    = providers.entrySet().iterator();

            public boolean hasNext() {
                if (knownProviders.hasNext())
                    return true;
                return lookupIterator.hasNext();
            }

            public S next() {
                if (knownProviders.hasNext())
                    return knownProviders.next().getValue();
                return lookupIterator.next();
            }

            public void remove() {
                throw new UnsupportedOperationException();
            }
        };
    }

    // 为指定的服务使用指定的类加载器来创建一个ServiceLoader
    public static <S> ServiceLoader<S> load(Class<S> service,
                                            ClassLoader loader) {
        return new ServiceLoader<>(service, loader);
    }

    // 使用线程上下文的类加载器来创建ServiceLoader
    public static <S> ServiceLoader<S> load(Class<S> service) {
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        return ServiceLoader.load(service, cl);
    }

    // 使用扩展类加载器为指定的服务创建ServiceLoader
    // 只能找到并加载已经安装到当前Java虚拟机中的服务提供者，应用程序类路径中的服务提供者将被忽略
    public static <S> ServiceLoader<S> loadInstalled(Class<S> service) {
        ClassLoader cl = ClassLoader.getSystemClassLoader();
        ClassLoader prev = null;
        while (cl != null) {
            prev = cl;
            cl = cl.getParent();
        }
        return ServiceLoader.load(service, prev);
    }

    public String toString() {
        return "java.util.ServiceLoader[" + service.getName() + "]";
    }
}

用一张时序图概括 ServiceLoader 懒加载的过程：

sequenceDiagram
    participant App as 调用方程序
    participant SL as ServiceLoader
    participant LI as LazyIterator
    participant JVM as ClassLoader/JVM

    App->>SL: ServiceLoader.load 接口.class
    SL->>SL: 仅记录接口类型和类加载器，初始化LazyIterator
    loop 遍历
        App->>SL: iterator.hasNext()
        SL->>LI: hasNextService()
        LI->>JVM: getResources META-INF/services/接口全限定名
        JVM-->>LI: 返回配置文件URL
        LI->>LI: parse 解析实现类名，此时并未实例化
        App->>SL: iterator.next()
        SL->>LI: nextService()
        LI->>JVM: Class.forName + newInstance
        LI->>LI: 实例缓存到 providers
        SL-->>App: 返回实现实例
    end

首先，ServiceLoader 实现了 Iterable 接口，所以它有迭代器的属性，这里主要都是实现了迭代器的 hasNext 和 next 方法，这里主要都是调用的 lookupIterator 的相应 hasNext 和 next 方法，lookupIterator 是懒加载迭代器。

其次，LazyIterator 中的 hasNext 方法，静态变量 PREFIX 就是 “META-INF/services/” 目录，这也就是为什么需要在 classpath 下的 META-INF/services/ 目录里创建一个以服务接口命名的文件。

最后，通过反射方法 Class.forName() 加载类对象，并用 newInstance 方法将类实例化，并把实例化后的类缓存到 providers 对象中（LinkedHashMap<String, S> 类型）然后返回实例对象。

所以我们可以看到 ServiceLoader 不是实例化以后，就去读取配置文件中的具体实现，并进行实例化。而是等到使用迭代器去遍历的时候，才会加载对应的配置文件去解析：调用 hasNext 方法的时候会去加载配置文件进行解析，调用 next 方法的时候进行实例化并缓存。

所有的配置文件只会加载一次，服务提供者也只会被实例化一次，重新加载配置文件可使用 reload 方法。

SPI 机制的缺陷

通过上面的解析，可以发现，我们使用 SPI 机制的缺陷：

不能按需加载，需要遍历所有的实现，并实例化，然后在循环中才能找到我们需要的实现。如果不想用某些实现类，或者某些类实例化很耗时，它也被载入并实例化了，这就造成了浪费；
获取某个实现类的方式不够灵活，只能通过 Iterator 形式获取，不能根据某个参数来获取对应的实现类；
多个并发多线程使用 ServiceLoader 类的实例是不安全的。

CHARLIE SAYS