springboot自動(dòng)掃描添加的BeanDefinition源碼實(shí)例詳解
1.
springboot啟動(dòng)過程中,首先會(huì)收集需要加載的bean的定義,作為BeanDefinition對(duì)象,添加到BeanFactory中去。
由于BeanFactory中只有g(shù)etBean之類獲取bean對(duì)象的方法,所以將將BeanDefinition添加到BeanFactory中,是通過BeanDefinitionRegistry接口的void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException;方法來(lái)完成的。
所以我們的BeanFactory的實(shí)現(xiàn)類如果需要具備通過beanName來(lái)返回bean對(duì)象和添加刪除BeanDefinition的能力,至少實(shí)現(xiàn)BeanFactory和BeanDefinitionRegistry的這兩個(gè)接口。
這里我們就來(lái)看看springboot是如何查找bean的定義,添加到BeanFactory中的。
由于我們這里只是關(guān)注查找bean對(duì)象的定義,所以這里我們這里提到的BeanFactory主要會(huì)關(guān)注BeanDefinitionRegistry這個(gè)接口。
我們本地主要分析springboot掃描加載bean的配置,和我們的代碼關(guān)系不大,所以我們的代碼就用最簡(jiǎn)單的吧。具體代碼如下:
package com.example.bootargs;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class BootargsApplication {
public static void main(String[] args) {
SpringApplication.run(BootargsApplication.class, args);
}
}
后面提到的主類統(tǒng)一是com.example.bootargs.BootargsApplication
2.
Springboot 查找bean的定義主要是通過ConfigurationClassPostProcessor這個(gè)類來(lái)完成的。
ConfigurationClassPostProcessor實(shí)現(xiàn)了BeanDefinitionRegistryPostProcessor接口。BeanDefinitionRegistryPostProcessor接口就是通過postProcessBeanDefinitionRegistry方法來(lái)給BeanDefinitionRegistry的實(shí)現(xiàn)類來(lái)添加bean的定義。
BeanDefinitionRegistryPostProcessor繼承了BeanFactoryPostProcessor接口,而BeanFactoryPostProcessor接口主要是用來(lái)對(duì)BeanFactory進(jìn)行增強(qiáng)。在springboot啟動(dòng)過程中首先會(huì)創(chuàng)建BeanFactory,再調(diào)用BeanFactoryPostProcessor對(duì)BeanFactory
進(jìn)行增強(qiáng),最后才會(huì)去創(chuàng)建bean對(duì)象。
通過BeanFactoryPostProcessor對(duì)BeanFactory進(jìn)行增強(qiáng),主要是通過PostProcessorRegistrationDelegate的靜態(tài)方法來(lái)完成的。在這過程中就會(huì)調(diào)用到ConfigurationClassPostProcessor這個(gè)類。
由于ConfigurationClassPostProcessor實(shí)現(xiàn)了BeanDefinitionRegistryPostProcessor接口,PostProcessorRegistrationDelegate就會(huì)調(diào)用ConfigurationClassPostProcessor的postProcessBeanDefinitionRegistry方法中,就會(huì)調(diào)用到processConfigBeanDefinitions方法來(lái)查找bean的定義。我們就從這里作為入口來(lái)看吧。

