Java：深入理解ServiceLoader类与SPI机制

一、SPI接口介绍

SPI（Service Provider Interface），是JDK内置的一种 服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用，比如java.sql.Driver接口，其他不同厂商可以针对同一接口做出不同的实现，MySQL和PostgreSQL都有不同的实现提供给用户，而Java的SPI机制可以为某个接口寻zhao服务实现。Java中SPI机制主要思想是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要，其核心思想就是 解耦。

JDK自带有ServiceLoader来实现这种机制，当然更为出名的是Spring的SpringFactoriesLoader
（Dubbo也有自己的SPI实现），具体实现方式上都大同小异。
另外，这里所指的Interface并不强要求必须是接口，比如本文里使用均为抽象类，也是一样的可以正常使用。

1.1 SPI与API区别

• API是类、接口、方法…的描述 ，用于调用并使用它实现一个目标。
• SPI可用于扩展和实现一个类、接口或者方法…的描述
  换句话说，API 为操作提供特定的类、方法，SPI 通过操作来扩展特定的类、方法。
  参考： https://stackoverflow.com/questions/2954372/difference-between-spi-and-api?answertab=votes#tab-top
  
  当服务的提供者提供了一种接口的实现之后，需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件，这个文件里的内容就是这个接口的具体的实现类。当其他的程序需要这个服务的时候，就可以通过查找这个jar包（一般都是以jar包做依赖）的META-INF/services/中的配置文件，配置文件中有接口的具体实现类名，可以根据这个类名进行加载实例化，就可以使用该服务了。JDK中查找服务的实现的工具类是：java.util.ServiceLoader。

1.2 应用场景

SPI扩展机制应用场景有很多，比如Common-Logging，JDBC，Dubbo等等。
SPI流程：

• 有关组织和公式定义接口标准
• 第三方提供具体实现: 实现具体方法, 配置 META-INF/services/${interface_name} 文件
• 开发者使用

比如JDBC场景下：

• 首先在Java中定义了接口java.sql.Driver，并没有具体的实现，具体的实现都是由不同厂商提供。
• 在MySQL的jar包mysql-connector-java-6.0.6.jar中，可以找到META-INF/services目录，该目录下会有一个名字为java.sql.Driver的文件，文件内容是com.mysql.cj.jdbc.Driver，这里面的内容就是针对Java中定义的接口的实现。
• 同样在PostgreSQL的jar包PostgreSQL-42.0.0.jar中，也可以找到同样的配置文件，文件内容是org.postgresql.Driver，这是PostgreSQL对Java的java.sql.Driver的实现。

二、Demo展示

1.定义一个抽象类

package com.googleasy.spi.service;
public abstract class AbstractService {
   
   

    public abstract void printMsg();
}

2.完成多个实现

public class TempAServiceImpl extends AbstractService {
   
   
    private final static Logger logger = LoggerFactory.getLogger(TempAServiceImpl.class);

    @Override
    public void printMsg() {
   
   
        logger.info("this temp A");
    }
}

//--------------------------------------------------------------
public class TempBServiceImpl extends AbstractService {
   
   
    private final static Logger logger = LoggerFactory.getLogger(TempBServiceImpl.class);

    @Override
    public void printMsg() {
   
   
        logger.info("this temp b");
    }
}

在resources/META-INF/services/目录里创建一个以com.googleasy.spi.service.AbstractService命名的文件，这个文件里的内容就是这个接口的具体的实现类地址，参考如下：

3.使用 ServiceLoader 来加载配置文件中指定的实现

   @Override
    public void run(String... args) throws Exception {
   
   
        ServiceLoader<AbstractService> loaders = ServiceLoader.load(AbstractService.class);
        for (AbstractService loader : loaders) {
   
   
            loader.printMsg();
        }
    }

执行输出结果如下：

2020-05-13 13:26:47.421  INFO 16762 --- [           main] c.g.spi.service.impl.TempAServiceImpl    : this temp A
2020-05-13 13:26:47.421  INFO 16762 --- [           main] c.g.spi.service.impl.TempBServiceImpl    : this temp b

三、源码分析

ServiceLoader主要的功能是用来完成对SPI的provider的加载。
先看下它的成员：

public final class ServiceLoader<S>
     implements Iterable<S> {
   
   
    private static final String PREFIX = "META-INF/services/";
    // The class or interface representing the service being loaded
    private final Class<S> service;
    // The class loader used to locate, load, and instantiate providers
    private final ClassLoader loader;
    // The access control context taken when the ServiceLoader is created
    private final AccessControlContext acc;
    // Cached providers, in instantiation order
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
    // The current lazy-lookup iterator
    private LazyIterator lookupIterator;
    ......
}

可以看到他首先是实现了Iterable接口，可以迭代。

• PREFIX：指明了路径是在"META-INF/services/"下。
• service：表示正在加载的服务的类或接口。
• loader：使用的类加载器。
• acc：创建ServiceLoader时获取的访问控制上下文。
• providers：缓存的服务提供集合。
• lookupIterator：是其内部使用的迭代器，用于类的懒加载，只有在迭代时加载。

其构造方法是一个private方法，不对外提供，在使用时我们需要调用其静态的load方法，由其自身产生ServiceLoader对象：

public static <S> ServiceLoader<S> load(Class<S> service) {
   
   
    ClassLoader cl = Thread.currentThread().getContextClassLoader();
    return ServiceLoader.load(service, cl);
}
public static