<context:component-scan>包掃描的坑

公司項(xiàng)目配置的Spring項(xiàng)目的包掃描有點(diǎn)問題，出現(xiàn)了一個(gè)被Spring容器管理的Bean被創(chuàng)建了2次的現(xiàn)象。在此記錄下解決的過程，方便后續(xù)查閱。

改動(dòng)前

容器啟動(dòng)監(jiān)聽器中會(huì)掃描全部包，創(chuàng)建實(shí)例 

SpringMVC配置文件也會(huì)掃描全部包，創(chuàng)建實(shí)例

產(chǎn)生的問題：加了注解的類的實(shí)例都創(chuàng)建了2個(gè)

改動(dòng)后

容器啟動(dòng)監(jiān)聽器里面負(fù)責(zé)非Controller層bean的創(chuàng)建

SpingMVC配置文件里只負(fù)責(zé)Controller層bean的創(chuàng)建

<context:component-scan>的使用說明

在xml配置了這個(gè)標(biāo)簽后，spring可以自動(dòng)去掃描base-package下面或者子包下面的java文件，如果掃描到有@Component @Controller@Service等這些注解的類，則把這些類注冊(cè)為bean

注意：如果配置了<context:component-scan>那么<context:annotation-config/>標(biāo)簽就可以不用再xml中配置了，因?yàn)榍罢甙撕笳摺?/p>

<context:annotation-config/>提供了兩個(gè)子標(biāo)簽

<context:include-filter>
<context:exclude-filter>

再說明這兩個(gè)子標(biāo)簽前，先說一下<context:component-scan>有一個(gè)use-default-filters屬性，改屬性默認(rèn)為true,這就意味著會(huì)掃描指定包下的全部的標(biāo)有@Component的類，并注冊(cè)成bean.也就是@Component的子注解@Service,@Reposity等。所以如果僅僅是在配置文件中這么寫

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

use-default-filter此時(shí)為true那么會(huì)對(duì)base-package包或者子包下的所有的進(jìn)行java類進(jìn)行掃描,并把匹配的java類注冊(cè)成bean。

可以發(fā)現(xiàn)這種掃描的粒度有點(diǎn)太大，如果你只想掃描指定包下面的Controller，該怎么辦？此時(shí)子標(biāo)簽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> ?

這樣就會(huì)只掃描base-package指定下的有@Controller下的java類，并注冊(cè)成bean

但是因?yàn)閡se-dafault-filter在上面并沒有指定，默認(rèn)就為true，所以當(dāng)把上面的配置改成如下所示的時(shí)候，就會(huì)產(chǎn)生與你期望相悖的結(jié)果（注意base-package包值得變化）

<context:component-scan base-package="tv.huan.weisp.web "> ?
<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/> ??
</context:component-scan> ?

此時(shí)，spring不僅掃描了@Controller，還掃描了指定包所在的子包service包下注解@Service的java類

此時(shí)指定的include-filter沒有起到作用，只要把use-default-filter設(shè)置成false就可以了。這樣就可以避免在base-packeage配置多個(gè)包名這種不是很優(yōu)雅的方法來解決這個(gè)問題了。

另外在我參與的項(xiàng)目中可以發(fā)現(xiàn)在base-package指定的包中有的子包是不含有注解了，所以不用掃描，此時(shí)可以指定<context:exclude-filter>來進(jìn)行過濾，說明此包不需要被掃描。綜合以上說明

use-dafault-filters=”false”的情況下：

<context:exclude-filter>指定的不掃描，<context:include-filter>指定的掃描

定位問題原因* 根據(jù)原因思考問題解決方案* 實(shí)踐驗(yàn)證方案有效性* 提交驗(yàn)證結(jié)果

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論