1. 程式人生 > >Spring和Spring MVC包掃描

Spring和Spring MVC包掃描

enc 是個 原因 官方 drive XML 映射 下層 filter

在Spring整體框架的核心概念中,容器是核心思想,就是用來管理Bean的整個生命周期的,而在一個項目中,容器不一定只有一個,Spring中可以包括多個容器,而且容器有上下層關系,目前最常見的一種場景就是在一個項目中引入Spring和SpringMVC這兩個框架,那麽它其實就是兩個容器,Spring是父容器,SpringMVC是其子容器,並且在Spring父容器中註冊的Bean對於SpringMVC容器中是可見的,而在SpringMVC容器中註冊的Bean對於Spring父容器中是不可見的,也就是子容器可以看見父容器中的註冊的Bean,反之就不行。

springmvc 的配置文件和spring的配置文件都可以配置包掃描,如下:

<context:component-scan base-package="com.xxx"/>

從Spring提供的參考手冊中我們得知該配置的功能是掃描配置的base-package包下的所有使用了@Component註解的類,並且將它們自動註冊到容器中,同時也掃描@Controller,@Service,@Respository這三個註解,因為他們是繼承自@Component。

在項目中我們經常見到還有如下這個配置,其實有了上面的配置,這個是可以省略掉的,因為上面的配置會默認打開以下配置。以下配置會默認聲明了@Required、@Autowired、 @PostConstruct、@PersistenceContext、@Resource、@PreDestroy等註解。

<context:annotation-config/>

另外,還有一個和SpringMVC相關如下配置,經過驗證,這個是SpringMVC必須要配置的,因為它聲明了@RequestMapping、@RequestBody、@ResponseBody等。並且,該配置默認加載很多的參數綁定方法,比如json轉換解析器等。

<mvc:annotation-driven />

下面讓我們來詳細扒一扒Spring與SpringMVC的容器沖突的原因到底在那裏?

  我們共有Spring和SpringMVC兩個容器,它們的配置文件分別為applicationContext.xml和applicationContext-MVC.xml。

  1.在applicationContext.xml中配置了<context:component-scan base-package=“com.hafiz.www" />,負責所有需要註冊的Bean的掃描和註冊工作。

  2.在applicationContext-MVC.xml中配置<mvc:annotation-driven />,負責SpringMVC相關註解的使用。

  3.啟動項目我們發現SpringMVC無法進行跳轉,將log的日誌打印級別設置為DEBUG進行調試,發現SpringMVC容器中的請求好像沒有映射到具體controller中。

  4.在applicationContext-MVC.xml中配置<context:component-scan base-package=“com.hafiz.www" />,重啟後,驗證成功,springMVC跳轉有效。

下面我們來查看具體原因,翻看源碼,從SpringMVC的DispatcherServlet開始往下找,我們發現SpringMVC初始化時,會尋找SpringMVC容器中的所有使用了@Controller註解的Bean,來確定其是否是一個handler。1,2兩步的配置使得當前springMVC容器中並沒有註冊帶有@Controller註解的Bean,而是把所有帶有@Controller註解的Bean都註冊在Spring這個父容器中了,所以springMVC找不到處理器,不能進行跳轉。

按照官方推薦根據不同的業務模塊來劃分不同容器中註冊不同類型的Bean:Spring父容器負責所有其他非@Controller註解的Bean的註冊,而SpringMVC只負責@Controller註解的Bean的註冊,使得他們各負其責、明確邊界。配置方式如下

  1.在applicationContext.xml中配置:

<!-- Spring容器中註冊非@controller註解的Bean -->
<context:component-scan base-package="com.hafiz.www"> <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/> </context:component-scan>

  2.applicationContext-MVC.xml中配置

<!-- SpringMVC容器中只註冊帶有@controller註解的Bean -->
<context:component-scan base-package="com.hafiz.www" use-default-filters="false"> <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller" /> </context:component-scan>

不要讓兩個掃描有重疊。原因有如下幾點:

  1. 掃描的類增多, 項目啟動時間會延長
  2. @PostConstruct 註解標註的方法會執行2次
  3. 會使事務失效

對於第三點會使事物失效,原因是什麽?
同時使用springmvc 和 spring, 那麽項目中就會有兩個容器。
spring的是父容器,先進行初始化; springmvc是子容器, 後進行初始化。子容器可以訪問父容器的bean,父容器不能訪問子容器的bean。
springmvc後初始化,會重新創建service對象並重新註入,而springmvc再次創建service對象時不會讀取spring的配置文件,因此也就無法知道service層是需要創建代理對象的,所以springmvc創建的service是普通的對象,而不是動態代理對象。

解決重疊掃描的方式

  • 方式1

即上面提到的 springmvc 只掃描controller的包, spring掃描其他組件。
springmvc 配置如下:

<context:component-scan base-package="com.xxx.**.cotroller"/> 

springmvc只會掃描com.xxx下任意目錄或子目錄下的controller包下的類

spring的配置如下:

<context:component-scan base-package="com.xxx.**.service.impl,com.xxx.**.dao"/>  
  • 方式2

用<context:include-filter/> 或 <context:exclude-filter/> 指定或排除某些類
假設springmvc掃描如下:

<context:component-scan base-package="com.xxx.**.service.impl,com.xxx.**.dao"/> 

spring掃描如下:

<context:component-scan base-package="com.xxx"/>

那麽就會重疊,springmvc會掃描service和dao,可以這樣修改springmvc的配置:

<context:component-scan base-package="com.xxx">  
  <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>  
  <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Repository"/>  
</context> 

用 <context:exclude-filter/> 排除了@Service 和 @Repository 兩種註解標註的類,意思是告訴springmvc在掃描時,如果碰到這兩個註解標註的類直接忽略,不要創建和註入對象。

方式1比方式2好,掃描的類更少,方式2僅僅是個例子,看起來有點畫蛇添足。故意讓springmvc掃描service和dao的包,又告訴他掃描時忽略service和dao,我僅僅是想引出還有<context:include-filter/> 和 <context:exclude-filter/> 這個配置. 有些特殊場景才用得上這個配置。

參考資料

http://www.cnblogs.com/hafiz/p/5875740.html

Spring和Spring MVC包掃描