• 欢迎访问web前端中文站,JavaScript,CSS3,HTML5,web前端demo
  • 如果您觉得本站非常有看点,那么赶紧使用Ctrl+D 收藏web前端中文站吧

详解Spring MVC中DispatcherServlet的作用

JAVA web前端中文站 2年前 (2017-07-10) 859次浏览 已收录 0个评论

Spring MVC 的核心就是 DispatcherServlet。因此我们很有必要系统性的对它进行一下研究。本文将带领你解读 DispatcherServlet 的作用。

更多精彩内容请看 web 前端中文站
http://www.lisa33xiaoq.net 可按 Ctrl + D 进行收藏

DispatcherServlet 是前端控制器设计模式的实现,提供 Spring Web MVC 的集中访问点,而且负责职责的分派,而且与 Spring IoC 容器无缝集成,从而可以获得 Spring 的所有好处。

DispatcherServlet 主要用作职责调度工作,本身主要用于控制流程,主要职责如下:

  1. 文件上传解析,如果请求类型是 multipart 将通过 MultipartResolver 进行文件上传解析;
  2. 通过 HandlerMapping,将请求映射到处理器(返回一个 HandlerExecutionChain,它包括一个处理器、多个 HandlerInterceptor 拦截器);
  3. 通过 HandlerAdapter 支持多种类型的处理器(HandlerExecutionChain 中的处理器);
  4. 通过 ViewResolver 解析逻辑视图名到具体视图实现;
  5. 本地化解析;
  6. 渲染具体的视图等;
  7. 如果执行过程中遇到异常将交给 HandlerExceptionResolver 来解析。

从以上我们可以看出 DispatcherServlet 主要负责流程的控制(而且在流程中的每个关键点都是很容易扩展的)。

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 也可以配置自己的初始化参数,覆盖默认配置:

参数 描述
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”。

上下文关系

集成 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 初始化的上下文关系。

详解 Spring MVC 中 DispatcherServlet 的作用

从图中可以看出:
ContextLoaderListener 初始化的上下文加载的 Bean 是对于整个应用程序共享的,不管是使用什么表现层技术,一般如 DAO 层、Service 层 Bean;
DispatcherServlet 初始化的上下文加载的 Bean 是只对 Spring Web MVC 有效的 Bean,如 Controller、HandlerMapping、HandlerAdapter 等等,该初始化上下文应该只加载 Web 相关组件。

DispatcherServlet 初始化顺序

继承体系结构如下所示:

详解 Spring MVC 中 DispatcherServlet 的作用

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");         }     }     //…………省略其他代码 }

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()方法执行容器的一些初始化,这个方法由子类实现,来进行扩展。

DispatcherServlet 继承 FrameworkServlet

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 等。

服务器启动时的日志分析也可以看出 DispatcherServlet 的加载顺序(此处加上了 ContextLoaderListener 从而启动 ROOT 上下文容器)。

DispatcherServlet 默认配置

DispatcherServlet 的默认配置在 DispatcherServlet.properties(和 DispatcherServlet 类在一个包下)中,而且是当 Spring 配置文件中没有指定配置时使用的默认策略:

详解 Spring MVC 中 DispatcherServlet 的作用

从 DispatcherServlet.properties 配置可以看出 DispatcherServlet 在启动时会自动注册这些特殊的 Bean,无需我们注册,如果我们注册了,默认的将不会注册。
因此前面的例子中的 BeanNameUrlHandlerMapping、SimpleControllerHandlerAdapter 是不需要注册的,DispatcherServlet 默认会注册这两个 Bean。
从 DispatcherServlet.properties 可以看出有许多特殊的 Bean,那接下来我们就看看 Spring Web MVC 主要有哪些特殊的 Bean。

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 用于存储一个请求的输出,当进入另一个请求时作为该请求的输入,通常用于重定向场景,后边会细述。

到这里 Spring MVC 核心的 DispatcherServlet 我们已经学习完了,接下来我们就需要把上边提到的特殊 Bean 挨个击破,那首先从控制器开始吧。

【注:本文源自网络文章资源,由站长整理发布】


web 前端中文站 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:详解 Spring MVC 中 DispatcherServlet 的作用
喜欢 (0)
发表我的评论
取消评论
表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址