Spring-IOC之组件扫描

版本 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扫描组件。

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/569160.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

Mysql索引详解(索引分类)

文章目录 概述索引对查询速度的影响索引的优缺点索引类型一级索引和二级索引的区别MySQL 回表联合索引&#xff08;最左前缀原则主键索引和唯一索引的区别BTree索引和Hash索引的区别 覆盖索引索引下推加索引能够提升查询效率原因MySQL 索引结构采用 B树原因索引失效的场景MySQL…

JAVASE基础语法(异常、常用类)

一、异常 1.1 什么是异常 异常就是指不正常。是指代码在运行过程中可能发生错误&#xff0c;导致程序无法正常运行。 package com.atguigu.exception;public class TestException {public static void main(String[] args) {int[] arr {1,2,3,4,5};System.out.println(&quo…

前端css中filter(滤镜)的使用

前端css中filter的使用 一、前言二、补充内容说明三、模糊&#xff08;一&#xff09;、模糊效果&#xff0c;源码1&#xff08;二&#xff09;、源码1运行效果1.视频演示2.截图演示 四、阴影&#xff08;一&#xff09;、阴影效果&#xff0c;源码2&#xff08;二&#xff09;…

Linux文件系统与日志

一、inode和block 文件数据包括元信息与实际数据&#xff0c;文件存储在硬盘上&#xff0c;硬盘最小存储单位是扇区&#xff0c;每个扇区存储512字节 1.block(块)&#xff1a;文件系统中用于存储文件实际数据的最小单位&#xff0c;由文件系统进行分配和管理&#xff0c;并通…

JavaSE内部类

内部类概述 1.内部类的基础 内部类的分类&#xff1a;实例化内部类&#xff0c;静态内部类&#xff0c;局部内部类和匿名内部类 public class OutClass {// 成员位置定义&#xff1a;未被static修饰 --->实例内部类public class InnerClass1{}// 成员位置定义&#xff1a;被…

01、创建型-单例模式--只有一个实例

文章目录 前言一、基本介绍1.1 什么是单例模式1.2 为什么要用单例模式1.3 应用场景1.4 单例优缺点 二、单例模式的实现方式2.1 饿汉式单例2.1.1 静态变量方式2.1.2 静态代码块 2.2 懒汉式单例2.2.1 懒汉式单例2.2.2 懒汉式优化①-线程安全2.2.2 懒汉式优化②-双重检查锁2.2.3 懒…

ROS1快速入门学习笔记 - 04创建工作环境与功能包

一、定义 工作空间(workspace)是一个存放工程开发相关文件的文件夹。 src:代码空间&#xff08;Source Space&#xff09;build: 编辑空间&#xff08;Build Space&#xff09;devel:开发空间&#xff08;Development Space&#xff09;install:安装空间&#xff08;Install …

深入理解Linux文件系统于日志分析

目录 一.Inode 和 block 概述 ​编辑 1.inode 的内容 &#xff08;1&#xff09;Inode 包含文件的元信息 &#xff08;2&#xff09;用 stat 命令可以查看某个文件的 inode 信息 &#xff08;3&#xff09; Linux系统文件三个主要的时间属性 &#xff08;4&#xff09;目…

CentOS 系统的优缺点

CentOS &#xff08;社区企业操作系统的缩写&#xff09;是一个基于红帽企业 Linux (RHEL)的免费开源发行版&#xff0c; 旨在为服务器和工作站提供稳定、可靠和安全的平台。 不应将其与CentOS Stream 混淆&#xff0c;后者是即将发布的 RHEL 版本的上游开发平台。 CentOS Li…

第67天:APP攻防-Frida反证书抓包移动安全系统资产提取评估扫描

思维导图 案例一&#xff1a;内在-资产提取-AppinfoScanne AppinfoScanner 一款适用于以 HW 行动/红队/渗透测试团队为场景的移动端(Android、iOS、WEB、H5、静态网站)信息收集扫描工具&#xff0c;可以帮助渗透测试工程师、攻击队成员、红队成员快速收集到移动端或者静态 WEB …

