概述
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的實現類必須攜帶一個不帶參數的構造方法；
示例代碼
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"); } }
- 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類的實例是不安全的。