深度剖析Spring Boot自動裝配機(jī)制實(shí)現(xiàn)原理

不知名網(wǎng)友發(fā)布于2021-11-26 11:11 / 2108人閱讀

摘要：所以，所謂的自動裝配，實(shí)際上就是如何自動將裝載到容器中來。實(shí)際上在版本中，模塊驅(qū)動注解的出現(xiàn)，已經(jīng)有了一定的自動裝配的雛形，而真正能夠?qū)崿F(xiàn)這一機(jī)制，還是在版本中，條件注解的出現(xiàn)。，我們來看一下的自動裝配是怎么一回事。

Spring Boot自動裝配

在前面的分析中，Spring Framework一直在致力于解決一個(gè)問題，就是如何讓bean的管理變得更簡單，如何讓開發(fā)者盡可能的少關(guān)注一些基礎(chǔ)化的bean的配置，從而實(shí)現(xiàn)自動裝配。所以，所謂的自動裝配，實(shí)際上就是如何自動將bean裝載到Ioc容器中來。

實(shí)際上在spring 3.x版本中，Enable模塊驅(qū)動注解的出現(xiàn)，已經(jīng)有了一定的自動裝配的雛形，而真正能夠?qū)崿F(xiàn)這一機(jī)制，還是在spirng 4.x版本中，conditional條件注解的出現(xiàn)。ok，我們來看一下spring boot的自動裝配是怎么一回事。

自動裝配的演示

      org.springframework.boot     spring-boot-starter-data-redis

spring:    redis:      host: 127.0.0.1       port: 6379

 @Autowired    private RedisTemplateredisTemplate;

按照下面的順序添加starter，然后添加配置，使用RedisTemplate就可以使用了？那大家想沒想過一個(gè)問題，為什么RedisTemplate可以被直接注入？它是什么時(shí)候加入到Ioc容器的呢？這就是自動裝配。自動裝配可以使得classpath下依賴的包相關(guān)的bean，被自動裝載到Spring Ioc容器中，怎么做到的呢?

深入分析EnableAutoConfiguration

EnableAutoConfiguration的主要作用其實(shí)就是幫助springboot應(yīng)用把所有符合條件的@Configuration配置都加載到當(dāng)前SpringBoot創(chuàng)建并使用的IoC容器中。

再回到EnableAutoConfiguration這個(gè)注解中，我們發(fā)現(xiàn)它的import是這樣

