深入理解Java 中SPI 制

概述

• SPI（Service Provider Interface），是JDK內置的一種服務提供發現機制，可以用來啟用框架擴展和替換組件，主要是被框架的開發人員使用，比如java.sql.Driver接口，其他不同廠商可以針對同一接口做出不同的實現，MySQL和PostgreSQL都有不同的實現提供給用戶，而Java的SPI機制可以為某個接口尋找服務實現。Java中SPI機制主要思想是將裝配的控制權移到程序之外，在模塊化設計中這個機制尤其重要，其核心思想就是解耦。

SPI整體機制圖如下

• 當服務的提供者提供了一種接口的實現之后，需要在classpath下的META-INF/services/目錄里創建一個以服務接口命名的文件，這個文件里的內容就是這個接口的具體的實現類。當其他的程序需要這個服務的時候，就可以通過查找這個jar包（一般都是以jar包做依賴）的META-INF/services/中的配置文件，配置文件中有接口的具體實現類名，可以根據這個類名進行加載實例化，就可以使用該服務了。JDK中查找服務的實現的工具類是：java.util.ServiceLoader。

java.util.ServiceLoader

• 首先，ServiceLoader實現了Iterable接口，所以它有迭代器的屬性，這里主要都是實現了迭代器的hasNext和next方法。這里主要都是調用的lookupIterator的相應hasNext和next方法，lookupIterator是懶加載迭代器。
• 其次，LazyIterator中的hasNext方法，靜態變量PREFIX就是”META-INF/services/”目錄，這也就是為什么需要在classpath下的META-INF/services/目錄里創建一個以服務接口命名的文件。
• 最后，通過反射方法Class.forName()加載類對象，並用newInstance方法將類實例化，並把實例化后的類緩存到providers對象中，(LinkedHashMap<String,S>類型） 然后返回實例對象。

demo

//定義一個接口HelloSPI。
package com.vivo.study.spidemo.spi;
public interface HelloSPI {
    void sayHello();
}

//完成接口的多個實現。
package com.vivo.study.spidemo.spi.impl;
import com.vivo.study.spidemo.spi.HelloSPI;
public class ImageHello implements HelloSPI {
    public void sayHello() {
        System.out.println("Image Hello");
    }
}

package com.vivo.study.spidemo.spi.impl;
import com.vivo.study.spidemo.spi.HelloSPI;
public class TextHello implements HelloSPI {
    public void sayHello() {
        System.out.println("Text Hello");
    }
}

//在META-INF/services/目錄里創建一個以com.vivo.study.spidemo.spi.HelloSPI的文件，這個文件里的內容就是這個接口的具體的實現類。
內容如下
com.vivo.study.spidemo.spi.impl.ImageHello
com.vivo.study.spidemo.spi.impl.TextHello


// 使用 ServiceLoader 來加載配置文件中指定的實現
package com.vivo.study.spidemo.test
import java.util.ServiceLoader;
import com.vivo.study.spidemo.spi.HelloSPI;
public class SPIDemo {
    public static void main(String[] args) {
        ServiceLoader<HelloSPI> serviceLoader = ServiceLoader.load(HelloSPI.class);
        // 執行不同廠商的業務實現，具體根據業務需求配置
        for (HelloSPI helloSPI : serviceLoader) {
            helloSPI.sayHello();
        }
    }
}


//輸出結果如下：
Image Hello
Text Hello

不足

• 1.不能按需加載，需要遍歷所有的實現，並實例化，然后在循環中才能找到我們需要的實現。如果不想用某些實現類，或者某些類實例化很耗時，它也被載入並實例化了，這就造成了浪費。
• 2.獲取某個實現類的方式不夠靈活，只能通過 Iterator 形式獲取，不能根據某個參數來獲取對應的實現類。
• 3.多個並發多線程使用 ServiceLoader 類的實例是不安全的。