Spring-IOC之组件扫描

news2024/11/18 23:44:15

版本 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.coloradmin.cn/o/1620995.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

IDEA最好用插件推荐

1 背景 俗话说&#xff1a;“工欲善其事必先利其器”&#xff0c;本问介绍几款强大实用的 IDEA 插件&#xff0c;助力大家开发。 希望大家做一个聪明又努力的人&#xff0c;而不只是一个努力的人。 以下插件大都可以通过 IDEA 自带的插件管理中心安装&#xff0c;如果搜不到可以…

如何给word中的拼音加声调?分享3个方法

一&#xff0c;前言 在Word文档中标注拼音声调&#xff0c;是许多人在处理中文文档时经常需要面对的问题。对于不熟悉拼音的人来说&#xff0c;这可能会是一个挑战。但是&#xff0c;通过掌握一些简单的步骤和技巧&#xff0c;我们可以轻松地在Word文档中标注拼音声调。 二&a…

车载以太网DoIP 协议,万字长文详解

&#x1f345; 我是蚂蚁小兵&#xff0c;专注于车载诊断领域&#xff0c;尤其擅长于对CANoe工具的使用&#x1f345; 寻找组织 &#xff0c;答疑解惑&#xff0c;摸鱼聊天&#xff0c;博客源码&#xff0c;点击加入&#x1f449;【相亲相爱一家人】&#x1f345; 玩转CANoe&…

YOLOv8 实现车牌检测,生成可视化检测视频(20240424)

原项目源码地址&#xff1a;GitHub 我的源码地址&#xff1a;Gitee 环境搭建请参考&#xff1a;Win10 搭建 YOLOv8 运行环境&#xff08;20240423&#xff09;-CSDN博客 环境测试请参考&#xff1a;本地运行测试 YOLOv8&#xff08;20240423&#xff09;-CSDN博客 训练数据…

三、CPU基础-缓存

计算机中缓存一般分为两个部分 1.内存 2.CPU Cache 一、CPU Cache分级 CPU Cache 通常分为大小不等的三级缓存&#xff0c;分别是 L1 Cache、L2 Cache 和 L3 Cache。 L1 Cache 和 L2 Cache 都是每个 CPU 核心独有的&#xff08;通常会分为「数据缓存」和「指令缓存」&#…

百度安全多篇议题入选Blackhat Asia以硬技术发现“芯”问题

Blackhat Asia 2024于4月中旬在新加坡隆重举行。此次大会聚集了业界最杰出的信息安全专业人士和研究者&#xff0c;为参会人员提供了安全领域最新的研究成果和发展趋势。在本次大会上&#xff0c;百度安全共有三篇技术议题被大会收录&#xff0c;主要围绕自动驾驶控制器安全、跨…

告别互信息:跨模态人员重新识别的变分蒸馏

Farewell to Mutual Information: Variational Distillation for Cross-Modal Person Re-Identification 摘要&#xff1a; 信息瓶颈 (IB) 通过在最小化冗余的同时保留与预测标签相关的所有信息&#xff0c;为表示学习提供了信息论原理。尽管 IB 原理已应用于广泛的应用&…

使用CSS+HTML完成导航栏

HTML <!DOCTYPE html> <html lang"en"> <head> <meta charset"UTF-8"> <meta name"viewport" content"widthdevice-width, initial-scale1.0"> <title>导航栏示例</title> &l…

​LeetCode解法汇总2385. 感染二叉树需要的总时间

目录链接&#xff1a; 力扣编程题-解法汇总_分享记录-CSDN博客 GitHub同步刷题项目&#xff1a; https://github.com/September26/java-algorithms 原题链接&#xff1a;. - 力扣&#xff08;LeetCode&#xff09; 描述&#xff1a; 给你一棵二叉树的根节点 root &#xff0…

QT——其他方式实现HelloWrold

QT——其他方式实现HelloWrold 使用输入框实现使用代码实现 通过按钮实现信号槽代码方式实现 我们之前对QT实现HelloWorld有了一些基本的了解&#xff0c;用了一些简单的方法实现了HelloWorld&#xff0c;如果对QT还不怎么了解的&#xff0c;可以点击这里&#xff1a; https://…

YOLOv9改进策略 | 添加注意力篇 | TripletAttention三重注意力机制(附代码+机制原理+添加教程)

一、本文介绍 本文给大家带来的改进是Triplet Attention三重注意力机制。这个机制&#xff0c;它通过三个不同的视角来分析输入的数据&#xff0c;就好比三个人从不同的角度来观察同一幅画&#xff0c;然后共同决定哪些部分最值得注意。三重注意力机制的主要思想是在网络中引入…

【调制】π/4-DQPSK信号模型及其相关特性分析 【附MATLAB代码】

MATLAB代码 % pi/4-DQPSK modulation %输入一串数&#xff0c;输出经过差分并映射的I、Q两路数据 ​ function [I,Q]pi4_dqpskmod(data) ​ nlength(data)./2; data1data.*2-1; ​ Idatazeros(1,n); Qdatazeros(1,n); ​ ​ Idatadata1(1,1:2:2*n); %串并变换 Qdatadata1(…

MT3030 天梯赛

跟MT3029战神小码哥类似&#xff0c;都是贪心堆。注意开long long 这里的堆顶为战斗力最小的&#xff0c;便于贪心的反悔操作。先按容忍度从大到小排序&#xff08;q中总容忍度取决于最小的容忍度&#xff09;&#xff0c;再向q中存数&#xff0c;存到不能容忍之后再把堆顶踢出…

网优干货:ACP交付详解版(1)

1.1. 整体流程简介 使用Massive MIMO ACP工具进行覆盖优化的整体流程如下&#xff1a; 1.2. 数据准备 在使用基于DT数据进行5G MassiveMIMO覆盖优化前&#xff0c;需要从网络中收集以下各类数据&#xff0c;数据采集范围需包括优化区域以及对其存在干扰的周边区域所有5G站点。 …

【Java】文件操作(一)

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

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…

svn使用(上传自己的项目到svn上)

安卓开发工具版本 创建项目后&#xff0c;首先在.gitgnore文件里面加入你要过滤的文件路径 然后点击VCS——》share Project&#xff0c;然后下一步选择一个svn路径&#xff0c;点击确定后。然后将代码提交。

递归、搜索与回溯算法:FloodFill 算法

例题一 算法思路&#xff1a; 可以利⽤「深搜」或者「宽搜」&#xff0c;遍历到与该点相连的所有「像素相同的点」&#xff0c;然后将其修改成指定的像素即可。 全局变量&#xff1a; int dx[4] { 0,0,1,-1 }, dy[4] { 1,-1,0,0 }; int m, n; int precolor;//记录原先的颜色…

CentOS-7安装Mysql并允许其他主机登录

一、通用设置&#xff08;分别在4台虚拟机设置&#xff09; 1、配置主机名 hostnamectl set-hostname --static 主机名2、修改hosts文件 vim /etc/hosts 输入&#xff1a; 192.168.15.129 master 192.168.15.133 node1 192.168.15.134 node2 192.168.15.136 node33、 保持服…

【C++ 多态】带你详细了解虚函数表

文章目录 1.一道面试题 -- 引入虚函数表2.多态是怎么实现的呢&#xff1f;2.1满足多态的时候&#x1f427;2.2不满足多态的时候&#x1f427; 3.打印虚函数表 1.一道面试题 – 引入虚函数表 ①&#x1f34e; _vfptr 虚表指针&#xff0c;虚表指针是用来实现多态的 &#xff08…