Spring-IOC之组件扫描

news/2024/5/28 4:10:49/ 标签: spring, java, 后端

版本 Spring Framework 6.0.9​

1. 前言

通过自动扫描,Spring 会自动从扫描指定的包及其子包下的所有类,并根据类上的特定注解将该类装配到容器中,而无需在 XML 配置文件或 Java 配置类中逐一声明每一个 Bean。

支持的注解
Spring 支持一系列注解,用于标记哪些类应被自动扫描并作为 Bean 管理。这些注解通常包含:

  • @Component:基础注解,标记一个类作为 Spring 组件。所有其他特殊用途的组件注解都继承自此注解。
  • @Repository:用于标注 DAO(Data Access Object)类,除了具备 @Component 的功能外,还为数据访问异常提供了特殊的翻译机制。
  • @Service:用于标注业务层(Service)类,强调这是一个业务相关的组件。
  • @Controller:用于标注 MVC 架构中的控制器类,通常在 Spring MVC 中使用,与 Spring Web 相关的请求处理逻辑相关联。
  • @Configuration:用于标注配置类,这类类通常包含 @Bean 方法,用于定义其他 Bean。
  • @RestController:结合了 @Controller 和 @ResponseBody,适用于构建 RESTful Web 服务的控制器。

例子相关实体类

  • 控制层(例子中没引入spring-web包,注解先使用@Component替代)
    在这里插入图片描述

  • 服务层
    在这里插入图片描述

  • 数据访问层
    在这里插入图片描述

2. 基于xml

2.1 使用

在 Spring 的XML配置文件中,通过 <context:component-scan> 标签开启自动扫描功能。我们可以配置 base-package 指定扫描路径。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

输出信息说明每个实体类都已加载到容器。

