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
        }