3.
下面我們就去看看ConfigurationClassPostProcessor的processConfigBeanDefinitions方法
/**
* Build and validate a configuration model based on the registry of
* {@link Configuration} classes.
*/
public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
List<BeanDefinitionHolder> configCandidates = new ArrayList<>();
String[] candidateNames = registry.getBeanDefinitionNames();
//在下面的這個(gè)for循環(huán)中,會(huì)從beanFactory中已經(jīng)有的bean的定義中尋找有Configuration注解的配置類。
//默認(rèn)這里獲取到的只有一個(gè)包含SpringBootApplication注解的主類
for (String beanName : candidateNames) {
......
configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));
}
}
//如果沒有找到配置類,就直接返回
// Return immediately if no @Configuration classes were found
if (configCandidates.isEmpty()) {
return;
}
......
//在這里就通過ConfigurationClassParser去解析配置類
// Parse each @Configuration class
ConfigurationClassParser parser = new ConfigurationClassParser(
this.metadataReaderFactory, this.problemReporter, this.environment,
this.resourceLoader, this.componentScanBeanNameGenerator, registry);
Set<BeanDefinitionHolder> candidates = new LinkedHashSet<>(configCandidates);
Set<ConfigurationClass> alreadyParsed = new HashSet<>(configCandidates.size());
do {
StartupStep processConfig = this.applicationStartup.start("spring.context.config-classes.parse");
//所有bean的定義的查找都是在這里完成的。下面我們?nèi)タ纯催@里的parse方法
parser.parse(candidates);
......
}
在ConfigurationClassParser中的parse方法中,由于我們的配置類是通過注解來(lái)定義的,所以會(huì)走AnnotatedBeanDefinition這個(gè)分支。繼續(xù)會(huì)調(diào)用到processConfigurationClass(new ConfigurationClass(metadata, beanName), DEFAULT_EXCLUSION_FILTER);這句,我們就直接進(jìn)到這個(gè)processConfigurationClass方法去看吧。
protected void processConfigurationClass(ConfigurationClass configClass, Predicate<String> filter) throws IOException {
//在這里首先看配置類上是否有Conditional注解,如果有的話,就去解析處理,看看是否要跳過這個(gè)注解類
if (this.conditionEvaluator.shouldSkip(configClass.getMetadata(), ConfigurationPhase.PARSE_CONFIGURATION)) {
return;
}
//所有解析出來(lái)的配置類都要放置到configurationClasses中,key是當(dāng)前解析出來(lái)的配置類,value就是表示這個(gè)配置類是通過誰(shuí)來(lái)導(dǎo)入的。
//如果這個(gè)配置類不是通過別的類來(lái)導(dǎo)入的,這時(shí)key和value就是一樣的。
ConfigurationClass existingClass = this.configurationClasses.get(configClass);
//如果通過多個(gè)配置類導(dǎo)入了同一個(gè)配置類,那么把這個(gè)和配置類的導(dǎo)入關(guān)系就要進(jìn)行一下合并
if (existingClass != null) {
if (configClass.isImported()) {
if (existingClass.isImported()) {
existingClass.mergeImportedBy(configClass);
}
// Otherwise ignore new imported config class; existing non-imported class overrides it.
return;
}
else {
// Explicit bean definition found, probably replacing an import.
// Let's remove the old one and go with the new one.
this.configurationClasses.remove(configClass);
this.knownSuperclasses.values().removeIf(configClass::equals);
}
}
// Recursively process the configuration class and its superclass hierarchy.
//這里是將配置類轉(zhuǎn)化為SourceClass對(duì)象
SourceClass sourceClass = asSourceClass(configClass, filter);
do {
//在這里就會(huì)進(jìn)行真正的配置類的解析出來(lái)。
//注意這里是個(gè)do-while循環(huán),處理完當(dāng)前的配置類,會(huì)繼續(xù)去處理當(dāng)前配置類的父類。
//如果當(dāng)前類的父類類名不是java開頭,且沒有被處理過的話,就會(huì)在這個(gè)do-while循環(huán)中繼續(xù)去處理
sourceClass = doProcessConfigurationClass(configClass, sourceClass, filter);
}
while (sourceClass != null);
this.configurationClasses.put(configClass, configClass);
}
this.conditionEvaluator.shouldSkip(configClass.getMetadata(), ConfigurationPhase.PARSE_CONFIGURATION)這個(gè)的過濾主要是通過org.springframework.context.annotation.Condition接口的子類去實(shí)現(xiàn)matches方法完成的。
舉個(gè)例子簡(jiǎn)單說(shuō)下:
@Configuration(proxyBeanMethods = false) @ConditionalOnMissingBean(name = AbstractApplicationContext.MESSAGE_SOURCE_BEAN_NAME, search = SearchStrategy.CURRENT) @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) @Conditional(ResourceBundleCondition.class) @EnableConfigurationProperties public class MessageSourceAutoConfiguration
上面是MessageSourceAutoConfiguration類的定義,首先會(huì)查找它上面的Conditional注解,會(huì)找到兩個(gè)注解:
@ConditionalOnMissingBean(name = AbstractApplicationContext.MESSAGE_SOURCE_BEAN_NAME, search = SearchStrategy.CURRENT)
由于這個(gè)這個(gè)注解上面有@Conditional(OnBeanCondition.class),所以會(huì)交給OnBeanCondition這個(gè)類去處理。
@Conditional(ResourceBundleCondition.class),則會(huì)交給ResourceBundleCondition這個(gè)類去處理。
processConfigurationClass這個(gè)方法會(huì)有多個(gè)地方,主要會(huì)出現(xiàn)在三個(gè)地方:
- 就是調(diào)用parse方法的時(shí)候會(huì)調(diào)用到這個(gè)processConfigurationClass方法。
- 在doProcessConfigurationClass中解析當(dāng)前配置類的屬性時(shí)也可能會(huì)多次調(diào)用到processConfigurationClass方法。
- 在this.deferredImportSelectorHandler.process()調(diào)用時(shí)也可能會(huì)調(diào)用到processConfigurationClass方法
我們這里解析的所有配置類都添加到都會(huì)調(diào)用到configurationClasses.put(configClass, configClass)方法,所以我們最終有多個(gè)類添加到configurationClasses集合中,就至少有多少次調(diào)用到processConfigurationClass方法(有Conditional注解的判斷,所以調(diào)用次數(shù)可能多于最終添加到configurationClasses集合中元素個(gè)數(shù))
@Nullable
protected final SourceClass doProcessConfigurationClass(
ConfigurationClass configClass, SourceClass sourceClass, Predicate<String> filter)
throws IOException {
//在這里,查看類是否有Component注解,有的話,查找當(dāng)前類的內(nèi)部類,進(jìn)行處理
if (configClass.getMetadata().isAnnotated(Component.class.getName())) {
// Recursively process any member (nested) classes first
//這里就可能會(huì)遞歸調(diào)用到上面的processConfigurationClass方法
processMemberClasses(configClass, sourceClass, filter);
}
// Process any @PropertySource annotations
//在這里,查看類是否有PropertySources注解,有的話去解析屬性配置,添加到環(huán)境上下文中去
for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(
sourceClass.getMetadata(), PropertySources.class,
org.springframework.context.annotation.PropertySource.class)) {
if (this.environment instanceof ConfigurableEnvironment) {
processPropertySource(propertySource);
}
else {
logger.info("Ignoring @PropertySource annotation on [" + sourceClass.getMetadata().getClassName() +
"]. Reason: Environment must implement ConfigurableEnvironment");
}
}
// Process any @ComponentScan annotations
//在這里,查看類是否有ComponentScans注解,有的話,就根據(jù)這里的條件去進(jìn)行目錄掃描,查找bean的定義
//由于我們當(dāng)前的類上有SpringBootApplication注解,所以這里是能夠找到ComponentScan注解的,就會(huì)進(jìn)到這個(gè)方法里面去
Set<AnnotationAttributes> componentScans = AnnotationConfigUtils.attributesForRepeatable(
sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class);
if (!componentScans.isEmpty() &&
!this.conditionEvaluator.shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) {
for (AnnotationAttributes componentScan : componentScans) {
// The config class is annotated with @ComponentScan -> perform the scan immediately
//在這里,就會(huì)去處理ComponentScans注解相關(guān)的內(nèi)容。
//ComponentScans注解上有個(gè)basePackages屬性,用來(lái)指定掃描的包的名字。
//如果沒有指定basePackages屬性,就在當(dāng)前類的包下及其所有子包下去查找相關(guān)的bean的定義。
//我們一般不會(huì)指定basePackages屬性,那么會(huì)在當(dāng)前sourceClass類的包及其所有子包下去查找bean的定義。
//我們自己代碼中定義的controller,service,dao等等都是在這一步獲取到bean的定義的。
Set<BeanDefinitionHolder> scannedBeanDefinitions =
this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());
// Check the set of scanned definitions for any further config classes and parse recursively if needed
for (BeanDefinitionHolder holder : scannedBeanDefinitions) {
BeanDefinition bdCand = holder.getBeanDefinition().getOriginatingBeanDefinition();
if (bdCand == null) {
bdCand = holder.getBeanDefinition();
}
if (ConfigurationClassUtils.checkConfigurationClassCandidate(bdCand, this.metadataReaderFactory)) {
//這里也會(huì)間接調(diào)用到processConfigurationClass方法
parse(bdCand.getBeanClassName(), holder.getBeanName());
}
}
}
}
// Process any @Import annotations
//在這里,就會(huì)去處理類上的import注解。
//getImports(sourceClass)首先會(huì)獲取到import的類。
//這里會(huì)有兩個(gè),一個(gè)是AutoConfigurationPackage上注解的AutoConfigurationPackages.Registrar.class
//另一個(gè)是EnableAutoConfiguration上的注解AutoConfigurationImportSelector.class)
//下面我們?nèi)タ纯磒rocessImports這個(gè)方法
//這里面也可能會(huì)調(diào)用到processConfigurationClass方法
processImports(configClass, sourceClass, getImports(sourceClass), filter, true);
......
}
doProcessConfigurationClass是真正用來(lái)處理配置類的。
在這個(gè)方法中會(huì)依次處理內(nèi)部類、PropertySources注解、ComponentScans注解、Import注解、ImportResource注解、Bean注解、接口上的默認(rèn)方法、繼續(xù)遞歸到它的父類。
其中:
- 內(nèi)部類會(huì)繼續(xù)調(diào)用processConfigurationClass方法遞歸去處理
- PropertySources注解解析后添加到環(huán)境上下文中
- ComponentScans注解掃描到的到的類會(huì)直接被添加到beanFactory中,也會(huì)繼續(xù)調(diào)用processConfigurationClass方法遞歸去處理
- Import注解會(huì)分3種情況處理:
- Import的類如果實(shí)現(xiàn)了ImportSelector。且實(shí)現(xiàn)了它的子接口DeferredImportSelector,則會(huì)添加到deferredImportSelectors中,后續(xù)進(jìn)行處理。如果沒有實(shí)現(xiàn)子接口,就遞歸調(diào)用processImports進(jìn)行處理。
- Import的類如果實(shí)現(xiàn)了ImportBeanDefinitionRegistrar。則添加到當(dāng)前配置類的屬性中,進(jìn)行后續(xù)處理。
- 不屬于上面兩種情況的話,就繼續(xù)遞歸調(diào)用processConfigurationClass進(jìn)行處理。
- ImportResource注解、Bean注解、接口上的默認(rèn)方法這些都會(huì)解析后添加到當(dāng)前配置類的屬性上,后續(xù)進(jìn)行處理
對(duì)下面方法的幾個(gè)入?yún)⒑?jiǎn)單描述下:
- configClass,currentSourceClass這兩個(gè)參數(shù)直接都是指代我們包含SpringBootApplication注解的主類。
其中configClass表示當(dāng)前處理的類是被誰(shuí)導(dǎo)入的,currentSourceClass表示當(dāng)前正在處理的類。這兩者一般底層是同一個(gè)資源類,但是有可能會(huì)有遞歸調(diào)用,這時(shí)兩者就可能會(huì)不同。 - importCandidates是通過import注解導(dǎo)入的類,這里是
AutoConfigurationPackages.Registrar.class和AutoConfigurationImportSelector.class importCandidates就是當(dāng)前被導(dǎo)入的類,也就是在這里被處理的類 - exclusionFilter是在ConfigurationClassParser中定義的,用來(lái)過濾
java.lang.annotation.和org.springframework.stereotype.開頭的注解 - checkForCircularImports表示是否檢查遞歸導(dǎo)入
private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass,
Collection<SourceClass> importCandidates, Predicate<String> exclusionFilter,
boolean checkForCircularImports) {
if (importCandidates.isEmpty()) {
return;
}
//這里是錯(cuò)誤檢查,檢查是否出現(xiàn)了遞歸
if (checkForCircularImports && isChainedImportOnStack(configClass)) {
this.problemReporter.error(new CircularImportProblem(configClass, this.importStack));
}
else {
//先將當(dāng)前的配置類壓入棧
this.importStack.push(configClass);
try {
//這里,就會(huì)對(duì)import標(biāo)簽導(dǎo)入的類進(jìn)行處理
for (SourceClass candidate : importCandidates) {
//AutoConfigurationImportSelector.class類就會(huì)走下面的分支
if (candidate.isAssignable(ImportSelector.class)) {
// Candidate class is an ImportSelector -> delegate to it to determine imports
Class<?> candidateClass = candidate.loadClass();
//首先在這里創(chuàng)建一個(gè)AutoConfigurationImportSelector類的對(duì)象,
ImportSelector selector = ParserStrategyUtils.instantiateClass(candidateClass, ImportSelector.class,
this.environment, this.resourceLoader, this.registry);
Predicate<String> selectorFilter = selector.getExclusionFilter();
if (selectorFilter != null) {
exclusionFilter = exclusionFilter.or(selectorFilter);
}
if (selector instanceof DeferredImportSelector) {
//在這里,將當(dāng)前的配置類和AutoConfigurationImportSelector的對(duì)象封裝成DeferredImportSelectorHolder對(duì)象
//添加到延遲導(dǎo)入的集合deferredImportSelectors中
this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector);
}
else {
String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata());
Collection<SourceClass> importSourceClasses = asSourceClasses(importClassNames, exclusionFilter);
processImports(configClass, currentSourceClass, importSourceClasses, exclusionFilter, false);
}
}
//AutoConfigurationPackages.Registrar.class這個(gè)類就會(huì)走到這個(gè)分支中
//在這個(gè)分支中,首先創(chuàng)建AutoConfigurationPackages.Registrar的對(duì)象
//添加到當(dāng)前配置類的importBeanDefinitionRegistrars屬性中去
else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {
// Candidate class is an ImportBeanDefinitionRegistrar ->
// delegate to it to register additional bean definitions
Class<?> candidateClass = candidate.loadClass();
ImportBeanDefinitionRegistrar registrar =
ParserStrategyUtils.instantiateClass(candidateClass, ImportBeanDefinitionRegistrar.class,
this.environment, this.resourceLoader, this.registry);
configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata());
}
else {
// Candidate class not an ImportSelector or ImportBeanDefinitionRegistrar ->
// process it as an @Configuration class
this.importStack.registerImport(
currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());
processConfigurationClass(candidate.asConfigClass(configClass), exclusionFilter);
}
}
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(
"Failed to process import candidates for configuration class [" +
configClass.getMetadata().getClassName() + "]", ex);
}
finally {
this.importStack.pop();
}
}
}
上面的import導(dǎo)入類處理完了,下面我們繼續(xù)回到doProcessConfigurationClass中去看剩余的部分
@Nullable
protected final SourceClass doProcessConfigurationClass(
ConfigurationClass configClass, SourceClass sourceClass, Predicate<String> filter)
throws IOException {
......//這部分前面已經(jīng)分析過了,我們就繼續(xù)看后面的吧
// Process any @ImportResource annotations
// 這里是處理ImportResource注解
AnnotationAttributes importResource =
AnnotationConfigUtils.attributesFor(sourceClass.getMetadata(), ImportResource.class);
if (importResource != null) {
String[] resources = importResource.getStringArray("locations");
Class<? extends BeanDefinitionReader> readerClass = importResource.getClass("reader");
for (String resource : resources) {
String resolvedResource = this.environment.resolveRequiredPlaceholders(resource);
configClass.addImportedResource(resolvedResource, readerClass);
}
}
// Process individual @Bean methods
//這里是處理配置類內(nèi)部的有Bean注解的方法,添加到配置類的beanMethods屬性中
Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);
for (MethodMetadata methodMetadata : beanMethods) {
configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));
}
// Process default methods on interfaces
//這里處理配置類實(shí)現(xiàn)的接口上默認(rèn)方法上有Bean注解的話,也添加到beanMethods屬性中
processInterfaces(configClass, sourceClass);
// Process superclass, if any
//這里去獲取配置類的父類,如果存在父類且父類類名不是java開頭且還沒有被處理過,就會(huì)返回父類,繼續(xù)進(jìn)行父類的處理。
if (sourceClass.getMetadata().hasSuperClass()) {
String superclass = sourceClass.getMetadata().getSuperClassName();
if (superclass != null && !superclass.startsWith("java") &&
!this.knownSuperclasses.containsKey(superclass)) {
this.knownSuperclasses.put(superclass, configClass);
// Superclass found, return its annotation metadata and recurse
return sourceClass.getSuperClass();
}
}
// No superclass -> processing is complete
return null;
}
到這里processConfigurationClass方法就整個(gè)分析完了。
下面就會(huì)走到parse方法的最后一句了。我們進(jìn)去看看
public void parse(Set<BeanDefinitionHolder> configCandidates) {
......
//就會(huì)走到下面這行代碼
this.deferredImportSelectorHandler.process();
}
這里主要是對(duì)延遲導(dǎo)入的類進(jìn)行處理
public void process() {
//在上面代碼中我們分析到this.deferredImportSelectors中只有一個(gè)
//由前面的配置類和AutoConfigurationImportSelector類的對(duì)象封裝的DeferredImportSelectorHolder對(duì)象
List<DeferredImportSelectorHolder> deferredImports = this.deferredImportSelectors;
this.deferredImportSelectors = null;
try {
if (deferredImports != null) {
DeferredImportSelectorGroupingHandler handler = new DeferredImportSelectorGroupingHandler();
deferredImports.sort(DEFERRED_IMPORT_COMPARATOR);
//這里會(huì)對(duì)延遲導(dǎo)入的類進(jìn)行分組,添加到handler中,由于我們這里只有一個(gè)對(duì)象,所以這塊的分組,我們可以不用太關(guān)注
//同時(shí)會(huì)將前面的配置類添加到handler對(duì)象的configurationClasses屬性中
deferredImports.forEach(handler::register);
//下面就會(huì)交給handler去進(jìn)行處理
handler.processGroupImports();
}
}
finally {
this.deferredImportSelectors = new ArrayList<>();
}
}
}
下面我們看看processGroupImports是如何處理的
public void processGroupImports() {
//這里就按分組去處理了
for (DeferredImportSelectorGrouping grouping : this.groupings.values()) {
Predicate<String> exclusionFilter = grouping.getCandidateFilter();
//這里的grouping.getImports()就回去獲取系統(tǒng)的配置類,我們下面去看這個(gè)getImports
grouping.getImports().forEach(entry -> {
......
}
}
這里的grouping.getCandidateFilter()來(lái)自兩部分:
另一部分是來(lái)自ConfigurationClassParser定義的lambda表達(dá)式

這個(gè)是在ConfigurationClassParser類的一個(gè)靜態(tài)內(nèi)部類DeferredImportSelectorGrouping中的方法
public Iterable<Group.Entry> getImports() {
//這里的deferredImports中只有一個(gè)對(duì)象,還是之前的DeferredImportSelectorHolder
for (DeferredImportSelectorHolder deferredImport : this.deferredImports) {
//這里的this.group就是之前分組的deferredImport.getImportSelector().getImportGroup();方法的返回值創(chuàng)建的對(duì)象
//具體就是AutoConfigurationImportSelector.AutoConfigurationGroup的對(duì)象
//下面我們先看看這個(gè)process方法
this.group.process(deferredImport.getConfigurationClass().getMetadata(),
deferredImport.getImportSelector());
}
return this.group.selectImports();
}
process是在AutoConfigurationImportSelector.AutoConfigurationGroup這個(gè)類中
public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
Assert.state(deferredImportSelector instanceof AutoConfigurationImportSelector,
() -> String.format("Only %s implementations are supported, got %s",
AutoConfigurationImportSelector.class.getSimpleName(),
deferredImportSelector.getClass().getName()));
//下面這行代碼也比較重要,我們進(jìn)去看看
AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
.getAutoConfigurationEntry(annotationMetadata);
this.autoConfigurationEntries.add(autoConfigurationEntry);
for (String importClassName : autoConfigurationEntry.getConfigurations()) {
this.entries.putIfAbsent(importClassName, annotationMetadata);
}
}
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
//這里,我們就能看到設(shè)置spring.boot.enableautoconfiguration屬性去禁止導(dǎo)入系統(tǒng)配置的bean的定義
if (!isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
AnnotationAttributes attributes = getAttributes(annotationMetadata);
//在下面這行中,就能看到通過ClassLoader去加載META-INF/spring.factories文件,讀取內(nèi)容。放置到cache中
//在當(dāng)前這里,會(huì)去獲取key=org.springframework.boot.autoconfigure.EnableAutoConfiguration的所有屬性配置
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
//在這里獲取配置過濾類并創(chuàng)建對(duì)象,對(duì)上面的configuras進(jìn)行過濾
//這里的配置過濾類也是從cache中獲取,key=org.springframework.boot.autoconfigure.AutoConfigurationImportFilter
configurations = getConfigurationClassFilter().filter(configurations);
//這行代碼不關(guān)鍵,我們可以不用去關(guān)注
fireAutoConfigurationImportEvents(configurations, exclusions);
//這里返回一個(gè)AutoConfigurationEntry對(duì)象
//其中configurations是過濾器能夠匹配到的配置類,exclusions在我們這里是空的
return new AutoConfigurationEntry(configurations, exclusions);
}
上面代碼中g(shù)etConfigurationClassFilter()獲取到的是:
是來(lái)自spring.factories文件中的org.springframework.boot.autoconfigure.AutoConfigurationImportFilter

org.springframework.boot.autoconfigure.condition.OnClassCondition
這個(gè)類主要檢查是否存在指定的類
org.springframework.boot.autoconfigure.condition.OnWebApplicationCondition
這個(gè)類主要檢查是否存在WebApplicationContext.
org.springframework.boot.autoconfigure.condition.OnBeanCondition
這個(gè)類主要檢查是否存在指定的bean
在這個(gè)過程中,在生成filter過程中,首先會(huì)通過類加載器去讀取META-INF/spring-autoconfigure-metadata.properties這些文件。

在這里,主要是通過類名.ConditionalOnBean、類名.ConditionalOnSingleCandidate、類名.ConditionalOnClass、類名.ConditionalOnWebApplication來(lái)過濾掉不符合的配置類。
具體的算法入口都在這3個(gè)類的父類FilteringSpringBootCondition的match方法,具體的實(shí)現(xiàn)入口分別在這3個(gè)類的getOutcomes方法中。
由于這3個(gè)類都是實(shí)現(xiàn)了Condition接口,因此前面分析的 processConfigurationClass方法開始的地方通過 Conditional注解過濾配置類也會(huì)用到這3個(gè)類。
從上面也可以看出springboot的按需加載主要也是通過實(shí)現(xiàn)Condition接口來(lái)完成的。
再回到process這個(gè)方法。
public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
......//上面的代碼剛才已經(jīng)分析過了
//在這里將上面返回的AutoConfigurationEntry對(duì)象添加到autoConfigurationEntries中
this.autoConfigurationEntries.add(autoConfigurationEntry);
for (String importClassName : autoConfigurationEntry.getConfigurations()) {
//分別將添加的配置類添加到entries這個(gè)屬性中
//importClassName是新查找到的配置類,annotationMetadata都是同一個(gè)就是我們的主類
this.entries.putIfAbsent(importClassName, annotationMetadata);
}
}
在接下來(lái)的selectImports方法中,首先會(huì)對(duì)這些新添加的配置類進(jìn)行排序,然后組裝成new Entry(this.entries.get(importClassName), importClassName))對(duì)象的集合。
這里需要注意的是this.entries.get(importClassName)這就是我們的主類,importClassName是我們需要添加的配置類。
這里主要是為了對(duì)當(dāng)前導(dǎo)入的配置類和它是被誰(shuí)導(dǎo)入的進(jìn)行一個(gè)關(guān)聯(lián)(在這里,所有要導(dǎo)入的配置類都是由我們的主類來(lái)導(dǎo)入的)。
就是在后面創(chuàng)建ConfigurationClass對(duì)象時(shí)會(huì)使用public ConfigurationClass(MetadataReader metadataReader, @Nullable ConfigurationClass importedBy)這個(gè)構(gòu)造方法。
最后在添加這些配置類到beanFactory中時(shí)通過
下面再回到processGroupImports方法
public void processGroupImports() {
for (DeferredImportSelectorGrouping grouping : this.groupings.values()) {
Predicate<String> exclusionFilter = grouping.getCandidateFilter();
//上面已經(jīng)分析到grouping.getImports()返回的是Entry對(duì)象的集合
grouping.getImports().forEach(entry -> {
//entry.getMetadata()返回的還是我們之前的主類。
//這里的configurationClass也是我們之前的主類。
//這個(gè)主要是為了在processImports方法中創(chuàng)建的配置類為它們?cè)O(shè)置importedBy屬性
ConfigurationClass configurationClass = this.configurationClasses.get(entry.getMetadata());
try {
//這里又會(huì)調(diào)用到processImports這個(gè)方法。這個(gè)在前面已經(jīng)分析過了,但是這里有一點(diǎn)不一樣,下面我們看看不一樣的地方
processImports(configurationClass, asSourceClass(configurationClass, exclusionFilter),
Collections.singleton(asSourceClass(entry.getImportClassName(), exclusionFilter)),
exclusionFilter, false);
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(
"Failed to process import candidates for configuration class [" +
configurationClass.getMetadata().getClassName() + "]", ex);
}
});
}
}
關(guān)于這個(gè)processImports方法的參數(shù)前面有描述,這里就不再說(shuō)了
下面的這個(gè)方法中這時(shí)importCandidates和之前的有點(diǎn)不一樣,之前的是通過import注解導(dǎo)入的分別會(huì)走for循環(huán)的前面兩個(gè)分支,現(xiàn)在大概率會(huì)走到后面的else分支
private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass,
Collection<SourceClass> importCandidates, Predicate<String> exclusionFilter,
boolean checkForCircularImports) {
this.importStack.push(configClass);
try {
for (SourceClass candidate : importCandidates) {
if (candidate.isAssignable(ImportSelector.class)) {
......
}
else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {
......
}
else {
// Candidate class not an ImportSelector or ImportBeanDefinitionRegistrar ->
// process it as an @Configuration class
//上次進(jìn)入這個(gè)方法,分別走了上面的兩個(gè)分支,現(xiàn)在大概率會(huì)走到這個(gè)分支
//這里會(huì)將導(dǎo)入的類添加到imports屬性中,key是新導(dǎo)入的配置類,value是我們之前的主類
this.importStack.registerImport(
currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());
//這里又會(huì)去處理新添加的配置類,在這里是有可能出現(xiàn)遞歸的,下面我們具體分析下這里的處理邏輯
processConfigurationClass(candidate.asConfigClass(configClass), exclusionFilter);
}
}
}
......
}
}
在上面的processImports方法中,會(huì)處理新添加的配置類,會(huì)調(diào)用到processConfigurationClass這個(gè)方法。
到上面為止,ConfigurationClassPostProcessor的processConfigBeanDefinitions方法從parse處理的部分就全部分析完了 。
這部分主要是處理了通過主類上面的注解,將所有的配置類都添加到ConfigurationClassParser類的成員變量configurationClasses中。對(duì)于配置類上的ImportResource、Bean等等則添加配置類的對(duì)應(yīng)的屬性上。
這里需要注意的是在整個(gè)整個(gè)過程中只有ComponentScans掃描到的配置類會(huì)添加到beanFactory中。
下面我們繼續(xù)看看后面的代碼。
public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
......
do {
StartupStep processConfig = this.applicationStartup.start("spring.context.config-classes.parse");
parser.parse(candidates);//前面已經(jīng)分析到了這里
parser.validate();
//這里就會(huì)得到所有的配置類
Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses());
//alreadyParsed第一次是空的,由于這個(gè)方法是do-while循環(huán),在后面會(huì)對(duì)這個(gè)變量賦值
configClasses.removeAll(alreadyParsed);
// Read the model and create bean definitions based on its content
if (this.reader == null) {
this.reader = new ConfigurationClassBeanDefinitionReader(
registry, this.sourceExtractor, this.resourceLoader, this.environment,
this.importBeanNameGenerator, parser.getImportRegistry());
}
//在這里就會(huì)對(duì)前面獲取的所有的配置類添加到beanFactory中
this.reader.loadBeanDefinitions(configClasses);
alreadyParsed.addAll(configClasses);
processConfig.tag("classCount", () -> String.valueOf(configClasses.size())).end();
candidates.clear();
//這里就是對(duì)比前后beanFactory中的beanDefinition數(shù)量是否有增加,如果有增加說(shuō)明我們?cè)诒敬蝑o-while代碼中添加了beanFactory
//下面的邏輯主要是為了判斷當(dāng)前掃描出來(lái)的配置類是否全部添加進(jìn)了beanFactory中,如果有配置類還沒有被今天進(jìn)去,就會(huì)循環(huán),重新執(zhí)行上面的邏輯
if (registry.getBeanDefinitionCount() > candidateNames.length) {
String[] newCandidateNames = registry.getBeanDefinitionNames();
Set<String> oldCandidateNames = new HashSet<>(Arrays.asList(candidateNames));
Set<String> alreadyParsedClasses = new HashSet<>();
for (ConfigurationClass configurationClass : alreadyParsed) {
alreadyParsedClasses.add(configurationClass.getMetadata().getClassName());
}
for (String candidateName : newCandidateNames) {
if (!oldCandidateNames.contains(candidateName)) {
BeanDefinition bd = registry.getBeanDefinition(candidateName);
if (ConfigurationClassUtils.checkConfigurationClassCandidate(bd, this.metadataReaderFactory) &&
!alreadyParsedClasses.contains(bd.getBeanClassName())) {
candidates.add(new BeanDefinitionHolder(bd, candidateName));
}
}
}
candidateNames = newCandidateNames;
}
}
while (!candidates.isEmpty());
// Register the ImportRegistry as a bean in order to support ImportAware @Configuration classes
if (sbr != null && !sbr.containsSingleton(IMPORT_REGISTRY_BEAN_NAME)) {
sbr.registerSingleton(IMPORT_REGISTRY_BEAN_NAME, parser.getImportRegistry());
}
if (this.metadataReaderFactory instanceof CachingMetadataReaderFactory) {
// Clear cache in externally provided MetadataReaderFactory; this is a no-op
// for a shared cache since it'll be cleared by the ApplicationContext.
((CachingMetadataReaderFactory) this.metadataReaderFactory).clearCache();
}
}
上面的其他代碼都比較簡(jiǎn)單,我們下面主要對(duì)上面的this.reader.loadBeanDefinitions(configClasses);做個(gè)簡(jiǎn)單分析吧。
ConfigurationClassBeanDefinitionReader的方法
public void loadBeanDefinitions(Set<ConfigurationClass> configurationModel) {
//這個(gè)類還是用來(lái)對(duì)Conditional注解進(jìn)行處理,來(lái)判斷當(dāng)前配置類是否要被過濾掉
TrackedConditionEvaluator trackedConditionEvaluator = new TrackedConditionEvaluator();
for (ConfigurationClass configClass : configurationModel) {
//在這里會(huì)對(duì)每個(gè)配置類及它的屬性進(jìn)行處理,封裝成beanDefinition添加到beanFactory中去
loadBeanDefinitionsForConfigurationClass(configClass, trackedConditionEvaluator);
}
}
private void loadBeanDefinitionsForConfigurationClass(
ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) {
//這里就會(huì)對(duì)Conditional注解進(jìn)行判斷,如果當(dāng)前類是被導(dǎo)入的,就會(huì)去判斷導(dǎo)入它的類
if (trackedConditionEvaluator.shouldSkip(configClass)) {
String beanName = configClass.getBeanName();
if (StringUtils.hasLength(beanName) && this.registry.containsBeanDefinition(beanName)) {
this.registry.removeBeanDefinition(beanName);
}
this.importRegistry.removeImportingClass(configClass.getMetadata().getClassName());
return;
}
//如果類是被導(dǎo)入的,就會(huì)去對(duì)它進(jìn)行處理
if (configClass.isImported()) {
registerBeanDefinitionForImportedConfigurationClass(configClass);
}
//下面就是對(duì)配置類的各種屬性進(jìn)行處理
//處理方法上的bean注解
for (BeanMethod beanMethod : configClass.getBeanMethods()) {
loadBeanDefinitionsForBeanMethod(beanMethod);
}
//處理導(dǎo)入的資源
loadBeanDefinitionsFromImportedResources(configClass.getImportedResources());
//處理導(dǎo)入的ImportBeanDefinitionRegistrar
loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars());
}
在上面的代碼也可以看到,單純的配置類,如果configClass.isImported()返回false,就不會(huì)被添加到beanFactory中。也就是如果配置類不是被導(dǎo)入的,就不會(huì)將配置類添加到beanFactory中。
前面說(shuō)過ComponentScans掃描到的類在處理過程中就被添加到了beanFactory中,其他的配置類都是在上面的方法中被添加進(jìn)去的。
所有添加的類大致可以分為兩部分:
通過類上的注解,直接被添加到配置類中。這部分配置類它們的被導(dǎo)入類就是當(dāng)前的主類。另一部分是通過主類上的@Import(AutoConfigurationImportSelector.class)注解,讀取META-INF/spring.factories文件,經(jīng)過META-INF/spring-autoconfigure-metadata.properties文件過濾后被處理的類。
上面兩部分處理的時(shí)候都會(huì)進(jìn)行遞歸,一層一層處理。而且所有的處理過程中也都會(huì)根據(jù) Conditional注解進(jìn)行過濾。
同時(shí)也需要注意雖然添加到beanFactory中的都是beanD,但是具體都是不一樣的。比如:
ScannedGenericBeanDefinition是通過ComponentScans注解添加的
ConfigurationClassBeanDefinition是處理方法上的bean注解添加的
AnnotatedGenericBeanDefinition是其他普通的配置類
到上面,整個(gè)分析就結(jié)束了。
整個(gè)過程涉及到的各種遞歸調(diào)用等等都比較多,為了不至于文章顯的太分散,上面分析過程中對(duì)很多細(xì)節(jié)也都進(jìn)行了省略。
由于個(gè)人能力問題,上面的分析可能存在錯(cuò)誤或者描述不清晰的地方,歡迎大家評(píng)論指正。
總結(jié)
到此這篇關(guān)于springboot自動(dòng)掃描添加BeanDefinition源碼詳解的文章就介紹到這了,更多相關(guān)springboot自動(dòng)掃描添加BeanDefinition內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring5新特性之Reactive響應(yīng)式編程
這篇文章主要介紹了Spring5新特性之Reactive響應(yīng)式編程,響應(yīng)式編程是一種編程范式,通用和專注于數(shù)據(jù)流和變化的,并且是異步的,下文更多詳細(xì)內(nèi)容,需要的小伙伴可以參考一下,希望對(duì)你有所幫助2022-03-03
java中的阻塞隊(duì)列應(yīng)用場(chǎng)景及代碼實(shí)例
這篇文章主要介紹了java中的阻塞隊(duì)列應(yīng)用場(chǎng)景及代碼實(shí)例阻塞隊(duì)列是一種特殊的隊(duì)列,它提供了線程安全的操作,并在隊(duì)列為空或滿時(shí)提供了阻塞的功能,阻塞隊(duì)列通常用于多線程場(chǎng)景,其中生產(chǎn)者線程向隊(duì)列中添加元素,而消費(fèi)者線程從隊(duì)列中獲取元素,需要的朋友可以參考下2024-01-01
java文件的重命名與移動(dòng)操作實(shí)例代碼
這篇文章主要介紹了java文件的重命名與移動(dòng)操作實(shí)例代碼,具有一定借鑒價(jià)值,需要的朋友可以參考下2017-12-12
bool當(dāng)成函數(shù)參數(shù)錯(cuò)誤理解
經(jīng)常會(huì)在函數(shù)的參數(shù)里使用bool參數(shù),這會(huì)大大地降低代碼的可讀性2012-11-11
如何在Spring Boot啟動(dòng)時(shí)運(yùn)行定制的代碼
在本文中您將學(xué)習(xí)如何掛鉤應(yīng)用程序引導(dǎo)程序生命周期并在Spring Boot啟動(dòng)時(shí)執(zhí)行代碼。文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-12-12
java swing標(biāo)準(zhǔn)對(duì)話框具體實(shí)現(xiàn)
這篇文章介紹了swing標(biāo)準(zhǔn)對(duì)話框的具體實(shí)現(xiàn)方法,有需要的朋友可以參考一下2013-06-06
Java技術(shù)長(zhǎng)久占居主要地位的12個(gè)原因
這篇文章主要為大家詳細(xì)介紹了12個(gè)Java長(zhǎng)久占居主要地位的原因,感興趣的小伙伴們可以參考一下2016-07-07