<context:component-scan> 其他配置元素:

  • resource-pattern:可选属性,用于指定在扫描包路径下应匹配的资源模式。默认值为 “**/*.class”,即扫描所有 .class 文件。可以根据需要修改此模式,例如,仅扫描特定目录下的类。
  • use-default-filters:布尔属性,默认值为 true。决定是否启用默认的过滤规则,即查找带有 @Component、@Repository、@Service、@Controller、@Configuration 等注解的类。如果设置为 false,则需要手动配置 和 来指定扫描规则。
  • scope-resolver:指定一个自定义的 ScopeMetadataResolver 实现类,用于确定扫描到的 Bean 的作用域。默认情况下,Spring 使用 AnnotationScopeMetadataResolver,根据类上的 @Scope 注解来确定作用域。
  • scoped-proxy:指定是否为扫描到的带有作用域注解的 Bean 创建代理。可能的值包括:
    • no(默认):不创建代理。
    • interfaces:为实现了接口的 Bean 创建 JDK 动态代理。
    • targetClass:为未实现接口或需要保留原始类类型的 Bean 创建 CGLIB 代理。
  • name-generator:指定一个自定义的 BeanNameGenerator 实现类,用于生成扫描到的 Bean 的名称。默认使用 AnnotationBeanNameGenerator,根据类上的 @Component 等注解的 value 属性或类名生成 Bean 名称。
  • include-filterexclude-filter:这两个元素属于子标签,用于指定更细粒度的扫描规则。可以按注解类型、注解属性、全类名模式等进行包含或排除。

2.2 扫描原理

  1. 当我们使用ClassPathXmlApplicationContext作为IOC容器,在refresh方法的obtainFreshBeanFactory阶段会创建一个bean工厂DefaultListableBeanFactory。
  2. 当前上下文调用loadBeanDefinitions方法,根据容器的配置文件加载bean定义。
  3. 配置文件中通过 <context:component-scan> 标签开启自动扫描功能,属于其他命名空间,托管给 ComponentScanBeanDefinitionParser处理。
  4. ComponentScanBeanDefinitionParser#parse方法中创建一个ClassPathBeanDefinitionScanner对象,调用其scan方法扫描组件并加载到bean工厂中。

在这里插入图片描述

其他命名空间

Spring框架除了核心的XML命名空间外,还提供了多个扩展命名空间(除beans以外的命名空间),以支持特定的功能模块和简化配置。

  1. http://www.springframework.org/schema/beans:核心命名空间,这是最基础且最常用的命名空间,用于定义bean、设置属性、注入依赖、配置构造函数参数、初始化方法、销毁方法、自动装配等基本IoC容器功能。
  2. http://www.springframework.org/schema/context:
    context命名空间,提供了对Java配置类、自动扫描、注解驱动的bean定义、属性占位符替换、资源加载等上下文相关的高级功能的支持。通过此命名空间,可以简化基于注解的配置,如@Component、@Autowired等。

在实例化XmlReaderContext时,DefaultBeanDefinitionDocumentReader会创建一个命名空间解析器DefaultNamespaceHandlerResolver,缓存到XmlReaderContext,当Reader解析配置文件时发现存在其他命名空间时,通过DefaultNamespaceHandlerResolver加载 META-INF/spring.handlers 路径下的其他命名空间处理器,获取对应的处理器处理。

XmlReaderContext 是Spring框架中用于处理XML配置文件解析过程中的上下文对象,为DefaultBeanDefinitionDocumentReader在解析和处理XML配置文件时提供了必要的环境支持。

在这里插入图片描述

context命名空间处理器(ComponentScanBeanDefinitionParser)

  1. 获取基础包名basePackages。
  2. 创建类路径 Bean 定义扫描程序ClassPathBeanDefinitionScanner。
  3. 遍历扫描包名,查找被@Component及其派生注解修饰的类。将它们封装为BeanDefinitionHolder对象。
  4. 往bean工厂加载特定注解后置处理器的bean定义(internalConfigurationAnnotationProcessor、internalAutowiredAnnotationProcess、internalCommonAnnotationProcessor、internalEventListenerProcessor、internalEventListenerFactory),触发组件注册事件.
获取基础包名basePackages
  • element.getAttribute(BASE_PACKAGE_ATTRIBUTE)方法从对象中获取base-package的属性值。

  • parserContext.getReaderContext().getEnvironment().resolvePlaceholders(basePackage)方法解析占位符,获取解析值。

  • StringUtils.tokenizeToStringArray(basePackage,ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS)方法将基础包名按逗号、分号或空格等常见分隔符拆分为一个字符串数组basePackages。

在这里插入图片描述

创建组件扫描器

ComponentScanBeanDefinitionParser#configureScanner方法通过对XML元素element的各项属性(use-default-filters、resource-pattern、name-generator、scope-resolver、scoped-proxy)和子元素(include-filter、exclude-filter)进行解析,创建一个定制化的扫描器ClassPathBeanDefinitionScanner。
在这里插入图片描述

另外通过ClassPathBeanDefinitionScanner构造函数实例化时,会创建一个Component类型的注解类型过滤器AnnotationTypeFilter添加到includeFilters属性中,用于将类与@Component进行匹配。
在这里插入图片描述

扫描组件

ClassPathBeanDefinitionScanner#doScan扫描指定的basePackages包及其子包,查找并处理符合要求的bean定义,最终将它们封装为BeanDefinitionHolder对象并返回,bean定义类型是ScannedGenericBeanDefinition。
在这里插入图片描述

扫描核心方法ClassPathScanningCandidateComponentProvider#findCandidateComponents用于在指定的basePackage包及其子包下查找符合要求的候选bean组件(BeanDefinition),支持索引查找(效率更高)或按传统方式查找(获取指定包下所有class对象筛选)。
在这里插入图片描述

我们只看传统方式查找方式,ClassPathScanningCandidateComponentProvider#scanCandidateComponents方法用于在给定的basePackage及其子包下通过类路径扫描机制查找候选bean组件(BeanDefinition).
在这里插入图片描述

ClassPathScanningCandidateComponentProvider#isCandidateComponent方法用于判断给定的MetadataReader所代表的类是否满足候选bean组件的条件,在不添加其他排除过滤器、包含过滤器或配置,上面创建组件扫描器过程中,已知添加了一个AnnotationTypeFilter包含过滤器,在此处使用,匹配被@Component注解的类。
在这里插入图片描述

触发组件注册事件

ComponentScanBeanDefinitionParser#registerComponents负责将一组BeanDefinition注册到Spring IoC容器中,并处理与之相关的XML元素及注解配置处理器。实际上做了两件事

  • 往bean工厂加载特定注解后置处理器的bean定义
  • 触发组件注册事件,一般情况下是EmptyReaderEventListener,空方法。

在这里插入图片描述

3. 全注解开发

AnnotationConfigApplicationContext 是 Spring Framework 中的一个核心类,用于创建和管理基于 Java 注解的 Spring 应用程序上下文。AnnotationConfigApplicationContext 有两种开启组件扫描的方式

  • 直接指定包路径
  • 通过@ComponentScan注解

3.1 通过指定包路径开启扫描

使用

在这里插入图片描述
在这里插入图片描述

扫描原理

接受一个字符串数组参数 basePackages的有参构造逻辑分成三部分:

  • this(); 调用无参构造函数
  • scan(basePackages); 执行类路径扫描
  • refresh(); 启动应用上下文
    在这里插入图片描述

无参构造函数实例化组件扫描器 ClassPathBeanDefinitionScanner,用于在类路径中扫描并注册基于注解的 Bean 定义(如 @Component、@Service、@Repository、@Controller 等)。
在这里插入图片描述

调用ClassPathBeanDefinitionScanner#scan方法扫描组件,与基于xml扫描逻辑一样,调用的是ClassPathBeanDefinitionScanner#scan方法,所以bean定义创建的类型也是ScannedGenericBeanDefinition类。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

3.2 通过Java配置类开启扫描

使用

在这里插入图片描述c
在这里插入图片描述
在这里插入图片描述

扫描原理

接受一个类型为 Class<?> 的可变参数数组 componentClasses的有参构造逻辑分成三部分:

  • this(); 调用无参构造函数
  • register(componentClasses); 注册指定的组件
  • refresh(); 启动应用上下文

在这里插入图片描述

第一部分虽然与接受字符串的有参构造(指定扫描路径)一样调用了无参构造,但我们这里只关注 带注释的 Bean 定义读取器AnnotatedBeanDefinitionReader,而不是类路径 Bean 定义扫描程器ClassPathBeanDefinitionScanner。
在这里插入图片描述

实例化AnnotatedBeanDefinitionReader过程中,会调用AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry)方法,往bean工厂注册一个bean定义后置处理器ConfigurationClassPostProcessor。
在这里插入图片描述
在这里插入图片描述

第二部分注册Java配置类ScanConfig,实例化并初始化bean定义类AnnotatedGenericBeanDefinition,并加载到bean工厂中。
在这里插入图片描述
在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

第三部分在refresh方法invokeBeanFactoryPostProcessors阶段,会调用在第一部分注册的ConfigurationClassPostProcessor(在当前阶段会调用getBean方法实例化)后置处理。
在这里插入图片描述

ConfigurationClassPostProcessor 是 Spring 框架中一个重要的 BeanDefinitionRegistryPostProcessor 实现,主要负责处理带有 @Configuration 注解的类以及它们内部定义的 @Bean 方法和其他相关注解。postProcessBeanDefinitionRegistry方法会筛选出有效的@configuration类,调用配置类解析器ConfigurationClassParser的parse方法解析。
在这里插入图片描述
在这里插入图片描述

从第二部分知道,ScanConfig生成的bean定义类是AnnotatedGenericBeanDefinition,是AnnotatedBeanDefinition的子类。debug源码到处理@ComponentScan注解(this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());),说明ConfigurationClassParser处理逻辑委托给componentScanParser,调用其parse方法处理。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

这里的this.componentScanParser是ComponentScanAnnotationParser类,在调用ConfigurationClassParser构造函数实例化时创建。
在这里插入图片描述

ComponentScanAnnotationParser#parse方法中的逻辑就很熟悉了,可以对标context命名空间处理各个属性。在方法中是新建了一个ClassPathBeanDefinitionScanner类,而不是使用AnnotationConfigApplicationContext无参构造中实例化的ClassPathBeanDefinitionScanner,最后执行doscan方法扫描组件。
在这里插入图片描述

总结

总结一下通过@ComponentScan开启扫描流程.

  • this();
    • 在实例化AnnotatedBeanDefinitionReader过程中,往bean工厂加载了ConfigurationClassPostProcessor的bean定义
  • register(componentClasses);
    • 往bean工厂加载了包含@Configuration、@ComponentScan注解的ScanConfig配置类 的bean定义。
  • refresh();
    • 在invokeBeanFactoryPostProcessors阶段实例化了ConfigurationClassPostProcessor,并调用其postProcessBeanDefinitionRegistry方法处理@Configuration配置类。
    • ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry方法中,获取并筛选有效的 @Configuration类,实例化了配置类解析器ConfigurationClassParser,调用其parse方法,解析配置类(ScanConfig.class)。
    • ConfigurationClassParser#parse包含处理配置类中各种注解,其中就包含@ComponentScan。但解析@ComponentScan,委托给了ComponentScanAnnotationParser类,调用其parse方法.
    • ComponentScanAnnotationParser#parse实例化了类路径 Bean 定义扫描器ClassPathBeanDefinitionScanner,ClassPathBeanDefinitionScanner加载扫描配置后调用doScan扫描组件。

在这里插入图片描述


http://www.ppmy.cn/news/1434553.html

相关文章

001 redis高并发减库存

文章目录 释放锁加lua脚本String lockValue&#xff08;唯一标识符作为锁的值&#xff09;lua脚本无String lockValue&#xff08;唯一标识符作为锁的值&#xff09;无Lua脚本加锁的过期时间防死锁无lockValue代码 lockValue加了lockValue无lua脚本代码加了lockValue加了lua脚本…

工厂方法模式设计实验

【实验内容】 楚锋软件公司欲开发一个系统运行日志记录器&#xff08;Logger&#xff09;。该记录器可以通过多种途径保存系统的运行日志&#xff1a;例如通过文件记录或数据库记录&#xff0c;用户可以通过修改配置文件灵活地更换日志记录方式。在设计各类日志记录器时&#…

【ZZULIOJ】1078: a+b(多实例测试1)(Java)

目录 题目描述 输入 输出 样例输入 Copy 样例输出 Copy 提示 code 题目描述 计算AB 输入 输入第1行为一个整数n(1≤n≤10)&#xff0c;代表测试的组数。 下面有n组测试数据&#xff0c;每组1行&#xff0c;为2个整数&#xff0c;为A, B。 输出 对每行输入&#xff…

【Java】文件操作(一)

文章目录 ✍一、文件的基本认识1.文件是什么&#xff1f;2.文本文件和二进制文件3.文件权限4.相对路径和绝对路径1.1绝对路径1.2相对路径 ✍二、文件的基本操作1.FIle的属性2.File的构造方法3.File类的方法3.1File类的获取操作3.2File类的判断操作3.3文件创建和删除3.4其他的常…

SQL超详细解析

目录 SQL通用语法 SQL分类 DDL-数据库定义语言 1、DDL-数据库操作-查询 查询所有数据库 查询当前数据库 2、DDL-数据库操作-创建 创建数据库 3、DDL-数据库操作-删除 4、DDL-数据库操作-使用 5、DDL-表操作-查询&#xff1a; 查看当前数据库的所有表名称 查询当前表…

C++的初步知识——命名空间,缺省参数,重载函数

C 首先写一段代码&#xff1a; #include <stdio.h>int main() {printf("Hello world\n");return 0; }这段C语言代码在cpp文件中仍可运行。我们了解C是兼容C语言的&#xff0c;C的关键字中就包含了C语言的关键字和自身的关键字。关于关键字&#xff0c;我们简…

问题:react函数中的state是上一次的值

场景 有一个聊天输入框组件&#xff0c;输入框上面有表情包组件。 通过redux创建了store&#xff0c;存储一个message的状态&#xff0c;用于表情包和输入框共享状态。 输入框通过设置value和onClick做了一个简单双向绑定&#xff0c;其中value的值为store里的message。 impor…

在android 源代码中 使用gradlew 编译android 模块

gradle 编译子模块 在Gradle中编译子模块通常涉及到以下步骤&#xff1a; 1、确保你的项目结构是模块化的&#xff0c;每个子模块都是一个独立的目录2、在项目的根目录下的setting.gradle文件中&#xff0c;包含需要编译的子模块。例如&#xff1a;include ‘:submodule-name…

ctfshow web入门 web180--web185

web180 import requests import recom re.compile("admin") def repisTrue(char):url f"http://自己环境的网址/api/?id1%27and%27{char}%27%27{char}&page1&limit10"res requests.get(url)w com.search(res.text)if w is not None:return T…

(delphi11最新学习资料) Object Pascal 学习笔记---第10章第1节(属性的代码补全)

10.1.3 属性的代码补全 ​ 给类添加属性是一项繁琐的工作&#xff0c;IDE的编辑器可以让你在编写属性声明的初始部分&#xff08;在类内部&#xff09;时轻松自动完成属性&#xff0c;如下所示&#xff1a; typeTMyClass classpublicproperty Month : Integer;end;​ 在光标…

PyTorch and Stable Diffusion on FreeBSD

Stable Diffusion在图像生成领域具有广泛的应用和显著的优势。它利用深度学习和扩散模型的原理&#xff0c;能够从随机噪声中生成高质量的图像。 官网&#xff1a;GitHub - verm/freebsd-stable-diffusion: Stable Diffusion on FreeBSD with CUDA support FreeBSD下难度主要…

【QT学习】9.绘图,三种贴图,贴图的转换,不规则贴图(透明泡泡)

一。绘图的解释 Qt 中提供了强大的 2D 绘图系统&#xff0c;可以使用相同的 API 在屏幕和绘图设备上进行绘制&#xff0c;它主要基于QPainter、QPaintDevice 和 QPaintEngine 这三个类。 QPainter 用于执行绘图操作&#xff0c;其提供的 API 在 GUI 或 QImage、QOpenGLPaintDev…

网络基础-TCP/IP和OSI协议模型

一、OSI和TCP/IP模型 二、OSI七层模型 三、TCP/IP模型 参考&#xff1a;https://www.cnblogs.com/f-ck-need-u/p/7623252.html

怎么使用yolov8进行图片识别,分类,分割,视频追踪

目录 一:简介 二:图片识别 三:图片分类 四:图片分割 五:姿态

力扣HOT100 - 199. 二叉树的右视图

解题思路&#xff1a; 相当于层序遍历&#xff0c;然后取每一层的最后一个节点。 class Solution {public List<Integer> rightSideView(TreeNode root) {if (root null) return new ArrayList<Integer>();Queue<TreeNode> queue new LinkedList<>…

【免费题库】华为OD机试 - 根据IP查找城市(Java JS Python C C++)

须知 哈喽,本题库完全免费,收费是为了防止被爬,大家订阅专栏后可以私信联系退款。感谢支持 文章目录 须知题目描述输入描述输出描述解题思路:Java代码:JS代码:Python代码:C++代码:题目描述 某业务需要根据终端的IP地址获取该终端归属的城市,可以根据公开的IP地址池信…

K8s: 控制器之Deployment对象

Deployment 对象 1 &#xff09;概述 为什么大家都用Deployment&#xff0c;不直接用Pod&#xff0c;不直接用 Replica Set因为deployment就是专门像一个管理员一样&#xff0c;专门来管这些散落在各处的各种各样的PodDeployment不仅会管Pod&#xff0c;还会管Replica Set只要…

UltraScale+的10G/25G Ethernet Subsystem IP核使用

文章目录 前言一、设计框图1.1、xxv_ethernet_01.2、xxv_ethernet_0_sharedlogic_wrapper1.3、xxv_ethernet_0_clocking_wrapper1.4、xxv_ethernet_0_common_wrapper 二、IP核配置三、仿真四、上板测速五、总结 前言 前面我们学习了很多基于XILINX 7系列的高速接口使用&#x…

干货|Python的交互式脚本式

Python交互式编程 我们可以在命令提示符中输入"Python"命令来启动Python解释器&#xff1a; $ python3执行以上命令后&#xff0c;出现如下窗口信息&#xff1a; $ python3 Python 3.4.0 (default, Apr 11 2014, 13:05:11) [GCC 4.8.2] on linux Type "help&…

企业数据分析的维度一般有哪些?

​在很多场景下&#xff0c;都会进行企业的一个分析&#xff0c;来反应我们的问题。常见的需要分析企业数据的场景有&#xff1a;业务优化&#xff08;月度季度&#xff09;&#xff0c;需要做投资决策时&#xff0c;有融资需求&#xff0c;或者战略上出现了改变时&#xff0c;…