SpringBoot詳細介紹SPI機制示例

更新時間：2022年08月22日 15:58:40 作者：ikt4435

這篇文章主要介紹了深入解析Spring Boot的SPI機制詳情，SPI是JDK內(nèi)置的一種服務提供發(fā)現(xiàn)機制，可以用來啟用框架擴展和替換組件,主要用于框架中開發(fā)，更多相關介紹，感興趣的小伙伴可以參考一下下面文章內(nèi)容

簡介

SPI(Service Provider Interface)是JDK內(nèi)置的一種服務提供發(fā)現(xiàn)機制，可以用來啟用框架擴展和替換組件,主要用于框架中開發(fā)，例如Dubbo、Spring、Common-Logging，JDBC等采用采用SPI機制，針對同一接口采用不同的實現(xiàn)提供給不同的用戶，從而提高了框架的擴展性。

Java SPI實現(xiàn)

Java內(nèi)置的SPI通過java.util.ServiceLoader類解析classPath和jar包的META-INF/services/目錄下的以接口全限定名命名的文件，并加載該文件中指定的接口實現(xiàn)類，以此完成調(diào)用。

示例說明

創(chuàng)建動態(tài)接口

public interface VedioSPI
{
    void call();
}

實現(xiàn)類1

public class Mp3Vedio implements VedioSPI
{
    @Override
    public void call()
    {
        System.out.println("this is mp3 call");
    }
}

實現(xiàn)類2

public class Mp4Vedio implements VedioSPI
{
    @Override
    public void call()
    {
       System.out.println("this is mp4 call");
    }
}

在項目的source目錄下新建META-INF/services/目錄下，創(chuàng)建com.skywares.fw.juc.spi.VedioSPI文件。

運行結(jié)果

源碼分析

上述只是通過簡單的示例來實現(xiàn)下java的內(nèi)置的SPI功能。其實現(xiàn)原理是ServiceLoader是Java內(nèi)置的用于查找服務提供接口的工具類，通過調(diào)用load()方法實現(xiàn)對服務提供接口的查找，最后遍歷來逐個訪問服務提供接口的實現(xiàn)類。

從源碼可以發(fā)現(xiàn)：

ServiceLoader類本身實現(xiàn)了Iterable接口并實現(xiàn)了其中的iterator方法，iterator方法的實現(xiàn)中調(diào)用了LazyIterator這個內(nèi)部類中的方法，解析完服務提供接口文件后最終結(jié)果放在了Iterator中返回，并不支持服務提供接口實現(xiàn)類的直接訪問。
所有服務提供接口的對應文件都是放置在META-INF/services/目錄下，final類型決定了PREFIX目錄不可變更。

雖然java提供的SPI機制的思想非常好，但是也存在相應的弊端。具體如下：

Java內(nèi)置的方法方式只能通過遍歷來獲取
服務提供接口必須放到META-INF/services/目錄下。

針對java的spi存在的問題，Spring的SPI機制沿用的SPI的思想，但對其進行擴展和優(yōu)化。

Spring SPI

Spring SPI沿用了Java SPI的設計思想，Spring采用的是spring.factories方式實現(xiàn)SPI機制，可以在不修改Spring源碼的前提下，提供Spring框架的擴展性。

Spring示例

定義接口

public interface DataBaseSPI
{
   void getConnection();
}

相關實現(xiàn)

#DB2實現(xiàn)
public class DB2DataBase implements DataBaseSPI
{
    @Override
    public void getConnection()
    {
        System.out.println("this database is db2");
    }
}
#Mysql實現(xiàn)
public class MysqlDataBase implements DataBaseSPI
{
    @Override
    public void getConnection()
    {
       System.out.println("this is mysql database");
    }
}

1.在項目的META-INF目錄下，新增spring.factories文件

2.填寫相關的接口信息，內(nèi)容如下

com.skywares.fw.juc.springspi.DataBaseSPI = com.skywares.fw.juc.springspi.DB2DataBase, com.skywares.fw.juc.springspi.MysqlDataBase

說明多個實現(xiàn)采用逗號分隔。

相關測試類

public class SpringSPITest
{
    public static void main(String[] args)
    {
         List<DataBaseSPI> dataBaseSPIs =SpringFactoriesLoader.loadFactories(DataBaseSPI.class, 
                 Thread.currentThread().getContextClassLoader());
         for(DataBaseSPI datBaseSPI:dataBaseSPIs){
            datBaseSPI.getConnection();
         }
    }
}

輸出結(jié)果

從示例中我們看出，Spring 采用spring.factories實現(xiàn)SPI與java實現(xiàn)SPI非常相似，但是spring的spi方式針對java的spi進行的相關優(yōu)化具體內(nèi)容如下：

Java SPI是一個服務提供接口對應一個配置文件，配置文件中存放當前接口的所有實現(xiàn)類，多個服務提供接口對應多個配置文件，所有配置都在services目錄下；
Spring factories SPI是一個spring.factories配置文件存放多個接口及對應的實現(xiàn)類，以接口全限定名作為key，實現(xiàn)類作為value來配置，多個實現(xiàn)類用逗號隔開，僅spring.factories一個配置文件。

那么spring是如何通過加載spring.factories來實現(xiàn)SpI的呢?我們可以通過源碼來進一步分析。