web.xml配置中dispatcherservlet詳解
3.1、DispatcherServlet作用
DispatcherServlet是前端控制器設計模式的實現,提供Spring Web MVC的集中訪問點,而且負責職責的分派,而且與Spring IoC容器無縫整合,從而可以獲得Spring的所有好處。 具體請參考第二章的圖2-1。
DispatcherServlet主要用作職責排程工作,本身主要用於控制流程,主要職責如下:
1、檔案上傳解析,如果請求型別是multipart將通過MultipartResolver進行檔案上傳解析;
2、通過HandlerMapping,將請求對映到處理器(返回一個HandlerExecutionChain,它包括一個處理器、多個HandlerInterceptor攔截器);
3、 通過HandlerAdapter支援多種型別的處理器(HandlerExecutionChain中的處理器);
4、通過ViewResolver解析邏輯檢視名到具體檢視實現;
5、本地化解析;
6、渲染具體的檢視等;
7、如果執行過程中遇到異常將交給HandlerExceptionResolver來解析。
從以上我們可以看出DispatcherServlet主要負責流程的控制(而且在流程中的每個關鍵點都是很容易擴充套件的)。
3.2、DispatcherServlet在web.xml中的配置
- <servlet>
- <servlet-name>chapter2</servlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>chapter2</servlet-name>
- <url-pattern>/</url-pattern>
- </servlet-mapping>
load-on-startup:表示啟動容器時初始化該Servlet;
url-pattern:表示哪些請求交給Spring Web MVC處理, “/” 是用來定義預設servlet對映的。也可以如“*.html”表示攔截所有以html為副檔名的請求。
該DispatcherServlet預設使用WebApplicationContext作為上下文,Spring預設配置檔案為“/WEB-INF/[servlet名字]-servlet.xml”。
DispatcherServlet也可以配置自己的初始化引數,覆蓋預設配置:
摘自Spring Reference
引數 |
描述 |
contextClass |
實現WebApplicationContext介面的類,當前的servlet用它來建立上下文。如果這個引數沒有指定, 預設使用XmlWebApplicationContext。 |
contextConfigLocation |
傳給上下文例項(由contextClass指定)的字串,用來指定上下文的位置。這個字串可以被分成多個字串(使用逗號作為分隔符) 來支援多個上下文(在多上下文的情況下,如果同一個bean被定義兩次,後面一個優先)。 |
namespace |
WebApplicationContext名稱空間。預設值是[server-name]-servlet。 |
因此我們可以通過新增初始化引數
- <servlet>
- <servlet-name>chapter2</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>
如果使用如上配置,Spring Web MVC框架將載入“classpath:spring-servlet-config.xml”來進行初始化上下文而不是“/WEB-INF/[servlet名字]-servlet.xml”。
3.3、上下文關係
整合Web環境的通用配置:
- <context-param>
- <param-name>contextConfigLocation</param-name>
- <param-value>
- classpath:spring-common-config.xml,
- classpath:spring-budget-config.xml
- </param-value>
- </context-param>
- <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
- </listener>
如上配置是Spring整合Web環境的通用配置;一般用於載入除Web層的Bean(如DAO、Service等),以便於與其他任何Web框架整合。
contextConfigLocation:表示用於載入Bean的配置檔案;
contextClass:表示用於載入Bean的ApplicationContext實現類,預設WebApplicationContext。
建立完畢後會將該上下文放在ServletContext:
servletContext.setAttribute(
WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE,
this.context);
ContextLoaderListener初始化的上下文和DispatcherServlet初始化的上下文關係,如圖3-1
圖3-1
從圖中可以看出:
ContextLoaderListener初始化的上下文載入的Bean是對於整個應用程式共享的,不管是使用什麼表現層技術,一般如DAO層、Service層Bean;
DispatcherServlet初始化的上下文載入的Bean是隻對Spring Web MVC有效的Bean,如Controller、HandlerMapping、HandlerAdapter等等,該初始化上下文應該只加載Web相關元件。
3.4、DispatcherServlet初始化順序
繼承體系結構如下所示:
1、HttpServletBean繼承HttpServlet,因此在Web容器啟動時將呼叫它的init方法,該初始化方法的主要作用
:::將Servlet初始化引數(init-param)設定到該元件上(如contextAttribute、contextClass、namespace、contextConfigLocation),通過BeanWrapper簡化設值過程,方便後續使用;
:::提供給子類初始化擴充套件點,initServletBean(),該方法由FrameworkServlet覆蓋。
- public abstract class HttpServletBean extends HttpServlet implements EnvironmentAware{
- @Override
- public final void init() throws ServletException {
- //省略部分程式碼
- //1、如下程式碼的作用是將Servlet初始化引數設定到該元件上
- //如contextAttribute、contextClass、namespace、contextConfigLocation;
- try {
- PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
- BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
- ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
- bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, this.environment));
- initBeanWrapper(bw);
- bw.setPropertyValues(pvs, true);
- }
- catch (BeansException ex) {
- //…………省略其他程式碼
- }
- //2、提供給子類初始化的擴充套件點,該方法由FrameworkServlet覆蓋
- initServletBean();
- if (logger.isDebugEnabled()) {
- logger.debug("Servlet '" + getServletName() + "' configured successfully");
- }
- }
- //…………省略其他程式碼
- }
2、FrameworkServlet繼承HttpServletBean,通過initServletBean()進行Web上下文初始化,該方法主要覆蓋一下兩件事情:
初始化web上下文;
提供給子類初始化擴充套件點;
- public abstract class FrameworkServlet extends HttpServletBean {
- @Override
- protected final void initServletBean() throws ServletException {
- //省略部分程式碼
- try {
- //1、初始化Web上下文
- this.webApplicationContext = initWebApplicationContext();
- //2、提供給子類初始化的擴充套件點
- initFrameworkServlet();
- }
- //省略部分程式碼
- }
- }
- protected WebApplicationContext initWebApplicationContext() {
- //ROOT上下文(ContextLoaderListener載入的)
- WebApplicationContext rootContext =
- WebApplicationContextUtils.getWebApplicationContext(getServletContext());
- WebApplicationContext wac = null;
- if (this.webApplicationContext != null) {
- // 1、在建立該Servlet注入的上下文
- wac = this.webApplicationContext;
- if (wac instanceof ConfigurableWebApplicationContext) {
- ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
- if (!cwac.isActive()) {
- if (cwac.getParent() == null) {
- cwac.setParent(rootContext);
- }
- configureAndRefreshWebApplicationContext(cwac);
- }
- }
- }
- if (wac == null) {
- //2、查詢已經繫結的上下文
- wac = findWebApplicationContext();
- }
- if (wac == null) {
- //3、如果沒有找到相應的上下文,並指定父親為ContextLoaderListener
- wac = createWebApplicationContext(rootContext);
- }
- if (!this.refreshEventReceived) {
- //4、重新整理上下文(執行一些初始化)
- onRefresh(wac);
- }
- if (this.publishContext) {
- // Publish the context as a servlet context attribute.
- String attrName = getServletContextAttributeName();
- getServletContext().setAttribute(attrName, wac);
- //省略部分程式碼
- }
- return wac;
- }
從initWebApplicationContext()方法可以看出,基本上如果ContextLoaderListener載入了上下文將作為根上下文(DispatcherServlet的父容器)。
最後呼叫了onRefresh()方法執行容器的一些初始化,這個方法由子類實現,來進行擴充套件。
3、DispatcherServlet繼承FrameworkServlet,並實現了onRefresh()方法提供一些前端控制器相關的配置:
- public class DispatcherServlet extends FrameworkServlet {
- //實現子類的onRefresh()方法,該方法委託為initStrategies()方法。
- @Override
- protected void onRefresh(ApplicationContext context) {
- initStrategies(context);
- }
- //初始化預設的Spring Web MVC框架使用的策略(如HandlerMapping)
- protected void initStrategies(ApplicationContext context) {
- initMultipartResolver(context);
- initLocaleResolver(context);
- initThemeResolver(context);
- initHandlerMappings(context);
- initHandlerAdapters(context);
- initHandlerExceptionResolvers(context);
- initRequestToViewNameTranslator(context);
- initViewResolvers(context);
- initFlashMapManager(context);
- }
- }
從如上程式碼可以看出,DispatcherServlet啟動時會進行我們需要的Web層Bean的配置,如HandlerMapping、HandlerAdapter等,而且如果我們沒有配置,還會給我們提供預設的配置。
從如上程式碼我們可以看出,整個DispatcherServlet初始化的過程和做了些什麼事情,具體主要做了如下兩件事情:
1、初始化Spring Web MVC使用的Web上下文,並且可能指定父容器為(ContextLoaderListener載入了根上下文);
2、初始化DispatcherServlet使用的策略,如HandlerMapping、HandlerAdapter等。