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

Spring :component-scan

在 Java Spring 框架中,component-scan 是用于‌自动扫描并注册带有特定注解的组件(如 @Component、@Service、@Repository、@Controller)到 Spring 容器中的机制‌。它有两种主要使用方式:‌XML 配置方式‌ 和 ‌Java 注解方式‌。
一、XML 配置方式(传统方式)

通过在 Spring 的 XML 配置文件中使用 <context:component-scan> 标签来指定扫描包路径:
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">

<context:component-scan base-package="com.example.myapp" />
</beans>

‌作用‌:扫描 com.example.myapp 包及其子包下所有标注了 @Component 及其衍生注解(@Service、@Repository、@Controller)的类,并将它们注册为 Spring Bean。
‌适用场景‌:基于 XML 配置的传统 Spring 项目。

二、Java 注解方式(现代推荐方式)

使用 @ComponentScan 注解配合 @Configuration 类进行配置:
@Configuration
@ComponentScan(basePackages = "com.example.myapp")
public class AppConfig {
}

或简写为:
@Configuration
@ComponentScan("com.example.myapp")
public class AppConfig {
}

‌默认行为‌:若未指定包路径,则默认扫描该配置类所在包及其子包。
‌适用场景‌:Spring Boot 或基于 Java 配置的现代 Spring 应用。

三、常用属性与高级用法

@ComponentScan 提供了丰富的过滤和控制选项:

‌basePackages / value‌:指定要扫描的包路径(可多个)。
‌excludeFilters‌:排除某些组件(如排除所有 @Controller)。
‌includeFilters‌:仅包含符合规则的组件(需配合 useDefaultFilters = false)。
‌useDefaultFilters‌:是否启用默认扫描(默认 true,即扫描 @Component 等注解)。
‌FilterType 类型‌:
ANNOTATION:按注解类型过滤。
ASSIGNABLE_TYPE:按类或接口类型过滤。
REGEX:按正则表达式匹配类名。
CUSTOM:自定义过滤逻辑(需实现 TypeFilter 接口)。

示例:仅扫描 @Repository 注解的类
@ComponentScan(
basePackages = "com.example",
includeFilters = @Filter(type = FilterType.ANNOTATION, classes = Repository.class),
useDefaultFilters = false
)

示例:排除所有 @Controller 类
@ComponentScan(
basePackages = "com.example",
excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = Controller.class)
)

四、注意事项

‌包结构影响扫描范围‌:若启动类(含 @SpringBootApplication)在 com.example.app,则默认只扫描该包及子包,其他包需显式指定。
‌避免重复扫描‌:在多模块项目中,应合理规划包结构和扫描路径,防止冲突或遗漏。
‌性能考虑‌:扫描范围过大可能影响启动速度,建议精确配置。

http://www.cnnetsun.cn/news/1998172.html

相关文章:

  • Spring MVC配置文件
  • Chain-of-Recursive-Thoughts扩展开发:如何集成新的AI模型和自定义功能
  • Rspamd Lua API开发指南:如何编写自定义插件扩展垃圾邮件过滤功能
  • 开发全民基础财税智能知识普及测评答题编程工具,定制普惠题库,答题打分,判定大众财税认知等级定向推送教学内容。
  • 2025届最火的五大AI辅助写作方案横评
  • DOL-Lyra整合包终极指南:5分钟打造个性化Degrees of Lewdity游戏体验
  • 速腾M1激光雷达ROS驱动编译避坑指南(Ubuntu 18.04 + ROS Melodic实测)
  • Z-Image在windows系统中部署方法(精要总结教程)
  • LxgwNeoXiHei特殊符号支持:易经、麻将、象棋符号全解析
  • 设计系统已死?AI时代的两种终极范式对决:Awesome DESIGN.md vs UI UX Pro Max
  • Dify信创适配紧急通告:2024Q3起所有未通过工信部《智能体平台国产化兼容性认证》的部署将无法通过验收(附自测工具包)
  • nli-distilroberta-base完整指南:镜像定制、API封装、健康检查一体化部署
  • 别再乱用map和unordered_map了!C++面试官最爱问的底层区别与实战选型指南
  • 三相PWM整流器设计避坑指南:电感、电容、开关管选型如何影响系统稳定性?
  • 用腾讯云COS给Obsidian笔记找个家:Remotely Save插件保姆级配置教程(含CORS避坑)
  • 5分钟打造专属视频门户:MediaCMS让媒体管理从未如此简单
  • 3步实现MASA模组中文界面:专业汉化资源包解决方案
  • 为了简化编程,提高开发速度我采用火山免费版+付费版本
  • 一种废弃打印纸可用区域的自动识别和再利用方法
  • 3个核心技巧:高效掌握HLS流媒体下载与解密技术
  • 月检需求分析2
  • VS2013玩转OpenGL:从环境搭建到画出第一个彩色三角形(GLEW/GLUT库详解)
  • 一个用 Rust 编写的、速度极快的 Python 包和项目管理器
  • OptiBPM应用:光功率耦合器
  • 西门子S7-200smart PLC通过RS485通讯读取绝对值伺服编码器当前位置并记录至机械...
  • Delphi 11发布前必做的5件事:从免费手册到早鸟优惠,手把手教你平滑升级
  • Stable-Diffusion-V1-5 作品集:探索不同采样器与模型架构的视觉差异
  • Python自动化文件批量格式转换工具
  • 易语言大漠脚本进阶:手把手封装一套防检测的‘智能鼠标’与‘记忆键盘’模块
  • EF Core 10向量搜索接入避坑清单,92%开发者踩过的7个隐性陷阱(含迁移脚本生成失效、HNSW索引自动降级等)