簡介

什麼是可擴充套件的應用程式呢？可擴充套件的意思是不需要修改原始程式碼，就可以擴充套件應用程式的功能。我們將應用程式做成外掛或者模組。

這樣可以在不修改原應用的基礎上，對系統功能進行升級或者定製化。

本文將會向大家介紹如何通過java中的SPI機制實現這種可擴充套件的應用程式。

SPI簡介

SPI的全稱是Java Service Provider Interface。是java提供的一種服務發現的機制。

通過遵循相應的規則編寫應用程式之後，就可以使用ServiceLoader來載入相應的服務了。

SPI的實現主要分為4個部分：

Service Provider Interface: SPI是一個interface或者是抽象類，其中定義了我們需要擴充套件實現的功能。

Service Providers：這是SPI的具體實現，提供了具體的實現功能

SPI Configuration File：SPI的配置檔案，通過在配置檔案我們來配置相關的SPI發現資訊。

ServiceLoader: ServiceLoader是用來載入和發現服務的java類，並提供了很多有用的方法。

SPI的普通java實現

講完SPI的定義，大家可能還是不清楚SPI到底是做什麼的，又該怎麼使用它。

不用急，我們下面通過一個例子來說明。

首先建立一個module:SPI-service,裡面主要定義了一個ModuleService介面：

public interface ModuleService {

}

然後再分別建立兩個module，作為ModuleService的實現：

public class ModuleServiceA implements ModuleService {

  public ModuleService getModuleService(){
    return new ModuleServiceA();
  }
}

public class ModuleServiceB implements ModuleService {

  public ModuleService getModuleService(){
    return new ModuleServiceB();
  }
}

接著分別在兩個module中建立META-INF/services資料夾，並且在裡面建立兩個以 Service Provider Interface限定名為名字的檔案，這裡檔名是：com.flydean.base.service.ModuleService，檔案裡面存放的是SPI的具體實現類：

com.flydean.base.servicea.ModuleServiceA

com.flydean.base.serviceb.ModuleServiceB

最後，我們需要建立一個使用SPI的類：

public class ModuleController {

  public static void main(String[] args) {
    List<ModuleService> moduleServices = ServiceLoader
        .load(ModuleService.class).stream()
        .map(ServiceLoader.Provider::get)
        .collect(toList());
    log.info("{}",moduleServices);
  }
}

為了更好的展示擴充套件應用的實際使用，我們分別建立4個模組。在實際應用中，只需要將這些jar包加入應用程式的classpath即可。

執行看下輸出結果：

[com.flydean.base.servicea.ModuleServiceA@16f65612,

com.flydean.base.serviceb.ModuleServiceB@311d617d]

從結果看到，我們獲得了兩個ModuleService。證明系統擴充套件成功。

SPI在JPMS模組化系統下的實現

上面我們講的是基本的操作，考慮一下，如果是在JDK9之後，引入了JPMS模組化系統之後，應該怎麼使用SPI呢？

程式碼肯定是一樣，我們需要修改的是SPI配置檔案。

如果在JPMS中，我們就不需要使用META-INF/services了，我們只需要建立相應的module-info.java檔案即可。

先看下SPI模組的module-info.java檔案：

module com.flydean.service {
  exports com.flydean.service;
}

這個模組我們對外暴露了service package，供其他模組呼叫。

接下來是SPI的實現模組：

module com.flydean.servicea {
  requires com.flydean.service;
  provides com.flydean.service.ModuleService with com.flydean.servicea.ModuleServiceA;
  exports com.flydean.servicea;
}

這裡我們使用了provides命令，定義了兩個類的關聯關係。

最後是呼叫的模組：

module com.flydean.controller {
  uses com.flydean.service.ModuleService;
  requires com.flydean.service;
  requires lombok;
  requires slf4j.api;
}

這裡我們使用uses關鍵詞來引用ModuleService。

總結

本文介紹了SPI在模組化和非模組化系統中的應用。

本文中的例子：learn-java-base-9-to-20

補充知識：Java中SPI機制詳解

本文通過探析JDK提供的，在開源專案中比較常用的Java SPI機制，希望給大家在實際開發實踐、學習開源專案提供參考。

一、 SPI是什麼

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

整體機制圖如下：

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

系統設計的各個抽象，往往有很多不同的實現方案，在面向的物件的設計裡，一般推薦模組之間基於介面程式設計，模組之間不對實現類進行硬編碼。一旦程式碼裡涉及具體的實現類，就違反了可拔插的原則，如果需要替換一種實現，就需要修改程式碼。為了實現在模組裝配的時候能不在程式裡動態指明，這就需要一種服務發現機制。

Java SPI就是提供這樣的一個機制：為某個介面尋找服務實現的機制。有點類似IOC的思想，就是將裝配的控制權移到程式之外，在模組化設計中這個機制尤其重要。所以SPI的核心思想就是解耦。

二、使用場景

概括地說，適用於：呼叫者根據實際使用需要，啟用、擴充套件、或者替換框架的實現策略。

比較常見的例子：

資料庫驅動載入介面實現類的載入

JDBC載入不同型別資料庫的驅動

日誌門面介面實現類載入

SLF4J載入不同提供商的日誌實現類

Spring

Spring中大量使用了SPI,比如：對servlet3.0規範

對ServletContainerInitializer的實現、自動型別轉換Type Conversion SPI(Converter SPI、Formatter SPI)等

Dubbo

Dubbo中也大量使用SPI的方式實現框架的擴充套件,不過它對Java提供的原生SPI做了封裝，允許使用者擴充套件實現Filter介面

三、使用介紹

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

當服務提供者提供了介面的一種具體實現後，在jar包的META-INF/services目錄下建立一個以“介面全限定名”為命名的檔案，內容為實現類的全限定名；

介面實現類所在的jar包放在主程式的classpath中；

主程式通過java.util.ServiceLoder動態裝載實現模組，它通過掃描META-INF/services目錄下的配置檔案找到實現類的全限定名，把類載入到JVM；

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具體原始碼，程式碼量不多，加上註釋一共587行，梳理了一下，實現的流程如下：

1、 應用程式呼叫ServiceLoader.load方法

ServiceLoader.load方法內先建立一個新的ServiceLoader，並例項化該類中的成員變數，包括：

loader(ClassLoader型別，類載入器)

acc(AccessControlContext型別，訪問控制器)

providers(LinkedHashMap<String,S>型別，用於快取載入成功的類)

lookupIterator(實現迭代器功能)

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

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

通過反射方法Class.forName()載入類物件，並用instance()方法將類例項化。

把例項化後的類快取到providers物件中，(LinkedHashMap<String,S>型別），然後返回例項物件。

六、總結

優點：

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

缺點：

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

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

以上這篇在java中使用SPI建立可擴充套件的應用程式操作就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支援我們。