可插拔組件設計機制—SPI介紹

1.SPI 是什么？

SPI 的全稱是 Service Provider Interface, 即提供服務接口；是一種服務發(fā)現(xiàn)機制，SPI 的本質是將接口實現(xiàn)類的全限定名配置在文件中，并由服務加載器讀取配置文件，加載實現(xiàn)類。這樣可以在運行時，動態(tài)為接口替換實現(xiàn)類。正因此特性，我們可以很容易的通過 SPI 機制為我們的程序提供拓展功能。 如下圖：



系統(tǒng)設計的各個抽象，往往有很多不同的實現(xiàn)方案，在面對象設計里，一般推薦模塊之間基于接口編程，模塊之間不對實現(xiàn)硬編碼，一旦代碼涉及具體的實現(xiàn)類，就違反了可插拔的原則。Java SPI 就是提供這樣的一個機制，為某一個接口尋找服務的實現(xiàn)，有點類似 IOC 的思想，把裝配的控制權移到程序之外，在模塊化涉及里面這個各尤為重要。與其說 SPI 是 java 提供的一種服務發(fā)現(xiàn)機制，倒不如說是一種解耦思想。

2. 使用場景

數(shù)據(jù)庫驅動加載接口實現(xiàn)類的加載；如：JDBC 加載 Mysql,Oracle...

日志門面接口實現(xiàn)類加載，如：SLF4J 對 log4j、logback 的支持

Spring 中大量使用了 SPI，特別是 spring-boot 中自動化配置的實現(xiàn)

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

3. 使用介紹

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

當服務提供者提供了接口的一種具體實現(xiàn)后，需要在 JAR 包的 META-INF/services 目錄下創(chuàng)建一個以 “接口全限制定名” 為命名的文件，內(nèi)容為實現(xiàn)類的全限定名；

接口實現(xiàn)類所在的 JAR 放在主程序的 classpath 下，也就是引入依賴。

主程序通過 java.util.ServiceLoder 動態(tài)加載實現(xiàn)模塊，它會通過掃描 META-INF/services 目錄下的文件找到實現(xiàn)類的全限定名，把類加載值 JVM, 并實例化它；

SPI 的實現(xiàn)類必須攜帶一個不帶參數(shù)的構造方法。

示例：



spi-interface 模塊定義

定義一組接口：public interface MyDriver 

spi-jd-driver

spi-ali-driver

實現(xiàn)為：public class JdDriver implements MyDriver
  public class AliDriver implements MyDriver 

在 src/main/resources/ 下建立 /META-INF/services 目錄， 新增一個以接口命名的文件 (org.MyDriver 文件)

內(nèi)容是要應用的實現(xiàn)類分別 com.jd.JdDriver 和 com.ali.AliDriver

spi-core

一般都是平臺提供的核心包，包含加載使用實現(xiàn)類的策略等等，我們這邊就簡單實現(xiàn)一下邏輯：a. 沒有找到具體實現(xiàn)拋出異常 b. 如果發(fā)現(xiàn)多個實現(xiàn)，分別打印

public void invoker(){
    ServiceLoader  serviceLoader = ServiceLoader.load(MyDriver.class);
    Iterator drivers = serviceLoader.iterator();
    boolean isNotFound = true;
    while (drivers.hasNext()){
        isNotFound = false;
        drivers.next().load();
    }
    if(isNotFound){
        throw new RuntimeException("一個驅動實現(xiàn)類都不存在");
    }
}

spi-test

public class App 
{
    public static void main( String[] args )
    {
        DriverFactory factory = new DriverFactory();
        factory.invoker();
    }
}

1. 引入 spi-core 包，執(zhí)行結果

2. 引入 spi-core,spi-jd-driver 包



3. 引入 spi-core,spi-jd-driver,spi-ali-driver

4. 原理解析

看看我們剛剛是怎么拿到具體的實現(xiàn)類的？ 就兩行代碼：

ServiceLoader  serviceLoader = ServiceLoader.load(MyDriver.class);
Iterator drivers = serviceLoader.iterator();

所以，首先我們看 ServiceLoader 類：

public final class ServiceLoader implements Iterable{
//配置文件的路徑
 private static final String PREFIX = "META-INF/services/";
    // 代表被加載的類或者接口
    private final Class service;
    // 用于定位，加載和實例化providers的類加載器
    private final ClassLoader loader;
    // 創(chuàng)建ServiceLoader時采用的訪問控制上下文
    private final AccessControlContext acc;
    // 緩存providers，按實例化的順序排列
    private LinkedHashMap providers = new LinkedHashMap<>();
    // 懶查找迭代器，真正加載服務的類
    private LazyIterator lookupIterator;
  
 //服務提供者查找的迭代器
    private class LazyIterator
        implements Iterator
    {
 .....
private boolean hasNextService() {
            if (nextName != null) {
                return true;
            }
            if (configs == null) {
                try {
//全限定名：com.xxxx.xxx
                    String fullName = PREFIX + service.getName();
                    if (loader == null)
                        configs = ClassLoader.getSystemResources(fullName);
                    else
                        configs = loader.getResources(fullName);
                }
            }
            while ((pending == null) || !pending.hasNext()) {
                if (!configs.hasMoreElements()) {
                    return false;
                }
                pending = parse(service, configs.nextElement());
            }
            nextName = pending.next();
            return true;
        }


        private S nextService() {
            if (!hasNextService())
                throw new NoSuchElementException();
            String cn = nextName;
            nextName = null;
            Class c = null;
            try {
//通過反射獲取
                c = Class.forName(cn, false, loader);
            }
            if (!service.isAssignableFrom(c)) {
                fail(service, "Provider " + cn  + " not a subtype");
            }
            try {
                S p = service.cast(c.newInstance());
                providers.put(cn, p);
                return p;
            }
        }
........