本文首發於 vivo網際網路技術微信公眾號
連結： https://mp.weixin.qq.com/s/vpy5DJ-hhn0iOyp747oL5A
作者：姜柱

一、簡介

SPI（Service Provider Interface），是JDK內建的一種 服務提供發現機制，可以用來啟用框架擴充套件和替換元件，主要是被框架的開發人員使用，比如java.sql.Driver介面，其他不同廠商可以針對同一介面做出不同的實現，MySQL和PostgreSQL都有不同的實現提供給使用者，而Java的SPI機制可以為某個介面尋zhao服務實現。Java中SPI機制主要思想是將裝配的控制權移到程式之外，在模組化設計中這個機制尤其重要，其核心思想就是解耦。

SPI與API區別：

API是呼叫並用於實現目標的類、介面、方法等的描述；
SPI是擴充套件和實現以實現目標的類、介面、方法等的描述；

換句話說，API 為操作提供特定的類、方法，SPI 透過操作來符合特定的類、方法。

參考：

SPI整體機制圖如下：

當服務的提供者提供了一種介面的實現之後，需要在classpath下的META-INF/services/目錄裡建立一個以服務介面命名的檔案，這個檔案裡的內容就是這個介面的具體的實現類。當其他的程式需要這個服務的時候，就可以透過查詢這個jar包（一般都是以jar包做依賴）的META-INF/services/中的配置檔案，配置檔案中有介面的具體實現類名，可以根據這個類名進行載入例項化，就可以使用該服務了。JDK中查zhao服務的實現的工具類是：java.util.ServiceLoader。

二、應用場景

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.定義一個介面HelloSPI。

package com.vivo.study.spidemo.spi;public interface HelloSPI {
    void sayHello();
}

2.完成介面的多個實現。

package com.vivo.study.spidemo.spi.impl;import com.vivo.study.spidemo.spi.HelloSPI;public class ImageHello implements HelloSPI {
    public void sayHello() {
        System.out.println("Image Hello");
    }
}

package com.vivo.study.spidemo.spi.impl;import com.vivo.study.spidemo.spi.HelloSPI;public class TextHello implements HelloSPI {
    public void sayHello() {
        System.out.println("Text Hello");
    }
}

在META-INF/services/目錄裡建立一個以com.vivo.study.spidemo.spi.HelloSPI的檔案，這個檔案裡的內容就是這個介面的具體的實現類。

具體內容如下：

com.vivo.study.spidemo.spi.impl.ImageHello
com.vivo.study.spidemo.spi.impl.TextHello

3.使用 ServiceLoader 來載入配置檔案中指定的實現

package com.vivo.study.spidemo.testimport java.util.ServiceLoader;import com.vivo.study.spidemo.spi.HelloSPI;public class SPIDemo {
    public static void main(String[] args) {
        ServiceLoader<HelloSPI> serviceLoader = ServiceLoader.load(HelloSPI.class);        // 執行不同廠商的業務實現，具體根據業務需求配置
        for (HelloSPI helloSPI : serviceLoader) {
            helloSPI.sayHello();
        }
    }
}

輸出結果如下：

Image Hello
Text Hello

四、原始碼分析

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

// 服務提供者查詢的迭代器public Iterator<S> iterator() {    return new Iterator<S>() {
        Iterator<Map.Entry<String,S>> knownProviders
            = providers.entrySet().iterator();        // hasNext方法
        public boolean hasNext() {            if (knownProviders.hasNext())                return true;            return lookupIterator.hasNext();
        }        // next方法
        public S next() {            if (knownProviders.hasNext())                return knownProviders.next().getValue();            return lookupIterator.next();
        }
    };
}

// 服務提供者查詢的迭代器
private class LazyIterator implements Iterator<S> {
    // 服務提供者介面
    Class<S> service;
    // 類載入器
    ClassLoader loader;
    // 儲存實現類的url
    Enumeration<URL> configs = null;
    // 儲存實現類的全名
    Iterator<String> pending = null;
    // 迭代器中下一個實現類的全名
    String nextName = null;
 
    public boolean hasNext() {
        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;
    }
 
    public S next() {
        if (!hasNext()) {
            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, x);
        }
        throw new Error();          // This cannot happen
    }
}

首先，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>型別）然後返回例項物件。

五、不足

1.不能按需載入，需要遍歷所有的實現，並例項化，然後在迴圈中才能找到我們需要的實現。如果不想用某些實現類，或者某些類例項化很耗時，它也被載入並例項化了，這就造成了浪費。

2.獲取某個實現類的方式不夠靈活，只能透過 Iterator 形式獲取，不能根據某個引數來獲取對應的實現類。

3.多個併發多執行緒使用 ServiceLoader 類的例項是不安全的。

六、規避

針對以上的不足點，我們在SPI機制選擇時，可以考慮使用dubbo實現的SPI機制。

具體參考: http://dubbo.apache.org/zh-cn/blog/introduction-to-dubbo-spi.html

深入理解 Java 中 SPI 機制