@Import(AutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration {

但是從EnableAutoCOnfiguration上面的import注解來看，這里面并不是引入另外一個(gè)Configuration。而是一個(gè)ImportSelector。這個(gè)是什么東西呢？

AutoConfigurationImportSelector是什么？

Enable注解不僅僅可以像前面演示的案例一樣很簡單的實(shí)現(xiàn)多個(gè)Configuration的整合，還可以實(shí)現(xiàn)一些復(fù)雜的場景，比如可以根據(jù)上下文來激活不同類型的bean，@Import注解可以配置三種不同的class

第一種就是前面演示過的，基于普通bean或者帶有@Configuration的bean進(jìn)行諸如
實(shí)現(xiàn)ImportSelector接口進(jìn)行動態(tài)注入

實(shí)現(xiàn)ImportBeanDefinitionRegistrar接口進(jìn)行動態(tài)注入

CacheService

public class CacheService {
}

LoggerService

public class LoggerService {
}

EnableDefineService

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented @Inherited  --允許被繼承@Import({GpDefineImportSelector.class})public @interface EnableDefineService {    String[] packages() default "";}

GpDefineImportSelector

public class GpDefineImportSelector implements ImportSelector {    @Override    public String[] selectImports(AnnotationMetadata annotationMetadata) {        //獲得指定注解的詳細(xì)信息。我們可以根據(jù)注解中配置的屬性來返回不同的class，        //從而可以達(dá)到動態(tài)開啟不同功能的目的    annotationMetadata.getAllAnnotationAttributes(EnableDefineService.class.getName(),true)            .forEach((k,v) -> {                log.info(annotationMetadata.getClassName());                log.info("k:{},v:{}",k,String.valueOf(v));            });        return new String[]{CacheService.class.getName()};    }}

EnableDemoTest

@SpringBootApplication@EnableDefineService(name = "gupao",value = "gupao")public class EnableDemoTest {    public static void main(String[] args) {        ConfigurableApplicationContext ca=SpringApplication.run(EnableDemoTest.class,args);        System.out.println(ca.getBean(CacheService.class));        System.out.println(ca.getBean(LoggerService.class));    }}

了解了selector的基本原理之后，后續(xù)再去分析AutoConfigurationImportSelector的原理就很簡單了，它本質(zhì)上也是對于bean的動態(tài)加載。

@EnableAutoConfiguration注解的實(shí)現(xiàn)原理

了解了ImportSelector和ImportBeanDefinitionRegistrar后，對于EnableAutoConfiguration的理解就容易一些了

它會通過import導(dǎo)入第三方提供的bean的配置類：AutoConfigurationImportSelector

@Import(AutoConfigurationImportSelector.class)

從名字來看，可以猜到它是基于ImportSelector來實(shí)現(xiàn)基于動態(tài)bean的加載功能。之前我們講過Springboot @Enable*注解的工作原理ImportSelector接口selectImports返回的數(shù)組（類的全類名）都會被納入到spring容器中。

那么可以猜想到這里的實(shí)現(xiàn)原理也一定是一樣的，定位到AutoConfigurationImportSelector這個(gè)類中的selectImports方法

selectImports

public String[] selectImports(AnnotationMetadata annotationMetadata) {   if (!isEnabled(annotationMetadata)) {      return NO_IMPORTS;   }// 從配置文件（spring-autoconfigure-metadata.properties）中加載 AutoConfigurationMetadata   AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader         .loadMetadata(this.beanClassLoader);// 獲取所有候選配置類EnableAutoConfiguration   AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(         autoConfigurationMetadata, annotationMetadata);   return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}

getAutoConfigurationEntry

protected AutoConfigurationEntry getAutoConfigurationEntry(      AutoConfigurationMetadata autoConfigurationMetadata,      AnnotationMetadata annotationMetadata) {   if (!isEnabled(annotationMetadata)) {      return EMPTY_ENTRY;   }//獲取元注解中的屬性   AnnotationAttributes attributes = getAttributes(annotationMetadata);//使用SpringFactoriesLoader 加載classpath路徑下META-INF/spring.factories中，//key= org.springframework.boot.autoconfigure.EnableAutoConfiguration對應(yīng)的value   List configurations = getCandidateConfigurations(annotationMetadata,         attributes);//去重   configurations = removeDuplicates(configurations);//應(yīng)用exclusion屬性   Set exclusions = getExclusions(annotationMetadata, attributes);   checkExcludedClasses(configurations, exclusions);   configurations.removeAll(exclusions);//過濾，檢查候選配置類上的注解@ConditionalOnClass，如果要求的類不存在，則這個(gè)候選類會被過濾不被加載   configurations = filter(configurations, autoConfigurationMetadata);   //廣播事件fireAutoConfigurationImportEvents(configurations, exclusions);   return new AutoConfigurationEntry(configurations, exclusions);}

本質(zhì)上來說，其實(shí)EnableAutoConfiguration會幫助springboot應(yīng)用把所有符合@Configuration配置都加載到當(dāng)前SpringBoot創(chuàng)建的IoC容器，而這里面借助了Spring框架提供的一個(gè)工具類SpringFactoriesLoader的支持。以及用到了Spring提供的條件注解@Conditional，選擇性的針對需要加載的bean進(jìn)行條件過濾

SpringFactoriesLoader

為了給大家補(bǔ)一下基礎(chǔ)，我在這里簡單分析一下SpringFactoriesLoader這個(gè)工具類的使用。它其實(shí)和java中的SPI機(jī)制的原理是一樣的，不過它比SPI更好的點(diǎn)在于不會一次性加載所有的類，而是根據(jù)key進(jìn)行加載。

首先，SpringFactoriesLoader的作用是從classpath/META-INF/spring.factories文件中，根據(jù)key來加載對應(yīng)的類到spring IoC容器中。接下來帶大家實(shí)踐一下

創(chuàng)建外部項(xiàng)目jar

  org.springframework  spring-context  4.3.13.RELEASE

創(chuàng)建bean以及config

public class GuPaoCore {    public String study(){        System.out.println("good good study, day day up");        return "GuPaoEdu.com";    }}@Configurationpublic class GuPaoConfig {    @Bean    public GuPaoCore guPaoCore(){        return new GuPaoCore();    }}

創(chuàng)建另外一個(gè)工程（spring-boot）

把前面的工程打包成jar，當(dāng)前項(xiàng)目依賴該jar包

    com.gupaoedu.practice    Gupao-Core    1.0-SNAPSHOT

通過下面代碼獲取依賴包中的屬性

運(yùn)行結(jié)果會報(bào)錯(cuò)，原因是GuPaoCore并沒有被Spring的IoC容器所加載，也就是沒有被EnableAutoConfiguration導(dǎo)入

@SpringBootApplicationpublic class SpringBootStudyApplication {    public static void main(String[] args) throws IOException {        ConfigurableApplicationContext ac=SpringApplication.run(SpringBootStudyApplication.class, args);        GuPaoCore gpc=ac.getBean(GuPaoCore.class);        System.out.println(gpc.study());    }}

解決方案

在GuPao-Core項(xiàng)目resources下新建文件夾META-INF，在文件夾下面新建spring.factories文件，文件中配置，key為自定配置類EnableAutoConfiguration的全路徑，value是配置類的全路徑

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.gupaoedu.practice.GuPaoConfig

重新打包，重新運(yùn)行SpringBootStudyApplication這個(gè)類。

可以發(fā)現(xiàn)，我們編寫的那個(gè)類，就被加載進(jìn)來了。