本文通過探析JDK提供的，在開源項目中比較常用的Java SPI機制，希望給大家在實際開發(fā)實踐、學(xué)習(xí)開源項目提供參考。

1 SPI是什么

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

整體機制圖如下：

Java SPI 實際上是“基于接口的編程＋策略模式＋配置文件”組合實現(xiàn)的動態(tài)加載機制。

系統(tǒng)設(shè)計的各個抽象，往往有很多不同的實現(xiàn)方案，在面向的對象的設(shè)計里，一般推薦模塊之間基于接口編程，模塊之間不對實現(xiàn)類進行硬編碼。一旦代碼里涉及具體的實現(xiàn)類，就違反了可拔插的原則，如果需要替換一種實現(xiàn)，就需要修改代碼。為了實現(xiàn)在模塊裝配的時候能不在程序里動態(tài)指明，這就需要一種服務(wù)發(fā)現(xiàn)機制。
Java SPI就是提供這樣的一個機制：為某個接口尋找服務(wù)實現(xiàn)的機制。有點類似IOC的思想，就是將裝配的控制權(quán)移到程序之外，在模塊化設(shè)計中這個機制尤其重要。所以SPI的核心思想就是解耦。

2 使用場景

概括地說，適用于：調(diào)用者根據(jù)實際使用需要，啟用、擴展、或者替換框架的實現(xiàn)策略

比較常見的例子：

• 數(shù)據(jù)庫驅(qū)動加載接口實現(xiàn)類的加載

JDBC加載不同類型數(shù)據(jù)庫的驅(qū)動

• 日志門面接口實現(xiàn)類加載
  

SLF4J加載不同提供商的日志實現(xiàn)類

• Spring
  

Spring中大量使用了SPI,比如：對servlet3.0規(guī)范對ServletContainerInitializer的實現(xiàn)、自動類型轉(zhuǎn)換Type Conversion SPI(Converter SPI、Formatter SPI)等

• Dubbo
  

Dubbo中也大量使用SPI的方式實現(xiàn)框架的擴展, 不過它對Java提供的原生SPI做了封裝，允許用戶擴展實現(xiàn)Filter接口

3 使用介紹

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

1、當(dāng)服務(wù)提供者提供了接口的一種具體實現(xiàn)后，在jar包的META-INF/services目錄下創(chuàng)建一個以“接口全限定名”為命名的文件，內(nèi)容為實現(xiàn)類的全限定名；
2、接口實現(xiàn)類所在的jar包放在主程序的classpath中；
3、主程序通過java.util.ServiceLoder動態(tài)裝載實現(xiàn)模塊，它通過掃描META-INF/services目錄下的配置文件找到實現(xiàn)類的全限定名，把類加載到JVM；
4、SPI的實現(xiàn)類必須攜帶一個不帶參數(shù)的構(gòu)造方法；

示例代碼

步驟1、定義一組接口 (假設(shè)是org.foo.demo.IShout)，并寫出接口的一個或多個實現(xiàn)，(假設(shè)是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文件)，內(nèi)容是要應(yīng)用的實現(xiàn)類（這里是org.foo.demo.animal.Dog和org.foo.demo.animal.Cat，每行一個類）。

文件位置

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

文件內(nèi)容

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

步驟3、使用 ServiceLoader 來加載配置文件中指定的實現(xiàn)。

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

4 原理解析

首先看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;

  // 創(chuàng)建ServiceLoader時采用的訪問控制上下文
  private final AccessControlContext acc;

  // 緩存providers，按實例化的順序排列
  private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

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

參考具體ServiceLoader具體源碼，代碼量不多，加上注釋一共587行，梳理了一下，實現(xiàn)的流程如下：

1 應(yīng)用程序調(diào)用ServiceLoader.load方法
ServiceLoader.load方法內(nèi)先創(chuàng)建一個新的ServiceLoader，并實例化該類中的成員變量，包括：

• loader(ClassLoader類型，類加載器)
• acc(AccessControlContext類型，訪問控制器)
• providers(LinkedHashMap<String,S>類型，用于緩存加載成功的類)
• lookupIterator(實現(xiàn)迭代器功能)

2 應(yīng)用程序通過迭代器接口獲取對象實例
ServiceLoader先判斷成員變量providers對象中(LinkedHashMap<String,S>類型)是否有緩存實例對象，如果有緩存，直接返回。
如果沒有緩存，執(zhí)行類的裝載，實現(xiàn)如下：
(1) 讀取META-INF/services/下的配置文件，獲得所有能被實例化的類的名稱，值得注意的是，ServiceLoader可以跨越j(luò)ar包獲取META-INF下的配置文件，具體加載配置的實現(xiàn)代碼如下：

    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>類型）
然后返回實例對象。

5 總結(jié)

優(yōu)點：
使用Java SPI機制的優(yōu)勢是實現(xiàn)解耦，使得第三方服務(wù)模塊的裝配控制的邏輯與調(diào)用者的業(yè)務(wù)代碼分離，而不是耦合在一起。應(yīng)用程序可以根據(jù)實際業(yè)務(wù)情況啟用框架擴展或替換框架組件。

缺點：

雖然ServiceLoader也算是使用的延遲加載，但是基本只能通過遍歷全部獲取，也就是接口的實現(xiàn)類全部加載并實例化一遍。如果你并不想用某些實現(xiàn)類，它也被加載并實例化了，這就造成了浪費。獲取某個實現(xiàn)類的方式不夠靈活，只能通過Iterator形式獲取，不能根據(jù)某個參數(shù)來獲取對應(yīng)的實現(xiàn)類。
多個并發(fā)多線程使用ServiceLoader類的實例是不安全的。

以上就是深入理解Java中的SPI機制的詳細(xì)內(nèi)容，更多關(guān)于Java SPI機制的資料請關(guān)注腳本之家其它相關(guān)文章！

最新評論