Spring和SpringMVC父子容器關係初窺

1、背景

　　最近因爲項目的包掃描出現了問題，在解決問題的過程當中，偶然發現了Spring和SpringMVC是有父子容器關係的，並且正是由於這個才每每會出現包掃描的問題，咱們在此來分析和理解Spring和SpringMVC的父子容器關係而且給出Spring和SpringMVC配置文件中包掃描的官方推薦方式。

2、概念理解和知識鋪墊

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

　　咱們可使用統一的以下註解配置來對Bean進行批量註冊，而不須要再給每一個Bean單獨使用xml的方式進行配置。

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

　　從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 />

而上面這句配置spring3.1以前的版本和如下配置方式等價

<!--配置註解控制器映射器,它是SpringMVC中用來將Request請求URL到映射到具體Controller-->
<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>
<!--配置註解控制器映射器,它是SpringMVC中用來將具體請求映射到具體方法-->
<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

spring3.1以後的版本和如下配置方式等價

<!--配置註解控制器映射器,它是SpringMVC中用來將Request請求URL到映射到具體Controller-->
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>
<!--配置註解控制器映射器,它是SpringMVC中用來將具體請求映射到具體方法-->
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"/>

3、具體場景分析

　　下面讓咱們來詳細扒一扒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找不處處理器，不能進行跳轉。核心源碼以下:

protected void initHandlerMethods() {
　　if (logger.isDebugEnabled()) {
　　　　logger.debug("Looking for request mappings in application context: " + getApplicationContext());
　　}
　　String[] beanNames = (this.detectHandlerMethodsInAncestorContexts ?
　　　　　　  BeanFactoryUtils.beanNamesForTypeIncludingAncestors(getApplicationContext(), Object.class) :
　　　　　　　getApplicationContext().getBeanNamesForType(Object.class));
　　for (String beanName : beanNames) {
　　　　if (isHandler(getApplicationContext().getType(beanName))){
　　　　　　detectHandlerMethods(beanName);
　　　　}
　　}
　　handlerMethodsInitialized(getHandlerMethods());
}

在方法isHandler中會判斷當前bean的註解是不是controller，源碼以下：

protected boolean isHandler(Class<?> beanType) {
　　return AnnotationUtils.findAnnotation(beanType, Controller.class) != null;
}

而在第4步配置中，SpringMVC容器中也註冊了全部帶有@Controller註解的Bean，故SpringMVC能找處處理器進行處理，從而正常跳轉。

咱們找到了出現不能正確跳轉的緣由，那麼它的解決辦法是什麼呢？

　　咱們注意到在initHandlerMethods()方法中，detectHandlerMethodsInAncestorContexts這個Switch，它主要控制獲取哪些容器中的bean以及是否包括父容器，默認是不包括的。因此解決辦法就是在springMVC的配置文件中配置HandlerMapping的detectHandlerMethodsInAncestorContexts屬性爲true便可（這裏須要根據具體項目看使用的是哪一種HandlerMapping），讓它檢測父容器的bean。以下：

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
   <property name="detectHandlerMethodsInAncestorContexts">
       <value>true</value>
   </property>
</bean>

但在實際工程中會包括不少配置，咱們按照官方推薦根據不一樣的業務模塊來劃分不一樣容器中註冊不一樣類型的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>

關於use-default-filters="false"的做用，請參見另外一篇博客：context:component-scan標籤的use-default-filters屬性的做用以及原理分析

3、總結

　　這樣咱們在清楚了spring和springMVC的父子容器關係、以及掃描註冊的原理之後，根據官方建議咱們就能夠很好把不一樣類型的Bean分配到不一樣的容器中進行管理。再出現Bean找不到或者SpringMVC不能跳轉以及事務的配置失效的問題，咱們就能夠很快的定位以及解決問題了。很開心，有木有~