SPI与ServiceLoader

ServiceLoader与ClassLoader是Java中2个即相互区别又相互联系的加载器.JVM利用ClassLoader将类载入内存，而ServiceLoader是一个简单的服务提供者加载器，服务的对象是接口和类（通常为抽象类）集合，其也是SPI的灵魂，SPI英文为Service Provider Interface单从字面可以理解为Service提供者接口，正如从SPI的名字去理解SPI就是Service提供者接口，是提供给服务提供厂商与扩展框架功能的开发者使用的接口。

SPI机制的约定

1. 在META-INF/services/目录中创建以接口全限定名命名的文件该文件内容为Api具体实现类的全限定名
2. 使用ServiceLoader类动态加载META-INF中的实现类
3. 如SPI的实现类为Jar则需要放在主程序classPath中
4. Api具体实现类必须有一个不带参数的构造方法

package SPI;

public interface JDBCService {
    String jdbcConnection(String connection);
}

public class MySqlServiceImpl implements JDBCService {
    @Override
    public String jdbcConnection(String connection) {
        return "mysql connected... " + connection;
    }
}

public class Oracle8ServiceImpl implements JDBCService {
    @Override
    public String jdbcConnection(String connection) {
        return "Oracle8 connected....  " + connection;
    }
}

public class SPIDemo {

    public static void main(String[] args) {
        ServiceLoader<JDBCService> serviceLoader = ServiceLoader.load(JDBCService.class);
        for(JDBCService service : serviceLoader)  {
            String connection = service.jdbcConnection("successed");

            System.out.println("class : " + service.getClass().getName() + "---" + connection);
        }

    }
}

在META-INF/services/目录中创建以接口全限定名命名的文件该文件内容为Api具体实现类的全限定名

SPI.JDBCService文件中的内容

SPI.MySqlServiceImpl
SPI.Oracle8ServiceImpl

SPI的灵魂ServiceLoader

主要方法load(Class service)

静态方法load(Class clazz)不会立刻加载服务提供者类，它仅仅只是获取当前线程上下文类加载器cl，而Reflection.getCallerClass()可以得到调用者的类，然后用clazz和cl构造一个ServiceLoader实例 loader。

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

构造过程中会先清理掉缓存，初始化相关参数。

• service : 表示正在加载的服务的类或接口
• serviceName : 服务类型
• layer : 类加载器的提供者，初始化时为null
• loader : 用于查找，加载和实例化提供程序的类加载器。
• acc : 创建ServiceLoader时采取的访问控制上下文

当在迭代或者stream流时，会构建一个LookupIterator延迟加载迭代器，期间会初始化两个局部变量ModuleServicesLookupIterator和LazyClassPathLookupIterator，然后用lookupIterator 读取META-INF/services/下以服务接口全限定名命名的配置文件，从中读取提供者全限定名交给线程上下文类加载器进行加载，最后在lookupIterator中实例化。

private final class LazyClassPathLookupIterator<T>
        implements Iterator<Provider<T>>
    {
        static final String PREFIX = "META-INF/services/"; // 这就是文件夹必须是META-INF/services/的由来

        Set<String> providerNames = new HashSet<>();  // 避免服务提供者重复
        Enumeration<URL> configs;
        Iterator<String> pending;

        Provider<T> nextProvider;
        ServiceConfigurationError nextError;

        LazyClassPathLookupIterator() { }
        // 解析给定配置文件中的一行，将该行上的名称添加到 pending 中。
        private int parseLine(URL u, BufferedReader r, int lc, Set<String> names)
            throws IOException
        {...}

        private Iterator<String> parse(URL u) {...} // 将给定URL的内容解析为提供程序配置文件。

        private Class<?> nextProviderClass() {...}  // 加载并返回服务提供者

        @SuppressWarnings("unchecked")
        private boolean hasNextService() {...}

        private Provider<T> nextService() {...}

        @Override
        public boolean hasNext() {...}

        @Override
        public Provider<T> next() {...}
    }