Java：SPI机制

一、SPI是什么？

SPI全称为Service Provider Interface，是一种服务发现机制。SPI的本质是将接口的全限定类名配置在文件中，并由服务加载器 ServiceLoader 读取配置文件，加载实现类。这样可以再运行的时候，动态的替换接口的实现类。我们可以通过SPI的这种机制为我们的程序提供拓展功能。常见的SPI包括JDBC、日志门面接口、Spring、SpringBook相关的starter组件、Dubbo、JNDI等

 

二、关于SPI的一些概念

服务是一组公共的接口和类（通常是抽象类），提供对某些特定应用程序功能或特性。

服务服务提供者接口，服务定义的一组公共接口和抽象类。SPI 定义了可用于您的应用程序的类和方法。

服务提供者是服务的特定实现，比如说一个APP上需要支付，日常生活中常见的支付方式有支付宝支付和微信支付，这两种支付方式都是支付的服务提供者。

多个相同的服务，为同一个相同的服务提供多个程序，系统可以任意选择其中一个服务提供者，用户可以选择已安装的程序的一个。

 

服务提供者以特殊格式的 JAR 文件提供他们的新服务，通过位于资源目​​录 META-INF/services 中的提供文件标志服务提供者，配置文件的名称是服务提供者的全限定类名，其中名称的每个组成部分用句点 （.) 分隔。该文件必须采用 UTF-8 编码。此外，还可以通过以数字符号 (#)开头的注释行来在文件中包含注释。然后服务接口的实现类的jar包要放在主程序的Classpath下，这样服务启动时，主程序就会用ServiceLoader动态加载实现模块，扫描所有jar包中的约定好的类名，调用Class.forname加载。

 

三、原理分析

服务加载器 ServiceLoader 的源码的成员变量。

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;

    // 创建 ServiceLoader 时获取的访问控制上下文
    private final AccessControlContext acc;

    // 缓存提供程序，按实例化顺序
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

    // 当前的懒加载查找迭代器
    private LazyIterator lookupIterator;
    ... ... 
}

ServiceLoader的私有构造方法，服务的接口，类加载器。

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

ServiceLoader的 load 方法，使用了单例模式？

    public static <S> ServiceLoader<S> load(Class<S> service,
                                            ClassLoader loader)
    {
        return new ServiceLoader<>(service, loader);
    }

 reload 方法，清除次加载程序的所有缓存，重新加载所有的提供程序，并且实例了一个懒加载查找迭代器，等到主程序需要加载提供者程序时，才会使用类加载器去查找所有jar包的服务提供者的class，实例化服服务提供程序并缓存起来。

    public void reload() {
        providers.clear();
        lookupIterator = new LazyIterator(service, loader);
    }

ServiceLoader的私有内部类，用来懒加载服务提供者程序。

    private class LazyIterator
        implements Iterator<S>
    {

        Class<S> service;
        ClassLoader loader;
        Enumeration<URL> configs = null;
        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();          // This cannot happen
        }

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

    }

ServiceLoader首先会去确认是否有缓存有实例对象，有则直接从缓存中返回。没有则会执行懒加载的方法，从使用反射方法，从ClassLoader加载并实例化服务提供者，并放入缓存。

    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可以跨jar包获取META-INF/services目录中的文件，读取文件得到所有可以实例化的类的名称。

使用反射方法，Class.forName()用于加载类对象，instance()用于实例化类。最后放入缓存providers中，返回实例的服务提供者对象。

    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();          // This cannot happen
        }