机器学习之sklearn基础教程

ChatGPT Scikit-learn (简称sklearn) 是一个非常受欢迎的Python机器学习库。它包含了从数据预处理到训练模型的各种工具。下面是一个关于如何使用sklearn进行机器学习的基础教程。 1. 安装和导入sklearn库 首先&#xff0c;你需要安装sklearn库&#xff08;如果你还没有安装的…

使用写入这类接口后,文件指针fp是否会偏移?

以fprintf为例&#xff1a; 在使用 fprintf 函数写入数据时&#xff0c;文件指针 fp 会自动进行偏移&#xff0c;以确保数据被写入到文件的正确位置。 每次调用 fprintf 函数都会将数据写入文件&#xff0c;并且文件指针会在写入完成后自动移动到写入的末尾&#xff0c;以便下…

56-FMC连接器电路设计

视频链接 FMC连接器电路设计01_哔哩哔哩_bilibili FMC连接器电路设计 1、FMC简介 1.1、FMC介绍 FMC&#xff08;FPGA Mezzanine Card&#xff09;是一个应用范围、适应环境范围和市场领域范围都很广的通用模块。FMC连接器连接了由FPGA提供的引脚和FMC子板的I/O接口。最新的…

NLP方面知识

NLP方面知识 一 基础1.Tokenizer1.1 分词粒度&#xff1a;1.2 大模型的分词粒度1.3 各路语言模型中的tokenizer 2.Embedding layer2.1 理解Embedding矩阵 一 基础 1.Tokenizer tokenizer总体上做三件事情&#xff1a; 分词。tokenizer将字符串分为一些sub-word token string&…

ISSCC论文详解:“闪电”数模混合存内计算,适应transformer和CNNs架构

本文聚焦存内计算前沿论文ISSCC 2024 34.3&#xff0c;总结归纳其创新点&#xff0c;并对与之相似的创新点方案进行归纳拓展。 一、文章基本信息 ISSCC 2024 34.4&#xff1a;《A 22nm 64kb Lightning-Like Hybrid Computing-in-Memory Macro with a Compressed Adder Tree a…

实验七 智能手机互联网程序设计(微信程序方向)实验报告

请编写一个用户登录界面&#xff0c;提示输入账号和密码进行登录&#xff0c;要求在输入后登陆框显示为绿色&#xff1b; 二、实验步骤与结果&#xff08;给出对应的代码或运行结果截图&#xff09; index.wxml <view class"content"> <view class"a…

Linux——界面和用户

本篇文章所写的都是基于centos 7 64位&#xff08;通过虚拟机运行&#xff09;。 一、Linux的界面 Linux操作系统提供了多种用户界面&#xff0c;主要分为图形用户界面&#xff08;GUI&#xff09;和命令行界面&#xff08;CLI&#xff09;。 1、图形用户界面(GUI)&#xff…

2024 年选择安全运营中心 (SOC) 工具指南

安全运营中心 (SOC) 是对抗网络威胁的前线。他们使用各种安全控制措施来监控、检测和快速响应任何网络威胁。这些控制措施对于确保信息系统全天候安全至关重要。 大型组织中的现代 SOC 与各种安全供应商合作&#xff0c;处理 75 到 100 种不同的工具。让我们探讨一下您可能遇到…

vue【vuex状态管理】

1&#xff1a;vuex是什么&#xff1a; vuex是一个状态管理工具&#xff0c;状态就是指的数据&#xff0c;可以将数据存放到vuex中以供其他组件使用时进行调用 2&#xff1a;应用场景&#xff1a; ①&#xff1a;像用户登录客户端&#xff0c;这个用户的数据需要在多个组件中…

天锐绿盾 | 文件资料透明加解密系统

"天锐绿盾 | 文件资料透明加解密系统" 是一款专为企业及各类组织机构设计的数据安全防护软件。它以“透明加解密”为核心技术&#xff0c;旨在对用户的重要文件资料进行实时、无缝的加密保护&#xff0c;确保数据在存储、传输和使用过程中的安全性&#xff0c;防止敏…