從源碼中理解Spring Boot自動裝配原理

2022 年 9 月 15 日
筆記
Spring Boot

個人部落格：槿蘇的知識鋪

一、什麼是自動裝配

SpringBoot 定義了一套介面規範，這套規範規定：SpringBoot在啟動時會掃描外部引用jar包中的META-INF/spring.factories文件，將文件中配置的類型資訊載入到Spring容器，並執行類中定義的各種操作。對於外部jar包來說，只需要按照SpringBoot定義的標準，就能將自己的功能裝配到SpringBoot中。

二、自動裝配的實現原理

自動裝配的實現，離不開SpringBootApplication這個核心註解。查看這個註解的源碼，我們會發現在SpringBootApplication註解上，存在著幾個註解，其中SpringBootConfiguration、EnableAutoConfiguration、ComponentScan這三個註解是需要我們注意的。

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
	...
}

(1) ComponentScan

掃描被@Component 、@Service註解的bean，該註解默認會掃描啟動類所在的包下所有的類，可以自定義不掃描某些 bean。如SpringBootApplication註解源碼所示，容器中將排除TypeExcludeFilterh和AutoConfigurationExcludeFilter。

(2) EnableAutoConfiguration

啟用 SpringBoot 的自動配置機制

(3) Configuration

允許在上下文中註冊額外的 bean 或導入其他配置類

2.1 EnableAutoConfiguration詳解

@EnableAutoConfiguration是實現自動裝配的重要註解，在這個註解上存在以下兩個註解：AutoConfigurationPackage、Import。

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

2.1.1 AutoConfigurationPackage

表示對於標註該註解的類的包，應當使用AutoConfigurationPackages註冊。實質上，它負責保存標註相關註解的類的所在包路徑。使用一個BasePackage類，保存這個路徑。然後使用@Import註解將其注入到ioc容器中。這樣，可以在容器中拿到該路徑。

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
	@Override
	public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
		register(registry, new PackageImport(metadata).getPackageName());
	}
}

查看AutoConfigurationPackages中的Registrar這個類的源碼，在Registrar#registerBeanDefinitions方法中有這樣一句程式碼new PackageImport(metadata).getPackageName()，查看PackageImport的構造器後不難發現，這裡獲取的是StandardAnnotationMetadata這個實例所在的包名。

/**
 * metadata: 實際上是 StandardAnnotationMetadata 實例。
 * metadata#getClassName(): 獲取標註 @AutoConfigurationPackage 註解的類的全限定名。
 * ClassUtils.getPackageName(…): 獲取其所在包。
 */
PackageImport(AnnotationMetadata metadata) {
	this.packageName = ClassUtils.getPackageName(metadata.getClassName());
}

此時再回去看Registrar#registerBeanDefinitions中調用的AutoConfigurationPackages#register方法

public static void register(BeanDefinitionRegistry registry, String... packageNames) {
	// BEAN：AutoConfigurationPackages類的全限定名
	// 此時判斷BeanDefinitionRegistry中是否存在以BEAN作為beanName的BeanDefinition對象
	// 如果不存在，走else方法，構造了一個BackPackages實例，進行註冊
	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);
		registry.registerBeanDefinition(BEAN, beanDefinition);
	}
}

2.1.2 Import(AutoConfigurationImportSelector.class)

它是利用AutoConfigurationImportSelector機制再來給容器中批量導入一些配置東西的，接下來帶大家了解究竟導入了哪些內容。

/**
 * AutoConfigurationImportSelector類中存在一個叫selectImports的方法，就是我們到底要向容器中導入哪些
 * 內容，都會在這裡進行掃描並導入。
 */
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
    // 判斷EnableAutoConfiguration是否開啟默認開啟true
    if (!isEnabled(annotationMetadata)) {
        return NO_IMPORTS;
    }
    // 1.載入META-INF/spring-autoconfigure-metadata.properties 文件
    // 2.從中獲取所有符合條件的支援自動裝配的類
    // 自動配置類全名.條件=條件的值
    AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
        .loadMetadata(this.beanClassLoader);
    // 獲取AutoConfigurationEntry
    AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,annotationMetadata);
    return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}

接下來重點看getAutoConfigurationEntry(annotationMetadata)方法，利用這個方法向容器中批量導入一些默認支援自動配置的類，當你理解了這部分內容之後，就基本了解了Spring Boot是如何進行自動裝配的，廢話不多說，讓我們進入正題。

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    // 判斷EnableAutoConfiguration是否開啟默認開啟true
    if (!isEnabled(annotationMetadata)) {
        return EMPTY_ENTRY;
    }
    // 獲取註解屬性
    AnnotationAttributes attributes = getAttributes(annotationMetadata);
    // 調用getCandidateConfigurations(annotationMetadata, attributes)，利用loadSpringFactories(ClassLoader classLoader)載入當前系統所有的META-INF/spring.factories文件，得到默認支援的自動配置的類的列表
    List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
    // 去除重複的 configuration
    configurations = removeDuplicates(configurations);
    // 獲取到SpringBootApplication上exclude和excludeName配置的需要排除的類
    Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    // 檢查configurations是否含有exclusions中的類
    checkExcludedClasses(configurations, exclusions);
    // 將exclusions中的類從configurations中排除
    configurations.removeAll(exclusions);
    // 對所有候選的自動配置類進行篩選，
    // 比如ConditionalOnProperty  當屬性存在時
    // ConditionalOnClass  當class存在
    // ConditionalOnMissingClass  當這個clas不存在時才去配置
    // 過濾器
    configurations = getConfigurationClassFilter().filter(configurations);
    // 將自動配置的類，導入事件監聽器，並觸發fireAutoConfigurationImportEvents事件
	// 載入META-INF\spring.factories中的AutoConfigurationImportListener 
    fireAutoConfigurationImportEvents(configurations, exclusions);
    // 創建AutoConfigurationEntry對象
    return new AutoConfigurationEntry(configurations, exclusions);
}

Tags: Spring Boot