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 boot 中也有一種類似的加載機制,它在META-INFO/spring.factories文件中配置接口的實現類名稱,然后在程序中讀取這些配置文件並實例化。

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

Spring Factories實現原理

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

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

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

  private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
        MultiValueMap<String, String> result = cache.get(classLoader);
        if (result != null) {
            return result;
        }

        try {
            Enumeration<URL> urls = (classLoader != null ?
                    classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
                    ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
            result = new LinkedMultiValueMap<>();
            while (urls.hasMoreElements()) {
                URL url = urls.nextElement();
                UrlResource resource = new UrlResource(url);
                Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                for (Map.Entry<?, ?> entry : properties.entrySet()) {
                    String factoryClassName = ((String) entry.getKey()).trim();
                    for (String factoryName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
                        result.add(factoryClassName, factoryName.trim());
                    }
                }
            }
            cache.put(classLoader, result);
            return result;
        }
        catch (IOException ex) {
            throw new IllegalArgumentException("Unable to load factories from location [" +
                    FACTORIES_RESOURCE_LOCATION + "]", ex);
        }
    }

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

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

com.xxx.interface=com.xxx.classname
如果一個接口希望配置多個實現類,可以用","分割。

spring-boot包中的spring.factories文件

在Spring Boot 的很多包中都能夠找到spring.factories,下面就是spring-boot 包中的spring.factories文件

# PropertySource Loaders
org.springframework.boot.env.PropertySourceLoader=\
org.springframework.boot.env.PropertiesPropertySourceLoader,\
org.springframework.boot.env.YamlPropertySourceLoader

# Run Listeners
org.springframework.boot.SpringApplicationRunListener=\
org.springframework.boot.context.event.EventPublishingRunListener

# Error Reporters
org.springframework.boot.SpringBootExceptionReporter=\
org.springframework.boot.diagnostics.FailureAnalyzers

# Application Context Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer,\
org.springframework.boot.context.ContextIdApplicationContextInitializer,\
org.springframework.boot.context.config.DelegatingApplicationContextInitializer,\
org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer

# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.ClearCachesApplicationListener,\
org.springframework.boot.builder.ParentContextCloserApplicationListener,\
org.springframework.boot.context.FileEncodingApplicationListener,\
org.springframework.boot.context.config.AnsiOutputApplicationListener,\
org.springframework.boot.context.config.ConfigFileApplicationListener,\
org.springframework.boot.context.config.DelegatingApplicationListener,\
org.springframework.boot.context.logging.ClasspathLoggingApplicationListener,\
org.springframework.boot.context.logging.LoggingApplicationListener,\
org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicationListener

# Environment Post Processors
org.springframework.boot.env.EnvironmentPostProcessor=\
org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor,\
org.springframework.boot.env.SpringApplicationJsonEnvironmentPostProcessor,\
org.springframework.boot.env.SystemEnvironmentPropertySourceEnvironmentPostProcessor

# Failure Analyzers
org.springframework.boot.diagnostics.FailureAnalyzer=\
org.springframework.boot.diagnostics.analyzer.BeanCurrentlyInCreationFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.BeanNotOfRequiredTypeFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.BindFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.BindValidationFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.UnboundConfigurationPropertyFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.ConnectorStartFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.NoUniqueBeanDefinitionFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.PortInUseFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.ValidationExceptionFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.InvalidConfigurationPropertyNameFailureAnalyzer,\
org.springframework.boot.diagnostics.analyzer.InvalidConfigurationPropertyValueFailureAnalyzer

# FailureAnalysisReporters
org.springframework.boot.diagnostics.FailureAnalysisReporter=\
org.springframework.boot.diagnostics.LoggingFailureAnalysisReporter

在日常工作中,我們可能需要實現一些SDK 或者Sring boot starter 給別人用的時候,我們就可以使用Factories機制,Factories機制可以讓SDK或者Stater的使用只需要很少或者不需要進行配置,只需要在服務中引入我們的Jar包就即可。

