Spring中的spring.factories文件用法(Spring如何加載第三方Bean)

Posted on by

Spring的spring.factories文件用法

在springBoot中，它自動掃描包的時候，隻會掃描自己模塊下的類。

問題

如果我們不想被Spring容器管理的Bean的路徑下不再SpringBoot的包掃描路徑下，怎麼辦呢？如何加載別的第三方Bean呢？

解決

首先我們創建一個工程，另外創建一個與啟動類不在一個級別的目錄。

第一種方法就是使用在啟動類上加上@Import註解。

@Import(value = {Test.class})

第二種方法就是創建spring.factories文件

現在我們將其改造一下，采用spring.factories的方式去加載Test類，在resources目錄下新建一個META-INF的目錄，然後再新建一個spring.factories文件，文件內容為：

下面第二條就是我們自己的類的路徑。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=/
com.huawei.it.config.Test

然後在springBoot中的啟動類中將@Import註釋掉，啟動一下，在控制臺上就會發現，我們自己的配置類已經加載到Spring容器中去瞭，所以Spring可以加載一個工程下的任意一下工程類瞭。

應用

下面就是我在Nacos源碼中看到的，可以看到spring.factories文件中內容，與我們自己類加載到Spring容器中是一樣的道理。

SpringBoot的擴展機制之Spring Factories

寫在前面：Spring Boot中有一種非常解耦的擴展機制：Spring Factories。這種擴展機制實際上是仿照Java中的SPI擴展機制來實現的。

什麼是 SPI機制

SPI的全名為Service Provider Interface.大多數開發人員可能不熟悉，因為這個是針對廠商或者插件的。在java.util.ServiceLoader的文檔裡有比較詳細的介紹。

簡單的總結下java SPI機制的思想。我們系統裡抽象的各個模塊，往往有很多不同的實現方案，比如日志模塊的方案，xml解析模塊、jdbc模塊的方案等。面向的對象的設計裡，我們一般推薦模塊之間基於接口編程，模塊之間不對實現類進行硬編碼。一旦代碼裡涉及具體的實現類，就違反瞭可拔插的原則，如果需要替換一種實現，就需要修改代碼。為瞭實現在模塊裝配的時候能不在程序裡動態指明，這就需要一種服務發現機制。

java SPI就是提供這樣的一個機制：為某個接口尋找服務實現的機制。有點類似IOC的思想，就是將裝配的控制權移到程序之外，在模塊化設計中這個機制尤其重要。

Spring Boot中的SPI機制

在Spring中也有一種類似與Java SPI的加載機制。它在META-INF/spring.factories文件中配置接口的實現類名稱，然後在程序中讀取這些配置文件並實例化。

這種自定義的SPI機制是Spring Boot Starter實現的基礎。

這裡寫圖片描述

Spring Factories實現原理是什麼

spring-core包裡定義瞭SpringFactoriesLoader類，這個類實現瞭檢索META-INF/spring.factories文件，並獲取指定接口的配置的功能。在這個類中定義瞭兩個對外的方法：

loadFactories 根據接口類獲取其實現類的實例，這個方法返回的是對象列表。

loadFactoryNames 根據接口獲取其接口類的名稱，這個方法返回的是類名的列表。

上面的兩個方法的關鍵都是從指定的ClassLoader中獲取spring.factories文件，並解析得到類名列表，具體代碼如下↓

public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
    String factoryClassName = factoryClass.getName();
    try {
        Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
                ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
        List<String> result = new ArrayList<String>();
        while (urls.hasMoreElements()) {
            URL url = urls.nextElement();
            Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
            String factoryClassNames = properties.getProperty(factoryClassName);
            result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
        }
        return result;
    }
    catch (IOException ex) {
        throw new IllegalArgumentException("Unable to load [" + factoryClass.getName() +
                "] factories from location [" + FACTORIES_RESOURCE_LOCATION + "]", ex);
    }
}

從代碼中我們可以知道，在這個方法中會遍歷整個ClassLoader中所有jar包下的spring.factories文件。也就是說我們可以在自己的jar中配置spring.factories文件，不會影響到其它地方的配置，也不會被別人的配置覆蓋。

spring.factories的是通過Properties解析得到的，所以我們在寫文件中的內容都是安裝下面這種方式配置的：

com.xxx.interface=com.xxx.classname

如果一個接口希望配置多個實現類，可以使用’,’進行分割。

Spring Factories在Spring Boot中的應用

在Spring Boot的很多包中都能夠找到spring.factories文件，接下來我們以spring-boot包為例進行介紹

在日常工作中，我們可能需要實現一些SDK或者Spring Boot Starter給被人使用時， 我們就可以使用Factories機制。Factories機制可以讓SDK或者Starter的使用隻需要很少或者不需要進行配置，隻需要在服務中引入我們的jar包即可。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：