spring中 <context:component-scan>使用说明

本文详细解释了如何在XML配置文件中利用Spring的组件扫描功能自动注册带有特定注解的Bean,包括如何配置上下文扫描、包含过滤和排除过滤,以及在不同场景下的应用实例。
在xml配置了这个标签后,spring可以自动去扫描base-pack下面或者子包下面的java文件,如果扫描到有@Component @Controller@Service等这些注解的类,则把这些类注册为bean

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

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>指定的扫描

转自:http://blog.youkuaiyun.com/chunqiuwei/article/details/16115135
<think> 我们正在讨论Spring框架中的<context:component-scan>配置,特别是base-package属性设置为"com.student.controller"的情况。根据引用内容,我们可以总结如下: 1. <context:component-scan>的作用是让Spring容器扫描指定的包及其子包,并自动实例化带有特定注解(如@Component, @Controller, @Service, @Repository)的类,将它们注册为Springbean(引用[1][3][5])。 2. base-package属性指定了扫描的起始包。例如,base-package="com.student.controller"表示Spring会扫描com.student.controller包及其所有子包(引用[1][3])。 3. 默认情况下,Spring会为扫描到的类创建bean,并使用默认的命名策略:将类名的第一个字母小写作为bean的id。也可以在注解中通过value属性显式指定bean的名称(引用[5])。 4. 如果需要扫描多个包,可以配置多个<context:component-scan>标签,每个标签指定一个包(引用[4])。 5. 除了默认扫描的注解外,还可以使用<context:include-filter>来包含一些没有标准注解但希望被Spring管理的类(引用[2])。 因此,针对用户的问题,我们可以这样回答: <context:component-scan base-package="com.student.controller"/> 的作用是让Spring框架扫描com.student.controller包及其所有子包,并将其中带有Spring标准注解(如@Controller, @Component, @Service, @Repository)的类自动注册为Spring容器中的bean使用方法: 1. 在Spring的配置文件中(通常是applicationContext.xml或spring-mvc.xml)添加这个配置。 2. 确保在配置文件中声明了context命名空间(如引用[4]中的示例)。 3. 在com.student.controller包及其子包中的类上使用适当的注解(如@Controller)。 例如,在com.student.controller包中有一个StudentController类: ```java package com.student.controller; import org.springframework.stereotype.Controller; @Controller public class StudentController { // 控制器方法 } ``` Spring扫描到这个类后,会创建一个名为"studentController"(默认命名策略)的bean。 如果需要同时扫描多个包,可以配置多个<context:component-scan>标签,例如: ```xml <context:component-scan base-package="com.student.controller"/> <context:component-scan base-package="com.student.service"/> <context:component-scan base-package="com.student.dao"/> ``` 或者,也可以使用逗号、分号或空格分隔多个包名(注意:有些版本支持,但并不是所有版本都支持,所以多个标签更通用): ```xml <context:component-scan base-package="com.student.controller, com.student.service, com.student.dao"/> ``` 另外,还可以通过<context:include-filter>和<context:exclude-filter>来更精细地控制扫描行为。例如,包含没有标准注解的类,或者排除某些类。 例如,下面的配置除了扫描标准注解外,还包含一个自定义注解@MyAnnotation: ```xml <context:component-scan base-package="com.student"> <context:include-filter type="annotation" expression="com.student.annotation.MyAnnotation"/> </context:component-scan> ``` 注意事项: - 确保在类路径中有这些包,并且包结构正确。 - 注解的类必须被Spring的类路径扫描机制发现,因此要确保配置的包路径正确。 引用说明: [^1] 说明了<context:component-scan>的基本配置方式。 [^2] 提到了可以使用<context:include-filter>来包含非标准注解的类。 [^3] 解释了扫描和实例化的过程。 [^4] 展示了如何配置多个包扫描。 [^5] 提到了bean的命名策略。 根据以上内容,我们可以生成相关问题。 §§相关问题§§ 1. 如何在Spring中配置多个包的组件扫描? 2. <context:component-scan>中的include-filter和exclude-filter有什么作用? 3. Spring扫描组件时默认处理的注解有哪些? 4. 如何自定义Spring bean的名称? 5. 如果扫描的包路径配置错误,会出现什么问题? </think>### Spring `<context:component-scan base-package="com.student.controller"/>` 配置详解 #### 一、作用与核心功能 1. **自动扫描与组件注册** 该配置会扫描 `com.student.controller` 包及其所有子包,自动识别并注册带有以下注解的类为 Spring Bean- `@Controller`(控制器层) - `@Component`(通用组件) - `@Service`(服务层) - `@Repository`(数据访问层) 例如: ```java @Controller public class StudentController { ... } // 被自动注册为Bean ``` [^3][^5] 2. **依赖注入支持** 扫描范围内的类若使用 `@Autowired` 等注解,Spring 会自动完成依赖注入: ```java @Controller public class StudentController { @Autowired // 自动注入Service private StudentService studentService; } ``` 3. **Bean 命名规则** - 默认命名策略:类名首字母小写(如 `StudentController` → `studentController`) - 自定义命名:通过注解的 `value` 属性指定(如 `@Controller("myCtrl")`)[^5] --- #### 二、使用方法 1. **基础配置(XML格式)** 在 Spring 配置文件中添加: ```xml <context:component-scan base-package="com.student.controller"/> ``` > **注意**:需先声明 `context` 命名空间(引用[4]示例)[^4]。 2. **多包扫描方案** 若需扫描多个包,有两种方式: - **方式1**:配置多个 `component-scan` ```xml <context:component-scan base-package="com.student.controller"/> <context:component-scan base-package="com.student.service"/> ``` - **方式2**:用逗号/分号分隔包名 ```xml <context:component-scan base-package="com.student.controller, com.student.service"/> ``` [^4] 3. **过滤扫描范围** 通过子标签精细控制: ```xml <context:component-scan base-package="com.student"> <!-- 包含非标准注解的类 --> <context:include-filter type="annotation" expression="com.student.annotation.CustomComponent"/> <!-- 排除特定类 --> <context:exclude-filter type="regex" expression=".*Test"/> </context:component-scan> ``` [^2] --- #### 三、常见问题与解决方案 1. **扫描未生效** - **检查点**: ✅ 包路径是否拼写错误(如 `com.student.controller` ≠ `com.student.controler`) ✅ 类是否在子包中(扫描仅覆盖指定包及其子包) ✅ XML 中是否声明了 `context` 命名空间(引用[4])[^4] 2. **Bean 名称冲突** - **解决**:通过注解显式命名 ```java @Controller("studentCtrl") public class StudentController { ... } ``` 3. **性能优化** - 限定扫描范围(如明确指定 `base-package` 而非整个项目根包) - 使用 `exclude-filter` 过滤测试类/第三方库 --- #### 四、典型应用场景 - **Spring MVC 控制器**:自动注册 `@Controller` 处理 HTTP 请求。 - **分层架构**:与 `@Service`、`@Repository` 配合实现三层架构。 - **模块化开发**:按模块分包扫描(如 `controller`/`service`/`dao`)。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值