代码使用springboot测试
1.ConfigurationClassPostProcessor
明确:这是一个BeanFactoryPostProcessor,主要处理beanDefinition
构造context时会创建reader。
构造reader时会创建processor。
最关键是第一个,类型是ConfigurationClassPostProcessor。
AbstractApplicationContext类的refresh方法的invokeBeanFactoryPostProcessors方法会调用PostProcessorRegistrationDelegate类的invokeBeanFactoryPostProcessors方法
这个方法会从beanDefinitions中拿到ConfigurationClassPostProcessor,然后进行实例化,然后执行它,执行它的目的就是注册其他的beanDefinition,例如有component注解的类
public static void invokeBeanFactoryPostProcessors(
ConfigurableListableBeanFactory beanFactory, List<BeanFactoryPostProcessor> beanFactoryPostProcessors) {
// Invoke BeanDefinitionRegistryPostProcessors first, if any.
Set<String> processedBeans = new HashSet<>();
if (beanFactory instanceof BeanDefinitionRegistry) {
BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory;
List<BeanFactoryPostProcessor> regularPostProcessors = new ArrayList<>();
List<BeanDefinitionRegistryPostProcessor> registryProcessors = new ArrayList<>();
for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) {
if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) {
BeanDefinitionRegistryPostProcessor registryProcessor =
(BeanDefinitionRegistryPostProcessor) postProcessor;
registryProcessor.postProcessBeanDefinitionRegistry(registry);
registryProcessors.add(registryProcessor);
}
else {
regularPostProcessors.add(postProcessor);
}
}
// Do not initialize FactoryBeans here: We need to leave all regular beans
// uninitialized to let the bean factory post-processors apply to them!
// Separate between BeanDefinitionRegistryPostProcessors that implement
// PriorityOrdered, Ordered, and the rest.
List<BeanDefinitionRegistryPostProcessor> currentRegistryProcessors = new ArrayList<>();
// First, invoke the BeanDefinitionRegistryPostProcessors that implement PriorityOrdered.
//关键1 这里会拿到而且只能拿到上面标题1的ConfigurationClassPostProcessor
//为什么能拿到? 因为ConfigurationClassPostProcessor实现了BeanDefinitionRegistryPostProcessor接口
String[] postProcessorNames =
beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
//遍历 其实就一个
for (String ppName : postProcessorNames) {
if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
//通过名字实例化ConfigurationClassPostProcessor,添加到currentRegistryProcessors这个list中
currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
processedBeans.add(ppName);
}
}
sortPostProcessors(currentRegistryProcessors, beanFactory);
registryProcessors.addAll(currentRegistryProcessors);
//关键方法 执行上面实例化的ConfigurationClassPostProcessor
invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);
currentRegistryProcessors.clear();
// Next, invoke the BeanDefinitionRegistryPostProcessors that implement Ordered.
//关键2 和关键1相同的步骤 关键1中已经导入了一部分beanDefinition 所以这里再重新获取一次
//可能会获取到别的实现了BeanDefinitionRegistryPostProcessor接口的类
//这里如果用了mybatis 则会获取到MapperScannerConfigurer,因为它实现了BeanDefinitionRegistryPostProcessor接口
postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
for (String ppName : postProcessorNames) {
//这里判断关键1中已经获取的就不要了 还有一个条件是ordered MapperScannerConfigurer不会通过判断 所以继续向下执行
if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) {
currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
processedBeans.add(ppName);
}
}
sortPostProcessors(currentRegistryProcessors, beanFactory);
registryProcessors.addAll(currentRegistryProcessors);
invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);
currentRegistryProcessors.clear();
// Finally, invoke all other BeanDefinitionRegistryPostProcessors until no further ones appear.
boolean reiterate = true;
while (reiterate) {
reiterate = false;
//关键3 这里再获取一次 还是关键2中获取的那两个
postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);
for (String ppName : postProcessorNames) {
//这里只会排除关键1中获取的ConfigurationClassPostProcessor
//少了ordered的判断条件 所以MapperScannerConfigurer会通过判断
if (!processedBeans.contains(ppName)) {
currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));
processedBeans.add(ppName);
reiterate = true;
}
}
sortPostProcessors(currentRegistryProcessors, beanFactory);
registryProcessors.addAll(currentRegistryProcessors);
//执行MapperScannerConfigurer 获取mapper接口的beanDefinition
invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);
currentRegistryProcessors.clear();
}
// Now, invoke the postProcessBeanFactory callback of all processors handled so far.
invokeBeanFactoryPostProcessors(registryProcessors, beanFactory);
invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory);
}
else {
// Invoke factory processors registered with the context instance.
invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory);
}
// Do not initialize FactoryBeans here: We need to leave all regular beans
// uninitialized to let the bean factory post-processors apply to them!
String[] postProcessorNames =
beanFactory.getBeanNamesForType(BeanFactoryPostProcessor.class, true, false);
// Separate between BeanFactoryPostProcessors that implement PriorityOrdered,
// Ordered, and the rest.
List<BeanFactoryPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
List<String> orderedPostProcessorNames = new ArrayList<>();
List<String> nonOrderedPostProcessorNames = new ArrayList<>();
for (String ppName : postProcessorNames) {
if (processedBeans.contains(ppName)) {
// skip - already processed in first phase above
}
else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanFactoryPostProcessor.class));
}
else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
orderedPostProcessorNames.add(ppName);
}
else {
nonOrderedPostProcessorNames.add(ppName);
}
}
// First, invoke the BeanFactoryPostProcessors that implement PriorityOrdered.
sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory);
// Next, invoke the BeanFactoryPostProcessors that implement Ordered.
List<BeanFactoryPostProcessor> orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size());
for (String postProcessorName : orderedPostProcessorNames) {
orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));
}
sortPostProcessors(orderedPostProcessors, beanFactory);
invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory);
// Finally, invoke all other BeanFactoryPostProcessors.
List<BeanFactoryPostProcessor> nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size());
for (String postProcessorName : nonOrderedPostProcessorNames) {
nonOrderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));
}
invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory);
// Clear cached merged bean definitions since the post-processors might have
// modified the original metadata, e.g. replacing placeholders in values...
beanFactory.clearMetadataCache();
}
1.1.关键1的invokeBeanDefinitionRegistryPostProcessors方法
上面代码中关键1的invokeBeanDefinitionRegistryPostProcessors方法最终会调用ConfigurationClassPostProcessor类的processConfigBeanDefinitions方法。
这个方法会获取到启动类,然后根据启动类的@SpringBootApplication注解下的@ComponentScan注解去注册beanDefinition (ConfigurationClassParser 的parse方法)
public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
List<BeanDefinitionHolder> configCandidates = new ArrayList<>();
//获取到所有的beanDefinition,springboot项目这里能获取到启动类和标题1获取的几个processor,启动类的获取是在run方法的prepareContext方法的结尾处load方法,最终DefaultListableBeanFactory类的registerBeanDefinition方法,调用启动类调用run方法会传进去启动类。
String[] candidateNames = registry.getBeanDefinitionNames();
//遍历拿到启动类
for (String beanName : candidateNames) {
BeanDefinition beanDef = registry.getBeanDefinition(beanName);
if (beanDef.getAttribute(ConfigurationClassUtils.CONFIGURATION_CLASS_ATTRIBUTE) != null) {
if (logger.isDebugEnabled()) {
logger.debug("Bean definition has already been processed as a configuration class: " + beanDef);
}
}
//启动类会进这个判断
else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) {
configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));
}
}
// Return immediately if no @Configuration classes were found
if (configCandidates.isEmpty()) {
return;
}
// Sort by previously determined @Order value, if applicable
configCandidates.sort((bd1, bd2) -> {
int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition());
int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition());
return Integer.compare(i1, i2);
});
// Detect any custom bean name generation strategy supplied through the enclosing application context
SingletonBeanRegistry sbr = null;
if (registry instanceof SingletonBeanRegistry) {
sbr = (SingletonBeanRegistry) registry;
if (!this.localBeanNameGeneratorSet) {
BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton(
AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR);
if (generator != null) {
this.componentScanBeanNameGenerator = generator;
this.importBeanNameGenerator = generator;
}
}
}
if (this.environment == null) {
this.environment = new StandardEnvironment();
}
// 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 {
//ConfigurationClassParser 的parse方法 传入启动类
//这个方法解析ComponentScan注解 Component注解
//关键1
parser.parse(candidates);
parser.validate();
Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses());
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());
}
//关键2
this.reader.loadBeanDefinitions(configClasses);
alreadyParsed.addAll(configClasses);
candidates.clear();
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();
}
}
1.1.1 ConfigurationClassParser 的parse方法
public void parse(Set<BeanDefinitionHolder> configCandidates) {
for (BeanDefinitionHolder holder : configCandidates) {
BeanDefinition bd = holder.getBeanDefinition();
try {
//关键1 启动类会进入这个判断
//这里就是判断beanDefinition的类型
//1.启动类是AnnotatedGenericBeanDefinition类型,
//因为他是通过AnnotatedBeanDefinitionReader类的registerBean方法注册的
//2.controller这种是ScannedGenericBeanDefinition类型,因为它是通过
//ClassPathBeanDefinitionScanner类的doscan方法通过conponentScan注解的包名引进来的
if (bd instanceof AnnotatedBeanDefinition) {
parse(((AnnotatedBeanDefinition) bd).getMetadata(), holder.getBeanName());
}
else if (bd instanceof AbstractBeanDefinition && ((AbstractBeanDefinition) bd).hasBeanClass()) {
parse(((AbstractBeanDefinition) bd).getBeanClass(), holder.getBeanName());
}
//controller这种的就走这个方法 方法名相同 只是传参不同 有重载
else {
parse(bd.getBeanClassName(), holder.getBeanName());
}
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(
"Failed to parse configuration class [" + bd.getBeanClassName() + "]", ex);
}
}
//关键2 处理autoconfig的类(META-INF下spring.factories文件中) 这个会有很多 而且不是直接变成beandefinition 而是存在ConfigurationClassParser类的configurationClasses属性中
this.deferredImportSelectorHandler.process();
}
关键1.parse方法
最终会调用ConfigurationClassParser类的doProcessConfigurationClass方法
会把controller service component configuration注解的类注册为beanDefinition,同时把这些bean也变成configurationClass类型,加到configurationClasses集合中,后边继续处理
protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass)
throws IOException {
//处理Component注解的类的内部的bean
if (configClass.getMetadata().isAnnotated(Component.class.getName())) {
// Recursively process any member (nested) classes first
processMemberClasses(configClass, sourceClass);
}
// Process any @PropertySource annotations
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
//关键 获取所有的componentScan注解 启动类刚好有一个这个注解
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
//调用componentScanParser.parse处理componentScan注解
//注意:这里的parse方法就会把controller等bean注册为beandefinition
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
//scannedBeanDefinitions里边有了controller service component configuration注解的类
//这里遍历是递归调用parse方法 处理刚刚获取的scannedBeanDefinitions 看每个类是否有componentScan注解或者import注解等等 也就是递归处理每个component引入的bean,把每个bean中引入的bean都加进来。
for (BeanDefinitionHolder holder : scannedBeanDefinitions) {
BeanDefinition bdCand = holder.getBeanDefinition().getOriginatingBeanDefinition();
if (bdCand == null) {
bdCand = holder.getBeanDefinition();
}
if (ConfigurationClassUtils.checkConfigurationClassCandidate(bdCand, this.metadataReaderFactory)) {
//再次调用parse方法,处理controller service这样的bean,把他们也
//变成configurationClass类型 同时处理这些bean中引入的其他bean
parse(bdCand.getBeanClassName(), holder.getBeanName());
}
}
}
}
// Process any @Import annotations
//处理启动类(当前类)的@Import注解
//比如启动类加了mapperscan注解 mapperscan注解 加了@Import(MapperScannerRegistrar.class)
//这里就会把MapperScannerRegistrar也加载进来
//放到 configurationClass属性的importBeanDefinitionRegistrars属性中
//processImports方法判断逻辑
//1.如果通过@Import注解引入的类实现了ImportBeanDefinitionRegistrar接口,则把这个引入的bean放到configurationClass属性的importBeanDefinitionRegistrars属性中。
//2.如果没有实现上述接口 则把当前引入的bean也变成一个configurationClass。方法就是调用parse方法的processConfigurationClass方法,相当于也是递归处理
//3.如果实现了ImportSelector的子接口DeferredImportSelector 则暂不考虑
//4.如果通过@Import注解引入的类实现了ImportSelector接口,则把该类中selectImports方法返回的类再调用一遍processImports方法 也就是再重复1-4的逻辑,也就是不引入当前类 引入当前类selectImports方法返回的类。
processImports(configClass, sourceClass, getImports(sourceClass), true);
// 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
//处理启动类的@Bean注解
Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);
for (MethodMetadata methodMetadata : beanMethods) {
configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));
}
// Process default methods on interfaces
processInterfaces(configClass, sourceClass);
// Process superclass, if any
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;
}
关键2.process方法
deferredImportSelectorHandler.process()方法**
目的是获取springboot中自动配置类(META-INF下spring.factories文件中)存在ConfigurationClassParser类的configurationClasses属性中。
ConfigurationClassParser#parse
public void processGroupImports() {
for (DeferredImportSelectorGrouping grouping : this.groupings.values()) {
//关键这里就是获取到所有的自动配置类 META-INF下spring.factories文件中
grouping.getImports().forEach(entry -> {
ConfigurationClass configurationClass = this.configurationClasses.get(
entry.getMetadata());
try {
//处理自动配置类
//和关键1中处理自定义的bean中的import是相同的逻辑。
//这里会把当前遍历的自动配置类传入(第三个参数)
//processImports方法会判断第三个参数是否实现ImportBeanDefinitionRegistrar接口 实现的话就添加到当前configurationClass的importBeanDefinitionRegistrars属性中 否则就走一遍parse中的processConfigurationClass方法,把当前遍历的自动配置类加到configurationClasses属性中。parse方法执行完会从configurationClasses获取。
//见下面附图
processImports(configurationClass, asSourceClass(configurationClass),
asSourceClasses(entry.getImportClassName()), false);
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(
"Failed to process import candidates for configuration class [" +
configurationClass.getMetadata().getClassName() + "]", ex);
}
});
}
}
附图
ConfigurationClassParser.DeferredImportSelectorGrouping#getImports
AutoConfigurationImportSelector.AutoConfigurationGroup#process
AutoConfigurationImportSelector#getAutoConfigurationEntry
springboot2.7后更换了自动配置的路径。
这个文件路径就是上面拼接好的
这里从文件获取到所有的自动配置类后,会进行过滤和排序。然后回到最初的方法processGroupImports。调用processImports方法。处理每个自动配置类引入的bean,放到ConfigurationClassParser类的configurationClasses属性中
这个processGroupImports方法也很关键
处理每个configurationclass引入的bean。
关键1:针对ImportSelector类型的会先进行初始化,例如@SpringBootApplication注解引入的AutoConfigurationImportSelector,会先初始话,因为需要他提前工作,扫描其他自动配置类
关键2:针对ImportBeanDefinitionRegistrar类型的会先进行初始化,例如,@SpringBootApplication
引入的AutoConfigurationPackage引入的AutoConfigurationPackages.Registrar和mybaits扫描mapper的MapperScannerRegistrar等,都会在这里提前进行实例化。
ConfigurationClassParser#processImports
private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass,
Collection<SourceClass> importCandidates, Predicate<String> exclusionFilter,
boolean checkForCircularImports) {
if (importCandidates.isEmpty()) {
return;
}
if (checkForCircularImports && isChainedImportOnStack(configClass)) {
this.problemReporter.error(new CircularImportProblem(configClass, this.importStack));
}
else {
this.importStack.push(configClass);
try {
for (SourceClass candidate : importCandidates) {
//关键1 预先初始化部分bean
if (candidate.isAssignable(ImportSelector.class)) {
// Candidate class is an ImportSelector -> delegate to it to determine imports
Class<?> candidateClass = candidate.loadClass();
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) {
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);
}
}
//关键2 预先初始化部分bean
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());
//关键3 加载自动配置类到configurationClasses中
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();
}
}
}
总结,这是一个关键的方法,经过这个方法,我们自定义的controller、service、加了component注解的类被注册到了beanDefinition中。自动配置类以及@import引入的类都被封装成一个ConfigurationClass类型的对象,放到ConfigurationClassParser类的configurationClasses属性中,是1个map,key和value都是ConfigurationClass类型。处理的过程中还会递归调用parse方法处理我们自定义的bean,把bean中通过configuration引入的bean也变成一个ConfigurationClass,把bean中通过import引入的bean放到ConfigurationClass属性的importBeanDefinitionRegistrars属性中(实现了ImportBeanDefinitionRegistrar接口的bean,没实现的话则也生成1个ConfigurationClass),把bean中通过@bean引入的bean放到ConfigurationClass属性的beanMethods属性中。
1.1.2 this.reader.loadBeanDefinitions(configClasses)方法
ConfigurationClassBeanDefinitionReader类的loadBeanDefinitions方法
传进来的就是ConfigurationClassParser类的configurationClasses属性。一个set集合,保存所有配置类。
遍历处理配置类中引入的bean
org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForConfigurationClass方法
private void loadBeanDefinitionsForConfigurationClass(
ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) {
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;
}
//处理当前遍历的类 看当前配置类的importedBy属性不为空就添加到beandifinition
//也就是当前遍历的类是通过别的类import进来的,并且这个类没有实现importBeanDefinitionRegistrars接口 这个beanName会加上包的名字
if (configClass.isImported()) {
registerBeanDefinitionForImportedConfigurationClass(configClass);
}
//处理当前遍历的类中 @bean注解引入的类 添加到beandifinition
//1.1.1中解析出来的
for (BeanMethod beanMethod : configClass.getBeanMethods()) {
loadBeanDefinitionsForBeanMethod(beanMethod);
}
loadBeanDefinitionsFromImportedResources(configClass.getImportedResources());
//处理实现ImportBeanDefinitionRegistrar接口的类 也是1.1.1中解析出来的
loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars());
}
经过这两个步骤 所有需要导入的bean(configuration controller service component )以及自动配置类和自动配置类中@bean的类都变成了beandefinition
过程:
先注册ConfigurationClassPostProcessor成为beandefinition,然后进行实例化,然后执行它,然后会获取到启动类,也就是componentScan注解,然后调用ConfigurationClassParser 的parse方法,这个方法有两个作用,1是调用componentScanParser.parse方法,完成componentScan配置的包下的@Component(controller service Configuration)注解的类的beanDefinition的注册,2是调用deferredImportSelectorHandler.process()方法获取自动配置类及内部导入的类放在ConfigurationClassParser类的configurationClasses属性中。然后在ConfigurationClassBeanDefinitionReader类的loadBeanDefinitions方法中完成注册。
2.关键方法
2.1 引入自定义类
parse
1.parse方法作用
调用doProcessConfigurationClass方法注册实体类,
1.把componentScan注解扫描的类(一般是启动类)变成beanDefinition,并且变成configurationClass。
2.处理import引入的bean,放到configurationClass属性的importBeanDefinitionRegistrars属性中,例如
3.处理@bean引入的bean,放到configurationClass属性的beanMethods属性中。
处理完之后 把每个bean放到ConfigurationClassParser的configurationClasses属性中。
2.ConfigurationClassParser#doProcessConfigurationClass方法作用
这个方法会在第一个方法中调用
1.调用processMemberClasses方法,处理当前处理的类的内部的类,具体方法是调用processConfigurationClass
2.处理 @PropertySource 注解
3.处理componentScan注解,一般只有在处理启动类时才会有。得到自定义的controller service 和加了component注解的自定义实体类,放到beandefinition中。具体方法ClassPathBeanDefinitionScanner#doScan。
4.如果componentScan注解不为空,则处理componentScan引入的类,也就是第三步得到的类,放到configurationClasses属性中。具体方法就是调用parse方法。也就是configurationClasses方法。
5.调用processImports处理import进来的类。
6.处理@ImportResource注解。
7.处理@bean引入的类。把引入的类加到configurationClass的BeanMethod属性中。
这个过程会呈指数型增长,最先开始是注册启动类(启动类在springboot的run方法就会被扫描到),启动类有compnentscan注解,就会扫描到controller这样的bean,当然也包括启动类,然后会递归调用parse方法处理扫描到的类,这样就把所有的bean扫描出来了。
2.2 引入自动配置类
this.deferredImportSelectorHandler.process();
processGroupImports方法
获取到所有的自动配置类,
文件1:spring-boot-autoconfigure-2.7.18.jar!\META-INF\ spring.factories
文件2:spring-boot-autoconfigure-2.7.18.jar!\META-INF\spring\ org.springframework.boot.autoconfigure.AutoConfiguration.imports
变成configurationClass放到ConfigurationClassParser的configurationClasses属性中。
2.3 注册beanDefinition
这个过程需要去重,例如controller这种,在2.1中已经变成了beanDefinition。
把configurationClasses中的configurationClass变成beanDefinition
loadBeanDefinitionsForConfigurationClass方法
1.处理import进来的类(这个类没有实现importBeanDefinitionRegistrars接口)
2.处理@bean进来的类
3.处理@ImportResource引进来的类
4.处理处理实现ImportBeanDefinitionRegistrar接口的类(通过@import引入的)