自動裝配

  在java spring cloud項目中,我們常常會在子模塊中創建公共類庫,作為驅動包。那么在另外一個子模塊中,需要加載配置文件的時候,往往Spring Boot 自動掃描包的時候,只會掃描自己模塊下的類。

1、引入META-INF/spring.factories文件

        如何讓我們的starter里的@Configuration在使用者的項目里生效呢?

        在SpringBoot的啟動類中,@SpringBootApplication注解的代碼里面有一句@EnableAutoConfiguration

  @EnableAutoConfiguration注解加載的是資源目錄META-INF文件下的spring.factories的文件。包括導入到項目中的Jar包的META-INF文件夾下的spring.factories文件。spring.factories文件是一個properties文件。

2、@ComponentScan注解

  作用是掃描@SpringBootApplication所在的Application類(即spring-boot項目的入口類)所在的包(basepackage)下所有的@component注解(或拓展了@component的注解)標記的bean,並注冊到spring容器中。 

源碼解析

先看看SpringBoot的主配置類:

里面有一個main方法運行了一個run()方法,在run方法中必須要傳入一個被@SpringBootApplication注解的類。

@SpringBootApplication

SpringBoot應用標注在某個類上說明這個類是SpringBoot的主配置類,SpringBoot就會運行這個類的main方法來啟動SpringBoot項目。

那@SpringBootApplication注解到底是什么呢,點進去看看:

發現@@SpringBootApplication是一個組合注解。

@SpringBootConfiguration 

先看看@SpringBootConfiguration注解:

這個注解很簡單,表名該類是一個Spring的配置類。

再進去看看@Configuration:

說明Spring的配置類也是Spring的一個組件。

@EnableAutoConfiguration

這個注解是開啟自動配置的功能。

先看看@AutoConfigurationPackage注解:

這個注解是自動配置包,主要是使用的@Import來給Spring容器中導入一個組件 ,這里導入的是Registrar.class。

來看下這個Registrar:

就是通過這個方法獲取掃描的包路徑,可以debug看看:

在這行代碼上打了一個斷點:

啟動項目:

進入斷點處:

看看能否獲取掃描的包路徑:

已經獲取到了包路徑:

那那個metadata是什么呢:

可以看到是標注在@SpringBootApplication注解上的DemosbApplication,也就是我們的主配置類:

說白了就是將主配置類(即@SpringBootApplication標注的類)的所在包及子包里面所有組件掃描加載到Spring容器。所以包名一定要注意。

現在包掃描路徑獲取到了,那具體加載哪些組件呢,看看下面這個注解。

@Import({AutoConfigurationImportSelector.class})

@Import注解就是給Spring容器中導入一些組件,這里傳入了一個組件的選擇器:AutoConfigurationImportSelector。

里面有一個selectImports方法,將所有需要導入的組件以全類名的方式返回;這些組件就會被添加到容器中。

debug運行看看:

會給容器中導入非常多的自動配置類(xxxAutoConfiguration);就是給容器中導入這個場景需要的所有組件,並配置好這些組件:

有了自動配置類,免去了我們手動編寫配置注入功能組件等的工作。

那他是如何獲取到這些配置類的呢,看看上面這個方法:

會從META-INF/spring.factories中獲取資源,然后通過Properties加載資源:

Spring Boot在啟動的時候從類路徑下的META-INF/spring.factories中獲取EnableAutoConfiguration指定的值,將這些值作為自動配置類導入到容器中,自動配置類就生效,幫我們進行自動配置工作。以前我們需要自己配置的東西,自動配置類都幫我們完成了。

J2EE的整體整合解決方案和自動配置都在spring-boot-autoconfigure-2.0.3.RELEASE.jar:

比如看看WebMvcAutoConfiguration:

都已經幫我們配置好了,我們不用再單獨配置了:


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM