Spring context:component-scan使用说明

本文详细介绍了Spring框架中<context:component-scan>的使用方法,包括如何通过<context:include-filter>和<context:exclude-filter>精确控制扫描范围,以及use-default-filters属性的作用。

   在xml配置了这个标签后,spring可以自动去扫描base-pack下面或者子包下面的java文件,如果扫描到有@Component @Controller@Service等这些注解的类,则把这些类注册为bean

   注意:如果配置了<context:component-scan>那么<context:annotation-config/>标签就可以不用再xml中配置了,因为前者包含了后者。另外<context:component-scan>还提供了两个子标签

1.        <context:include-filter>

2.       <context:exclude-filter>

在说明这两个子标签前,先说一下<context:component-scan>有一个use-default-filters属性,该属性默认为true,这就意味着会扫描指定包下的全部的标有@Component的类,并注册成bean.也就是@Component的子注解@Service,@Reposity。所以如果仅仅是在配置文件中这么写

<context:component-scan base-package="tv.huan.weisp.web"/>

 Use-default-filter此时为true那么会对base-package包或者子包下的所有的进行java类进行扫描,并把匹配的java类注册成bean。

 可以发现这种扫描的粒度有点太大,如果你只想扫描指定包下面的Controller,该怎么办?此时子标签<context:incluce-filter>就起到了勇武之地。如下所示

<context:component-scan base-package="tv.huan.weisp.web .controller">  

<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>   

</context:component-scan>  

这样就会只扫描base-package指定下的有@Controller下的java类,并注册成bean

   但是因为use-dafault-filter在上面并没有指定,默认就为true,所以当把上面的配置改成如下所示的时候,就会产生与你期望相悖的结果(注意base-package包值得变化)

<context:component-scan base-package="tv.huan.weisp.web">  

<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>   

</context:component-scan>  

此时,spring不仅扫描了@Controller,还扫描了指定包所在的子包service包下注解@Service的java类

此时指定的include-filter没有起到作用,只要把use-default-filter设置成false就可以了。这样就可以避免在base-packeage配置多个包名这种不是很优雅的方法来解决这个问题了。

另外在我参与的项目中可以发现在base-package指定的包中有的子包是不含有注解了,所以不用扫描,此时可以指定<context:exclude-filter>来进行过滤,说明此包不需要被扫描。综合以上说明

Use-dafault-filters=”false”的情况下:<context:exclude-filter>指定的不扫描,<context:include-filter>指定的扫描

<think> 我们正在讨论Spring框架中的两个配置元素:<context:annotation-config>和<context:component-scan>。 用户之前的问题和回答历史中没有直接相关的内容,因此我们直接针对这个问题进行回答。 首先,这两个配置都是用来启用Spring注解驱动的功能,但它们的作用范围不同。 1. <context:annotation-config> 作用:用于激活已经在Spring容器中注册的bean(无论是通过XML配置还是通过编程方式注册)上的注解。 它处理的注解包括:@Autowired, @Resource, @Required, @Value等(以及JSR-250和JPA的注解,如果类路径中有相应的支持)。 注意:它不会去扫描和注册新的bean,仅仅是对已经存在的bean进行处理。 2. <context:component-scan> 作用:除了包含<context:annotation-config>的功能(即处理上述注解)之外,它还会自动扫描指定的包路径,将带有@Component(以及其派生注解如@Repository, @Service, @Controller)的类注册为Spring容器中的bean。 因此,它比<context:annotation-config>更强大,因为它可以自动发现并注册bean,同时也会激活注解配置。 因此,通常如果我们使用<context:component-scan>,就不需要再单独配置<context:annotation-config>了。 下面通过一个例子来说明: 假设我们有一个服务类和一个DAO类,都使用了注解。 使用<context:annotation-config>的情况: 我们需要在XML中显式定义bean,例如: <bean id="myService" class="com.example.MyService"/> <bean id="myDao" class="com.example.MyDao"/> 然后配置<context:annotation-config/>,这样Spring就会处理这些bean上的注解(比如在MyService中使用了@Autowired来注入myDao)。 使用<context:component-scan>的情况: 我们只需要配置: <context:component-scan base-package="com.example"/> 这样,Spring会扫描com.example包,将带有@Component等注解的类自动注册为bean,并且也会处理这些bean上的自动装配注解。 总结: - <context:annotation-config>仅处理已注册bean上的注解,不扫描新bean。 - <context:component-scan>既扫描并注册bean,同时也处理这些bean上的注解(包含了<context:annotation-config>的功能)。 因此,在大多数现代Spring应用中,通常直接使用<context:component-scan>,因为它提供了更简洁的配置(减少XML配置)。 注意:在Spring 3.0及以上版本,<context:component-scan>已经包含了<context:annotation-config>的功能,所以同时配置两者不会有额外的好处,但也不会造成错误(只是冗余)。 引用说明:以上内容参考了Spring官方文档[^1]和常见的最佳实践。 相关问题: 1. 在Spring框架中,除了<context:component-scan>,还有哪些方式可以注册bean? 2. 如何自定义组件扫描的过滤器? 3. @Autowired和@Resource注解有什么区别? </think> 在Spring框架中,`<context:annotation-config>`和`<context:component-scan>`都是用于简化配置的核心功能,但它们的职责和覆盖范围有显著区别: ### 1. **`<context:annotation-config>`** - **功能**:仅**启用注解处理器** 激活对已注册Bean上的注解(如`@Autowired`, `@Resource`, `@Required`, `@Value`等)的处理,但它**不会自动发现或注册Bean**。 - **使用场景**: ```xml <!-- 显式定义Bean --> <bean id="myService" class="com.example.MyService"/> <bean id="myDao" class="com.example.MyDao"/> <!-- 启用已有Bean的注解处理 --> <context:annotation-config/> ``` - ✅ 处理`MyService`中`@Autowired`注入`MyDao` - ❌ 无法自动扫描并注册新的Bean ### 2. **`<context:component-scan>`** - **功能**:**自动扫描注册Bean + 启用所有注解处理器** 扫描指定包路径,自动将带有`@Component`, `@Service`, `@Repository`, `@Controller`等注解的类注册为Spring Bean,同时**隐式包含`<context:annotation-config>`的所有功能**。 - **使用场景**: ```xml <!-- 自动扫描并注册Bean,同时启用注解处理 --> <context:component-scan base-package="com.example"/> ``` - ✅ 自动注册`com.example`包下所有带注解的类(如`@Service`) - ✅ 处理这些Bean中的依赖注入(如`@Autowired`) --- ### ⚡ 核心区别总结 | **特性** | `<context:annotation-config>` | `<context:component-scan>` | |-------------------------|-------------------------------|-------------------------------------| | **Bean注册** | ❌ 不注册新Bean | ✅ 自动扫描并注册Bean | | **注解处理** | ✅ 处理已存在Bean的注解 | ✅ 处理所有Bean的注解 | | **包含关系** | 独立功能 | **隐含`<context:annotation-config>`** | | **典型使用场景** | 配合显式XML定义的Bean使用 | 基于注解的自动配置 | --- ### 💡 最佳实践 - **优先使用`<context:component-scan>`**:现代Spring项目通常直接用它简化配置,避免冗余的XML定义[^1]。 - **避免同时使用两者**:`<context:component-scan>`已包含注解处理功能,同时配置会导致重复处理(无实际错误,但冗余)[^2]。 > 示例:若项目中所有Bean均通过注解(如`@Service`)定义,只需: > ```xml > <context:component-scan base-package="com.example"/> > ```
评论 37
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

郭梧悠

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值