讀懂Springboot自動配置原理必會的java SPI思想

什麼是java的SPI

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

Java SPI 實際上是“基於接口的編程＋策略模式＋配置文件”組合實現的動態加載機制。

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

SPI 應用場景

比較常見的例子：

數據庫驅動加載接口實現類的加載
JDBC加載不同類型數據庫的驅動
日誌門面接口實現類加載
SLF4J加載不同提供商的日誌實現類
Spring
Spring中大量使用了SPI,比如：對servlet3.0規範對ServletContainerInitializer的實現、自動類型轉換Type Conversion SPI(Converter SPI、Formatter SPI)等
Dubbo
Dubbo中也大量使用SPI的方式實現框架的擴展, 不過它對Java提供的原生SPI做了封裝，允許用戶擴展實現Filter接口

Java SPI 規範

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

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

案例代碼

創建案例工程

1.創建父工程

2. 創建service-common工程

此工程模塊爲其他工程的公共的依賴模塊，在其中定義PayService接口

public interface PayService {

    public void pay();
}

3. 創建ali-pay工程
   
   在pom.xml文件中引入依賴

<dependencies>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>service-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

創建PayService的實現類AliPayService

public class AliPayService implements PayService {
    public void pay() {
        System.out.println("支付寶支付");
    }
}

在resources下創建META-INF.services包
創建cn.tx.service.PayService文件內容如下：指定文件名所示的接口的實現類

cn.tx.impl.AliPayService

4.創建wx-pay工程

在pom.xml文件中引入依賴

<dependencies>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>service-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

創建PayService的實現類WxPayService

public class WxPayService implements PayService {
    public void pay() {
        System.out.println("微信支付");
    }
}

在resources下創建META-INF.services包
創建cn.tx.service.PayService文件內容如下：指定文件名所示的接口的實現類

cn.tx.impl.WxPayService

5.創建main-pay工程
引入依賴

<dependencies>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>service-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>ali-pay</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--<dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>wx-pay</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>-->
    </dependencies>

創建測試類

public class Test {

    public static void main(String[] args) {
        ServiceLoader<PayService> services = ServiceLoader.load(PayService.class);
        for (PayService service : services) {
            service.pay();
        }
    }
}

執行測試：我們可以看到我們引入的Ali-pay就能得到AlipayService的實現類實例

如果我在pom中切換依賴

<dependencies>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>service-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--<dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>ali-pay</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>-->
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>wx-pay</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

再次執行測試：我們可以看到我們引入的wx-pay就能得到WxpayService的實現類實例

如果兩種支付的依賴都引入

<dependencies>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>service-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>ali-pay</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>cn.tx.spi</groupId>
            <artifactId>wx-pay</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

測試結果

使用Java SPI機制的優勢是實現解耦，使得第三方服務模塊的裝配控制的邏輯與調用者的業務代碼分離，而不是耦合在一起。應用程序可以根據實際業務情況啓用框架擴展或替換框架組件。
Springboot的原理即是使用期原理來做的自動配置。
源碼獲取和更多內容可以加Q羣264572737

直接羣中找到我即可。