关于SpingMVC的<context:component-scan>包扫描踩坑记录
目录
- <context:component-scan>包扫描的坑
- 改动前
- 改动后
- <context:component-scan>的使用说明
- <context:annotation-config/>提供了两个子标签
<context:component-scan>包扫描的坑
公司项目配置的Spring项目的包扫描有点问题,出现了一个被Spring容器管理的Bean被创建了2次的现象。在此记录下解决的过程,方便后续查阅。
改动前
容器启动监听器中会扫描全部包,创建实例
SpringMVC配置文件也会扫描全部包,创建实例
产生的问题:加了注解的类的实例都创建了2个
改动后
容器启动监听器里面负责非Controller层bean的创建
SpingMVC配置文件里只负责Controller层bean的创建
<context:component-scan>的使用说明
在xml配置了这个标签后,spring可以自动去扫描base-package下面或者子包下面的java文件,如果扫描到有@Component @Controller@Service等这些注解的类,则把这些类注册为bean
注意:如果配置了<context:component-scan>那么<context:annotation-config/>标签就可以不用再xml中配置了,因为前者包含了后者。
<context:annotation-config/>提供了两个子标签
<context:include-filter> <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>指定的扫描
定位问题原因* 根据原因思考问题解决方案* 实践验证方案有效性* 提交验证结果
以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。