【轉】ContextLoaderListener 和 DispatcherServlet

Amei1314發表於2016-07-18
ContextServlet

轉載地址： http://www.guoweiwei.com/archives/797

DispatcherServlet介紹

DispatcherServlet是Spring前端控制器的實現，提供Spring Web MVC的集中訪問點，並且負責職責的分派，與Spring IoC容器無縫整合，從而可以獲得Spring的所有好處。

DispatcherServlet主要用作職責排程工作，本身主要用於控制流程，主要職責如下：

1、檔案上傳解析，如果請求型別是multipart將通過MultipartResolver進行檔案上傳解析；
2、通過HandlerMapping，將請求對映到處理器（返回一個HandlerExecutionChain，它包括一個處理器、多個HandlerInterceptor攔截器）；
3、通過HandlerAdapter支援多種型別的處理器(HandlerExecutionChain中的處理器)；
4、通過ViewResolver解析邏輯檢視名到具體檢視實現；
5、本地化解析；
6、渲染具體的檢視等；
7、如果執行過程中遇到異常將交給HandlerExceptionResolver來解析。

 

DispatcherServlet預設使用WebApplicationContext作為上下文，Spring預設配置檔案為“/WEB-INF/[servlet名字]-servlet.xml”。

DispatcherServlet也可以配置自己的初始化引數，覆蓋預設配置：

引數

描述

contextClass

實現WebApplicationContext介面的類，當前的servlet用它來建立上下文。如果這個引數沒有指定， 預設使用XmlWebApplicationContext。

contextConfigLocation

傳給上下文例項（由contextClass指定）的字串，用來指定上下文的位置。這個字串可以被分成多個字串（使用逗號作為分隔符） 來支援多個上下文（在多上下文的情況下，如果同一個bean被定義兩次，後面一個優先）。
預設為/WEB-INF/[server-name]-servlet.xml

namespace

WebApplicationContext名稱空間。預設值是[server-name]-servlet。

如下：

<servlet>
        <servlet-name>demo</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-servlet-config.xml</param-value>
        </init-param>
</servlet>
<servlet-mapping>
        <servlet-name>demo</servlet-name>
        <url-pattern>/</url-pattern>
</servlet-mapping>

 

Servlet上下文關係

DispatcherServlet的上下文是通過配置servlet的contextConfigLocation來載入的，預設實現是XmlWebApplicationContext。

值得注意的是DispatcherServlet的上下文僅僅是 Spring MVC的上下文，而Spring載入的上下文是通過ContextLoaderListener來載入的。一般spring web專案中同時會使用這兩種上下文，前者僅負責MVC相關bean的配置管理（如ViewResolver、Controller、 MultipartResolver等），後者則負責整個spring相關bean的配置管理（如相關Service、DAO等）。

因此在/WEB-INF/[server-name]-servlet.xml中配置的Bean一般只針對Spring MVC有效，而在ContextLoaderListener配置檔案下配置的bean則對整個spring有效。

上下文建立完後會放在ServletContext物件中，其中ContextLoaderListener載入的上下文放在 ServletContext的key為 WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE屬性中，而 DispatcherServlet載入的上下文在每次請求時會放一份在request物件的key為 WEB_APPLICATION_CONTEXT_ATTRIBUTE屬性中。因而兩者的獲取方式也不一樣，前者可以通過 WebApplicationContextUtils.getRequiredWebApplicationContext(servletContext) 或WebApplicationContextUtils.getWebApplicationContext(servletContext)或 WebApplicationContextUtils.getWebApplicationContext(servletContext,attrname) 方法來獲取對應的applicationContext，而後者則通過 RequestContextUtils.getWebApplicationContext(request)或 WebApplicationContextUtils.getWebApplicationContext(servletContext,attrname) 方法來獲取對應的applicationContext。
注：對於ContextLoaderListener載入的上下文，attrname即上面提到的 WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE；而對於 DispatcherServlet中的上下文則為FrameworkServlet.class.getName() + ".CONTEXT." + getServletName()

 

通過上下文所在的屬性可以看出，如果通過 WebApplicationContextUtils.getRequiredWebApplicationContext(servletContext) 來試圖獲取DispatcherServlet載入的applicationContext時，就會丟擲"No WebApplicationContext found: no ContextLoaderListener registered?"的異常。

 

DispatcherServlet中使用的特殊的Bean

DispatcherServlet預設使用WebApplicationContext作為上下文，因此我們來看一下該上下文中有哪些特殊的Bean：

1、Controller：處理器/頁面控制器，做的是MVC中的C的事情，但控制邏輯轉移到前端控制器了，用於對請求進行處理；

2、HandlerMapping：請求到處理器的對映，如果對映成功返回一個HandlerExecutionChain物件（包含一個Handler 處理器（頁面控制器）物件、多個HandlerInterceptor攔截器）物件；如BeanNameUrlHandlerMapping將URL與 Bean名字對映，對映成功的Bean就是此處的處理器；

3、HandlerAdapter：HandlerAdapter將會把處理器包裝為介面卡，從而支援多種型別的處理器，即介面卡設計模式的應用，從而很 容易支援很多型別的處理器；如SimpleControllerHandlerAdapter將對實現了Controller介面的Bean進行適配，並 且掉處理器的handleRequest方法進行功能處理；

4、ViewResolver：ViewResolver將把邏輯檢視名解析為具體的View，通過這種策略模式，很容易更換其他檢視技術；如InternalResourceViewResolver將邏輯檢視名對映為jsp檢視；

5、LocalResover：本地化解析，因為Spring支援國際化，因此LocalResover解析客戶端的Locale資訊從而方便進行國際化；

6、ThemeResovler：主題解析，通過它來實現一個頁面多套風格，即常見的類似於軟體皮膚效果；

7、MultipartResolver：檔案上傳解析，用於支援檔案上傳；

8、HandlerExceptionResolver：處理器異常解析，可以將異常對映到相應的統一錯誤介面，從而顯示使用者友好的介面（而不是給使用者看到具體的錯誤資訊）；

9、RequestToViewNameTranslator：當處理器沒有返回邏輯檢視名等相關資訊時，自動將請求URL對映為邏輯檢視名；

10、FlashMapManager：用於管理FlashMap的策略介面，FlashMap用於儲存一個請求的輸出，當進入另一個請求時作為該請求的輸入，通常用於重定向場景
 

通過以上的bean可以看出，一般LocalResover、ViewResolver等需要配置在/WEB-INF/[server-name]-servlet.xml檔案中。

相關文章