当前位置：首页 > news >正文

Sping源码（七）—ConfigurationClassPostProcessor —— 后续处理

news 来源：原创 2024/9/30 5:35:58

序言

前面的文章中介绍了 parser.parse(); 方法的整体处理逻辑，其中包括@Bean、@Import、@Configuration、@CompopnentScan、@Component等注解的解析。
来看看注解解析完的后续工作都做了些什么？

源码片段

简单回顾一下主方法processConfigBeanDefinitions整体的执行流程。

public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {//省略部分源码....// 获取所有BeanDeinition，并根据@Configuration、@Component、@Import..等注解进行过滤// Parse each @Configuration class//创建ConfigurationClassParser解析对象ConfigurationClassParser parser = new ConfigurationClassParser(this.metadataReaderFactory, this.problemReporter, this.environment,this.resourceLoader, this.componentScanBeanNameGenerator, registry);//解析configCandidates集合Set<BeanDefinitionHolder> candidates = new LinkedHashSet<>(configCandidates);//已经解析过的BeanDefinitionHolder集合Set<ConfigurationClass> alreadyParsed = new HashSet<>(configCandidates.size());do {//解析带有@Configuration、@ComponentScan、@Import、@ImportResource等注解的类parser.parse(candidates);//对处理完的配置类进行校验（包含@Configuration）//1.配置类不能是final修饰//2.@Bean修饰的方法必须可以重写以支持CGLIBparser.validate();//获取所有的解析的Bean，包括@ComponentScan扫描的符合条件的、@Import加载的。Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses());//移除已经解析过的配置类configClasses.removeAll(alreadyParsed);// Read the model and create bean definitions based on its content// 判断读取器是否为空，如果为空的话，就创建完全填充好的ConfigurationClass实例的读取器if (this.reader == null) {this.reader = new ConfigurationClassBeanDefinitionReader(registry, this.sourceExtractor, this.resourceLoader, this.environment,this.importBeanNameGenerator, parser.getImportRegistry());}//处理由@Bean、@Import、@ImportResource注解加载的配置类,创建BeanDefinition注册到BeanFactory中this.reader.loadBeanDefinitions(configClasses);//将已经解析过的配置类添加到alreadyParsed集合中alreadyParsed.addAll(configClasses);candidates.clear();//如果此时配置类数量大于之前的数量，则说明有新的配置类被加载，则继续解析if (registry.getBeanDefinitionCount() > candidateNames.length) {//获取当前BeanFactory中注册的所有BeanDefinitionNamesString[] newCandidateNames = registry.getBeanDefinitionNames();//获取之前的BeanDefinitionNames集合Set<String> oldCandidateNames = new HashSet<>(Arrays.asList(candidateNames));Set<String> alreadyParsedClasses = new HashSet<>();//将已经解析过的配置类添加到alreadyParsedClasses集合中for (ConfigurationClass configurationClass : alreadyParsed) {alreadyParsedClasses.add(configurationClass.getMetadata().getClassName());}for (String candidateName : newCandidateNames) {//如果当前BeanDefinitionName不在之前的BeanDefinitionNames集合中，则添加到candidates集合中if (!oldCandidateNames.contains(candidateName)) {BeanDefinition bd = registry.getBeanDefinition(candidateName);//判断当前BeanDefinition是否是配置类// （@Configuration注解、@Bean注解、@ComponentScan注解、@Import注解、@ImportResource注解）//并且不在alreadyParsedClasses集合中if (ConfigurationClassUtils.checkConfigurationClassCandidate(bd, this.metadataReaderFactory) &&!alreadyParsedClasses.contains(bd.getBeanClassName())) {//封装成BeanDefinitionHolder添加到candidates集合中candidates.add(new BeanDefinitionHolder(bd, candidateName));}}}candidateNames = newCandidateNames;}}//不为null，就一直循环解析while (!candidates.isEmpty());}

validate

遍历configurationClasses集合进行校验。
主要校验的是2个地方： 1 配置类不能是final的， 2 @Bean修饰的方法必须是可重写的，用来适应CGLIB代理。

public void validate() {for (ConfigurationClass configClass : this.configurationClasses.keySet()) {configClass.validate(this.problemReporter);}}

遍历的configurationClasses变量是每一个配置类解析完成之后，都会添加到configurationClasses集合中

// Recursively process the configuration class and its superclass hierarchy.//转换成SourceClass对象:以统一的方式去处理带有注解的类，不管这些类是如何加载的SourceClass sourceClass = asSourceClass(configClass, filter);do {//解析注解sourceClass = doProcessConfigurationClass(configClass, sourceClass, filter);}while (sourceClass != null);this.configurationClasses.put(configClass, configClass);

public void validate(ProblemReporter problemReporter) {// A configuration class may not be final (CGLIB limitation) unless it declares proxyBeanMethods=falseMap<String, Object> attributes = this.metadata.getAnnotationAttributes(Configuration.class.getName());if (attributes != null && (Boolean) attributes.get("proxyBeanMethods")) {if (this.metadata.isFinal()) {problemReporter.error(new FinalConfigurationProblem());}for (BeanMethod beanMethod : this.beanMethods) {beanMethod.validate(problemReporter);}}}

loadBeanDefinitions

后续处理中核心方法。
parse()方法在解析@Bean、@Import注解时，当时只是获取了注解中声明的Bean并放入对应集合中，没有额外的处理。
此处就对value中声明的Bean对象做了处理。

循环遍历调用loadBeanDefinitionsForConfigurationClass()方法。

public void loadBeanDefinitions(Set<ConfigurationClass> configurationModel) {TrackedConditionEvaluator trackedConditionEvaluator = new TrackedConditionEvaluator();for (ConfigurationClass configClass : configurationModel) {loadBeanDefinitionsForConfigurationClass(configClass, trackedConditionEvaluator);}}

loadBeanDefinitionsForConfigurationClass
将@Import、@Bean、@ImportResource注解中声明的类封装成BeanDefinition，注册到BeanFacroty。

private void loadBeanDefinitionsForConfigurationClass(ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) {if (trackedConditionEvaluator.shouldSkip(configClass)) {//如果上面判断返回true,获取配置类beanName,然后移除String beanName = configClass.getBeanName();//如果beanName不为空,并且容器中存在beanName,则移除if (StringUtils.hasLength(beanName) && this.registry.containsBeanDefinition(beanName)) {this.registry.removeBeanDefinition(beanName);}this.importRegistry.removeImportingClass(configClass.getMetadata().getClassName());return;}if (configClass.isImported()) {//注册导入的配置类registerBeanDefinitionForImportedConfigurationClass(configClass);}// 判断当前的bean中是否含有@Bean注解的方法，如果有，需要把这些方法产生的bean放入到BeanDefinitionMap当中for (BeanMethod beanMethod : configClass.getBeanMethods()) {loadBeanDefinitionsForBeanMethod(beanMethod);}// 将@ImportResource引入的资源注入IOC容器loadBeanDefinitionsFromImportedResources(configClass.getImportedResources());// 如果bean上存在@Import注解，且import的是一个实现了ImportBeanDefinitionRegistrar接口,// 则执行ImportBeanDefinitionRegistrar的registerBeanDefinitions()方法loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars());}

扩展-Bean.Role

其中有一个扩展点是在@Bean修饰的method进行对应的类加载时会进行判断。

源码
如果当前通过@Bean注解要生成的Bean.role() > ROLE_APPLICATION ，则不进行加载。

if (existingBeanDef.getRole() > BeanDefinition.ROLE_APPLICATION) {return false;}

而我们的role共分下面三个角色，其中一部分的Bean相当于Spring的内部Bean（ROLE_INFRASTRUCTURE = 2）是不需要注册到BeanFacroty中的。
而我们通过注解、xml等声明的Bean（ROLE_APPLICATION = 0）通常都需要加载到BeanFactory中托管给Spring进行管理。

/*** Role hint indicating that a {@code BeanDefinition} is a major part* of the application. Typically corresponds to a user-defined bean.*/int ROLE_APPLICATION = 0;/*** Role hint indicating that a {@code BeanDefinition} is a supporting* part of some larger configuration, typically an outer* {@link org.springframework.beans.factory.parsing.ComponentDefinition}.* {@code SUPPORT} beans are considered important enough to be aware* of when looking more closely at a particular* {@link org.springframework.beans.factory.parsing.ComponentDefinition},* but not when looking at the overall configuration of an application.*/int ROLE_SUPPORT = 1;/*** Role hint indicating that a {@code BeanDefinition} is providing an* entirely background role and has no relevance to the end-user. This hint is* used when registering beans that are completely part of the internal workings* of a {@link org.springframework.beans.factory.parsing.ComponentDefinition}.*/int ROLE_INFRASTRUCTURE = 2;