SpringBoot中的自動配置原理詳解

更新時間：2024年01月09日 10:08:54 作者：玄月沐影

這篇文章主要介紹了SpringBoot中的自動配置原理詳解,springboot的自動配置類直觀的表現(xiàn)就是通過一系列的注解,使得springboot項目在啟動的時候從配置文件中加載需要自動配置的類,注入容器中,需要的朋友可以參考下

引言

springboot的自動配置類直觀的表現(xiàn)就是：通過一系列的注解，使得springboot項目在啟動的時候從配置文件中加載需要自動配置的類。

如果該配置類有引入相關(guān)的jar的文件的時候，springboot便會讓對應(yīng)的類實例化，注入容器中。

即做到在沒有任何配置的情況下就可直接使用。當沒有引入對應(yīng)的jar文件的時候springboot便不會自動實例化配置類。

@SpringBootApplication原理

要想理解其中的原因核心便是圍繞一個注解@SpringBootApplication

@SpringBootApplication注解

直接上源碼：

@Target(ElementType.TYPE)//表示@SpringBootApplication的使用位置，表示用在類上
//1.CONSTRUCTOR:用于描述構(gòu)造器
//2.FIELD:用于描述域
//3.LOCAL_VARIABLE:用于描述局部變量
//4.METHOD:用于描述方法
//5.PACKAGE:用于描述包
//6.PARAMETER:用于描述參數(shù)
//7.TYPE:用于描述類、接口(包括注解類型) 或enum聲明
@Retention(RetentionPolicy.RUNTIME)//表示@SpringBootApplication的存在階段。
//1.RetentionPolicy.SOURCE —— 這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略
//2.RetentionPolicy.CLASS —— 這種類型的Annotations編譯時被保留,在class文件中存在,但JVM將 會忽略
//3.RetentionPolicy.RUNTIME —— 這種類型的Annotations將被JVM保留,所以他們能在運行時被JVM或其他使用反射機制的代碼所讀取和使用.
@Documented// “文檔” 注解表明這個注解應(yīng)該被 javadoc工具記錄
@Inherited//“繼承” 修飾@SpringBootApplication后，那么@SpringBootApplication用在哪個類上，且該類有子類的話，子類是可以繼承父類中的@SpringBootApplication
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

可以看到其是一個復(fù)合注解前面的幾個是元注解并不是核心自動配置的原因重點在@SpringBootConfiguration,@EnableAutoConfiguration,@ComponentScan這三個注解。

@SpringBootConfiguration注解

源碼：

@Configuration
public @interface SpringBootConfiguration {...}

再一層

@Configuration注解

@Component
public @interface Configuration {...}

可以看到本質(zhì)是個@Component，這個注解很熟悉了吧，再SSM階段直接在spring的xml配置<context:component-scan /> 或者 @ComponentScan，容器啟動的時候會掃描所有含有@Component的類，通過反射機制將類的信息加載到內(nèi)存中給IOC使用。

補充@Configuration的使用

1.@Configuration告訴springboot其修飾的類是一個配置類

@Configuration和@Bean聯(lián)合使用其等價<bean id='xxx' class='xxx.xxx'>。。。</bean>

@Configuration
public class Configuration {
    // 任何標志了@Bean的方法，其返回值將作為一個bean注冊到Spring的IOC容器中
    // 方法名默認成為該bean定義的id
    @Bean
    public UserBean user() {
        return new UserBean();
    }
}

故再退一步@SpringBootConfiguration注解會標注一個類是javaConfig,在spring或者springboot啟動的時候會被掃描。

可以根據(jù)@Bean注解實例化對象，作用等于在spring的xml文中定義一個< bean > < /bean> 。

@EnableAutoConfiguration注解

@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {...}

@Import(EnableAutoConfigurationImportSelector.class)

可以看到其使用了@Import注解:本質(zhì)是為了引入類EnableAutoConfigurationImportSelector類，進入其父類AutoConfigurationImportSelector的selectImports()方法，核心代碼如下：

// 從配置文件"META-INF/spring-autoconfigure-metadata.properties"中加載 AutoConfigurationMetadata
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
    .loadMetadata(this.beanClassLoader);
//從注解中加載exclude和excludeName
AnnotationAttributes attributes = getAttributes(annotationMetadata);
//從所有jar包下的/META-INF/spring.factories的文件中獲取到候選的自動配置類
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);//重中之重
configurations = removeDuplicates(configurations);
configurations = sort(configurations, autoConfigurationMetadata);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = filter(configurations, autoConfigurationMetadata);
fireAutoConfigurationImportEvents(configurations, exclusions);
return configurations.toArray(new String[configurations.size()]);

在這里插入圖片描述

關(guān)于META-INF/spring.factories其再spring-boot-autoconfigure-1.5.9.RELEASE.jar下

在這里插入圖片描述

@AutoConfigurationPackage注解

@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {}

@Import(AutoConfigurationPackages.Registrar.class)

它通過將Registrar類導(dǎo)入到容器中，而Registrar類作用是掃描主配置類同級目錄以及子包，并將相應(yīng)的組件導(dǎo)入到springboot創(chuàng)建管理的容器中；

我們實際上將我們自己的包下的組件注入容器依賴的還是@AutoConfigurationPackage注解

public static void register(BeanDefinitionRegistry registry, String... packageNames) {
		if (registry.containsBeanDefinition(BEAN)) {
			BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN);
			ConstructorArgumentValues constructorArguments = beanDefinition
					.getConstructorArgumentValues();
			constructorArguments.addIndexedArgumentValue(0,
					addBasePackages(constructorArguments, packageNames));
		}
		else {
			GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
			beanDefinition.setBeanClass(BasePackages.class);
			beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0,
					packageNames);
			beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
            //ioc
			registry.registerBeanDefinition(BEAN, beanDefinition);
		}
	}

去調(diào)用DefaultListableBeanFactory.java里的registerBeanDefinition()方法

// Cannot modify startup-time collection elements anymore (for stable iteration)
//無法再修改啟動時集合元素（用于穩(wěn)定的迭代）
synchronized (this.beanDefinitionMap) {
this.beanDefinitionMap.put(beanName, beanDefinition);
    。。。。。
}

將已經(jīng)創(chuàng)建好的Bean對象注入beanDefinitionMap中

在這里插入圖片描述

@ComponentScan注解

是暫時將這些符合類型的組件先排除。

@ComponentScan(excludeFilters = {
      @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
      @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

basePackages、value：指定掃描路徑，如果為空則以@ComponentScan注解的類所在的包為基本的掃描路徑 basePackageClasses：指定具體掃描的類 includeFilters：指定滿足Filter條件的類 excludeFilters：指定排除Filter條件的類

注意：@ComponentScan是可以指定包的掃描, 但是在@SpringBootApplication這個注解里的@ComponentScan是用來排除主鍵的。