聊聊 Java SPI 機制，你會了嗎？

作者：不才陳某 2022-05-06 08:26:32

通過Java的SPI機制能夠很方便的實現(xiàn)可插拔、解耦的功能設(shè)計，在日常的開發(fā)中要能想到該機制并能靈活的運用。

va SPI 是基于接口的編程+策略模式+約定配置文件組合實現(xiàn)的動態(tài)加載機制，能夠很方便的為某個接口尋找服務(wù)實現(xiàn)的機制。

今天這篇文章就來深入聊一下SPI。

什么是SPI?

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

面向的對象的設(shè)計里，我們一般推薦模塊之間基于接口編程，模塊之間不對實現(xiàn)類進(jìn)行硬編碼。一旦代碼里涉及具體的實現(xiàn)類，就違反了可拔插的原則，如果需要替換一種實現(xiàn)，就需要修改代碼。

為了實現(xiàn)在模塊裝配的時候不用在程序里動態(tài)指明，這就需要一種服務(wù)發(fā)現(xiàn)機制。java spi就是提供這樣的一個機制：為某個接口尋找服務(wù)實現(xiàn)的機制。這有點類似IOC的思想，將裝配的控制權(quán)移到了程序之外。

這是一種JDK內(nèi)置的一種服務(wù)發(fā)現(xiàn)的機制，用于制定一些規(guī)范，實際實現(xiàn)方式交給不同的服務(wù)廠商。如下圖：

解耦、可拔插、面向接口編程、動態(tài)類加載。

當(dāng)服務(wù)的提供者提供了一種接口的實現(xiàn)之后，需要在classpath下的 META-INF/services/ 目錄里創(chuàng)建一個以服務(wù)接口命名的文件，這個文件里的內(nèi)容就是這個接口的具體的實現(xiàn)類。

當(dāng)其他的程序需要這個服務(wù)的時候，就可以通過查找這個jar包(一般都是以jar包做依賴)的META-INF/services/中的配置文件，配置文件中有接口的具體實現(xiàn)類名，可以根據(jù)這個類名進(jìn)行加載實例化，就可以使用該服務(wù)了。JDK中查找服務(wù)的實現(xiàn)的工具類是：java.util.ServiceLoader。

SPI 的不足

不能按需加載，需要遍歷所有的實現(xiàn)，并實例化，然后在循環(huán)中才能找到我們需要的實現(xiàn)。如果不想用某些實現(xiàn)類，或者某些類實例化很耗時，它也被載入并實例化了，這就造成了浪費。

獲取某個實現(xiàn)類的方式不夠靈活，只能通過 Iterator 形式獲取，不能根據(jù)某個參數(shù)來獲取對應(yīng)的實現(xiàn)類。(Spring 的BeanFactory，ApplicationContext 就要高級一些了。)

多個并發(fā)多線程使用 ServiceLoader 類的實例是不安全的。

API 與 SPI 區(qū)別?

API是調(diào)用并用于實現(xiàn)目標(biāo)的類、接口、方法等的描述;

SPI是擴(kuò)展和實現(xiàn)以實現(xiàn)目標(biāo)的類、接口、方法等的描述;

換句話說，API 為操作提供特定的類、方法，SPI 通過操作來符合特定的類、方法。

SPI和API的使用場景解析：

API (Application Programming Interface)在大多數(shù)情況下，都是實現(xiàn)方制定接口并完成對接口的實現(xiàn)，調(diào)用方僅僅依賴接口調(diào)用，且無權(quán)選擇不同實現(xiàn)。從使用人員上來說，API 直接被應(yīng)用開發(fā)人員使用。
SPI (Service Provider Interface)是調(diào)用方來制定接口規(guī)范，提供給外部來實現(xiàn)，調(diào)用方在調(diào)用時則選擇自己需要的外部實現(xiàn)。從使用人員上來說，SPI 被框架擴(kuò)展人員使用。

SPI 案例實現(xiàn)

下面來一個簡單的案例實現(xiàn)：比如每個動物都有不同的叫聲，作為聲紋系統(tǒng)會定義一個接口，如下：

