概述

SPI全稱Service Provider Interface，是Java提供的一套用來被第三方實現或者擴充套件的API，它可以用來啟用框架擴充套件和替換元件。

整體機制圖如下：

Java SPI 實際上是“基於介面的程式設計＋策略模式＋配置檔案”組合實現的動態載入機制。

系統設計的各個抽象，往往有很多不同的實現方案，在面向的物件的設計裡，一般推薦模組之間基於介面程式設計，模組之間不對實現類進行硬編碼。一旦程式碼裡涉及具體的實現類，就違反了可拔插的原則，如果需要替換一種實現，就需要修改程式碼。為了實現在模組裝配的時候能不在程式裡動態指明，這就需要一種服務發現機制。
Java SPI就是提供這樣的一個機制：為某個介面尋找服務實現的機制。就是將裝配的控制權移到程式之外，在模組化設計中這個機制尤其重要。所以SPI的核心思想就是解耦。 適用於：呼叫者根據實際使用需要，啟用、擴充套件、或者替換框架的實現策略

常見的例子：

• 資料庫驅動載入介面實現類的載入
  JDBC載入不同型別資料庫的驅動
• 日誌門面介面實現類載入
  SLF4J載入不同提供商的日誌實現類
• Spring
  Spring中大量使用了SPI,比如：對servlet3.0規範對ServletContainerInitializer的實現、自動型別轉換Type Conversion SPI(Converter SPI、Formatter SPI)等
• Dubbo
  Dubbo中也大量使用SPI的方式實現框架的擴充套件, 不過它對Java提供的原生SPI做了封裝，允許使用者擴充套件實現Filter介面

要使用Java SPI，需要遵循如下約定：

• 1、當服務提供者提供了介面的一種具體實現後，在jar包的META-INF/services目錄下建立一個以“介面全限定名”為命名的檔案，內容為實現類的全限定名；
• 2、介面實現類所在的jar包放在主程式的classpath中；
• 3、主程式通過java.util.ServiceLoder動態裝載實現模組，它通過掃描META-INF/services目錄下的配置檔案找到實現類的全限定名，把類載入到JVM；
• 4、SPI的實現類必須攜帶一個不帶引數的構造方法；

示例程式碼

步驟1、定義一組介面 (假設是org.foo.demo.IShout)，並寫出介面的一個或多個實現，(假設是org.foo.demo.animal.Dog、org.foo.demo.animal.Cat)。

public
 
 interface IShout {
    void shout();
}
public class Cat implements IShout {
    @Override
    public void shout() {
        System.out.println("miao miao");
    }
}
public class Dog implements IShout {
    @Override
    public void shout() {
        System.out.println("wang wang");
    }
}

步驟2、在 src/main/resources/ 下建立 /META-INF/services 目錄， 新增一個以介面命名的檔案 (org.foo.demo.IShout檔案)，內容是要應用的實現類（這裡是org.foo.demo.animal.Dog和org.foo.demo.animal.Cat，每行一個類）。 檔案位置

- src
    -main
        -resources
            - META-INF
                - services
                    - org.foo.demo.IShout

檔案內容

org.foo.demo.animal.Dog
org.foo.demo.animal.Cat

步驟3、使用 ServiceLoader 來載入配置檔案中指定的實現。

public class SPIMain {
    public static void main(String[] args) {
        ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
        for (IShout s : shouts) {
            s.shout();
        }
    }
}

程式碼輸出：

wang wang
miao miao

原理解析

先看ServiceLoader類的簽名類的成員變數：

public final class ServiceLoader<S> implements Iterable<S>{
private static final String PREFIX = "META-INF/services/";

    // 代表被載入的類或者介面
    private final Class<S> service;

    // 用於定位，載入和例項化providers的類載入器
    private final ClassLoader loader;

    // 建立ServiceLoader時採用的訪問控制上下文
    private final AccessControlContext acc;

    // 快取providers，按例項化的順序排列
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

    // 懶查詢迭代器
    private LazyIterator lookupIterator;
  
    ......
}

參考ServiceLoader具體原始碼，實現的流程如下：

• 1 應用程式呼叫ServiceLoader.load方法
  ServiceLoader.load方法內先建立一個新的ServiceLoader，並例項化該類中的成員變數，包括：

  • loader(ClassLoader型別，類載入器)
  • acc(AccessControlContext型別，訪問控制器)
  • providers(LinkedHashMap<String,S>型別，用於快取載入成功的類)
  • lookupIterator(實現迭代器功能)

• 2 應用程式通過迭代器介面獲取物件例項
  ServiceLoader先判斷成員變數providers物件中(LinkedHashMap<String,S>型別)是否有快取例項物件，如果有快取，直接返回。
  如果沒有快取，執行類的裝載，實現如下：

• (1) 讀取META-INF/services/下的配置檔案，獲得所有能被例項化的類的名稱，值得注意的是，ServiceLoader可以跨越jar包獲取META-INF下的配置檔案，具體載入配置的實現程式碼如下：

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

• (2) 通過反射方法Class.forName()載入類物件，並用instance()方法將類例項化。
• (3) 把例項化後的類快取到providers物件中，(LinkedHashMap<String,S>型別）
  然後返回例項物件。

總結

優點：
使用Java SPI機制的優勢是實現解耦，使得第三方服務模組的裝配控制的邏輯與呼叫者的業務程式碼分離，而不是耦合在一起。應用程式可以根據實際業務情況啟用框架擴充套件或替換框架元件。

相比使用提供介面jar包，供第三方服務模組實現介面的方式，SPI的方式使得源框架，不必關心介面的實現類的路徑，可以不用通過下面的方式獲取介面實現類：

• 程式碼硬編碼import 匯入實現類
• 指定類全路徑反射獲取：例如在JDBC4.0之前，JDBC中獲取資料庫驅動類需要通過Class.forName("com.mysql.jdbc.Driver")，類似語句先動態載入資料庫相關的驅動，然後再進行獲取連線等的操作
• 第三方服務模組把介面實現類例項註冊到指定地方，源框架從該處訪問例項

通過SPI的方式，第三方服務模組實現介面後，在第三方的專案程式碼的META-INF/services目錄下的配置檔案指定實現類的全路徑名，原始碼框架即可找到實現類

缺點：

• 雖然ServiceLoader也算是使用的延遲載入，但是基本只能通過遍歷全部獲取，也就是介面的實現類全部載入並例項化一遍。如果你並不想用某些實現類，它也被載入並例項化了，這就造成了浪費。獲取某個實現類的方式不夠靈活，只能通過Iterator形式獲取，不能根據某個引數來獲取對應的實現類。
• 多個併發多執行緒使用ServiceLoader類的例項是不安全的。

其實在這裡就可以發現，只要是能滿足使用者按照系統規則來自定義，並且可以註冊到系統中的功能點，都帶有著spi的思想。 參考： https://www.jianshu.com/p/46b42f7f593c https://zhuanlan.zhihu.com/p/28909673