Spring之自定义Bean何时被扫描注册?

2023年 10月 11日 76.4k 0

1. 前言

在AnnotationConfigApplicationContext的构造函数里,Spring会创建AnnotatedBeanDefinitionReader对象,它的基本作用是将基于注解的BeanClass封装成BeanDefinition,并注册到BeanFactory中。同时AnnotatedBeanDefinitionReader的构造函数还做了一件非常重要的事情,就是自动往BeanFactory里注册Spring内置的几个非常非常重要的BeanPostProcessor和BeanFactoryPostProcessor,用来扩展Bean和BeanFactory。
Spring内置的Bean是通过AnnotatedBeanDefinitionReader完成注册的,那开发者自定义的Bean呢?又是在什么时候被扫描注册的呢?

2. ConfigurationClassPostProcessor

AnnotatedBeanDefinitionReader的构造函数里,会完成Spring内置Bean的注册,这其中就包含ConfigurationClassPostProcessor,它的职责就是负责我们自定义Bean的扫描和注册。
image.png
ConfigurationClassPostProcessor实现了BeanFactoryPostProcessor接口,代表它是针对BeanFactory的扩展点;同时又实现了BeanDefinitionRegistryPostProcessor接口,代表它是对BeanFactory完成BeanDefinition注册的一个扩展点。
在这里插入图片描述

public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor {

  /**
  * 完成BeanDefinition的扫描和注册
  */
  void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException;

}

BeanDefinitionRegistryPostProcessor目前只有一个实现类,就是ConfigurationClassPostProcessor。

在AnnotationConfigApplicationContext的refresh()方法中,准备好BeanFactory后,就会开始调用BeanFactoryPostProcessor扩展点。
image.png
最终会委托给PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors()方法,优先调用加了@PriorityOrdered注解的后置处理器,这里就会拿到前面注册的ConfigurationClassPostProcessor,然后invoke调用完成扩展。
image.png
invoke操作会触发ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry()方法,首先是通过一个Set集合来避免向同一个BeanFactory里重复注册。如果针对注册器还没有处理过,则调用processConfigBeanDefinitions()方法做处理。
image.png
BeanFactory里面可能有很多BeanDefinition,Spring要找出所有的配置类ConfigurationClass,只针对配置类做处理。
image.png
过滤出所有的ConfigurationClass后,将这些Class进行一个排序,然后new一个ConfigurationClassParser配置类解析器,对ConfigurationClass进行解析。
image.png
最终会调用ConfigurationClassParser#processConfigurationClass()来解析单个ConfigurationClass,又因为ConfigurationClass可能存在父类,父类的信息也要解析,所以会通过一个循环来递归解析。
image.png
解析ConfigurationClass的@ComponentScan@ComponentScans注解信息,得到要扫描的Bean的包路径,然后通过ComponentScanAnnotationParser去完成扫描,得到一组BeanDefinitionHolder。
image.png
ComponentScanAnnotationParser又会创建一个扫描器ClassPathBeanDefinitionScanner,对给定的包路径进行扫描。
image.png
当然了,扫描会有一定的规则,不是扫描到的所有Class都会成为Bean,所以Scanner会有两组类的过滤器TypeFilter,分别是includeFiltersexcludeFilters,顾名思义分别是包含规则和排除规则,只有符合这些规则的Class才会被注册。
image.png
这里还有一个小细节,如果没有给定扫描的路径,则默认扫描ConfigurationClass所在的包路径。
image.png
得到一组需要扫描的包路径后,会调用ClassPathBeanDefinitionScanner#doScan()方法进行扫描,扫描给定包路径后会得到一组BeanDefinition,对这些BeanDefinition进行一些属性的处理,然后判断是否是候选Bean,如果是的话,就会注册到BeanFactory里。
image.png
具体的扫描过程在ClassPathScanningCandidateComponentProvider#scanCandidateComponents()方法里,其实就是拿着包路径去classpath下扫描得到Class文件对应的Resource,然后解析Class封装成ScannedGenericBeanDefinition并返回。
至此,自定义的Bean的扫描和注册过程就结束了,自定义的Bean被封装成BeanDefinition并注册到了BeanFactory,有了Bean的定义,后续Spring就可以非常方便的帮我们实例化Bean,且自动注入依赖关系了。

相关文章

JavaScript2024新功能:Object.groupBy、正则表达式v标志
PHP trim 函数对多字节字符的使用和限制
新函数 json_validate() 、randomizer 类扩展…20 个PHP 8.3 新特性全面解析
使用HTMX为WordPress增效:如何在不使用复杂框架的情况下增强平台功能
为React 19做准备:WordPress 6.6用户指南
如何删除WordPress中的所有评论

发布评论