public interface AnimalSay {
    void say();
}

在這個系統(tǒng)中并沒有實現(xiàn)具體的實現(xiàn)，但是在處理業(yè)務(wù)邏輯時有需要用到該實例，此時就需要用到SPI去加載實現(xiàn)類，定義一個AnimalManagerLoader，實現(xiàn)如下：

@Data
public class AnimalManagerLoader {
    private static final AnimalManagerLoader INSTANCE = new AnimalManagerLoader();

    private final List<AnimalSay> animalSays;

    private AnimalManagerLoader() {
        animalSays = load();
    }

    /**
     * 通過SPI加載實現(xiàn)類
     */
    private List<AnimalSay> load() {
        ArrayList<AnimalSay> animalSays = new ArrayList<>();
        Iterator<AnimalSay> iterator = ServiceLoader.load(AnimalSay.class).iterator();
        while (iterator.hasNext()){
            animalSays.add(iterator.next());
        }
        return animalSays;
    }

    public static AnimalManagerLoader getInstance() {
        return INSTANCE;
    }
}

此時就可以通過AnimalManagerLoader中的load方法去加載對應(yīng)的實現(xiàn)類，封裝到List集合中，調(diào)用如下：

public static void main(String[] args) {
        AnimalManagerLoader animalManagerLoader = AnimalManagerLoader.getInstance();
        List<AnimalSay> animalSays = animalManagerLoader.getAnimalSays();
        for (AnimalSay animalSay : animalSays) {
            animalSay.say();
        }
   }

那么此時提供聲音的廠家就需要實現(xiàn)這個接口，比如狗狗的聲紋廠家，實現(xiàn)如下：

/**
 * 狗狗的聲紋
 */
public class DogSay implements AnimalSay {
    public void say() {
        System.out.println("wang wang ~");
    }
}

貓咪的聲紋如下：

/**
 * 貓咪的聲紋
 */
public class CatSay implements AnimalSay {
    @Override
    public void say() {
        System.out.println("miao miao ~");
    }
}

實現(xiàn)類定義了，就需要在 /META-INF/services 中定義一個 com.myjszl.animal.api.AnimalSay文件，內(nèi)容如下：

com.myjszl.dog.api.DogSay
com.myjszl.dog.api.CatSay

SPI 應(yīng)用場景

SPI擴(kuò)展機制應(yīng)用場景有很多，比如Common-Logging，JDBC，Dubbo、ShardingSphere等等。

1. JDBC場景

java中定義的java.sql.Driver接口，并沒有具體的實現(xiàn)，實現(xiàn)方式而是交給不同的服務(wù)廠商：

在MySQL的jar包mysql-connector-java-6.0.6.jar中，可以找到META-INF/services目錄，該目錄下會有一個名字為java.sql.Driver的文件，文件內(nèi)容是com.mysql.cj.jdbc.Driver，這里面的內(nèi)容就是針對Java中定義的接口的實現(xiàn)。
PostgreSQL的jar包PostgreSQL-42.0.0.jar中，也可以找到同樣的配置文件，文件內(nèi)容是org.postgresql.Driver，這是PostgreSQL對Java的java.sql.Driver的實現(xiàn)。

2. ShardingSphere的場景

在ShardingSphere中為了實現(xiàn)分布式事務(wù)提供了一個接口ShardingTransactionManager，但是在其架構(gòu)中并未對其做出具體的實現(xiàn)，而是交給不同的廠商去實現(xiàn)，比如JTA強一致性事務(wù)的XAShardingTransactionManager，在其中META-INF/services就有一個org.apache.shardingsphere.transaction.spi.ShardingTransactionManager文件，如下圖：

以上只是簡單的列舉了幾個場景，實際應(yīng)用場景很多，比如Spring、Spring Boot 中都有用到SPI設(shè)計。

3. Spring 場景

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

4. SLFJ 日志門面場景

SLF4J加載不同提供商的日志實現(xiàn)類，比如log4j、log4j2、logback.....

總結(jié)