zoukankan      html  css  js  c++  java
  • DispatcherServlet

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

    服务器启动时的日志分析(此处加上了ContextLoaderListener从而启动ROOT上下文容器):

     信息: Initializing Spring root WebApplicationContext //ContextLoaderListener启动ROOT上下文

    2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.ContextLoader - Root WebApplicationContext: initialization started

    2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.support.XmlWebApplicationContext - Refreshing Root WebApplicationContext: startup date [Mon Mar 12 13:33:55 CST 2012]; root of context hierarchy

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader - Loading bean definitions

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.XmlBeanDefinitionReader - Loaded 0 bean definitions from location pattern [/WEB-INF/ContextLoaderListener.xml]

    2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.support.XmlWebApplicationContext - Bean factory for Root WebApplicationContext: org.springframework.beans.factory.support.DefaultListableBeanFactory@1c05ffd: defining beans []; root of factory hierarchy

    2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.support.XmlWebApplicationContext - Bean factory for Root WebApplicationContext:

    2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.ContextLoader - Published root WebApplicationContext as ServletContext attribute with name [org.springframework.web.context.WebApplicationContext.ROOT] //ROOT上下文绑定到ServletContext

    2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.ContextLoader - Root WebApplicationContext: initialization completed in 438 ms  //到此ROOT上下文启动完毕

     2012-03-12 13:33:55 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Initializing servlet 'chapter2'

    信息: Initializing Spring FrameworkServlet 'chapter2'  //开始初始化FrameworkServlet对应的Web上下文

    2012-03-12 13:33:55 [main] INFO  org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'chapter2': initialization started

    2012-03-12 13:33:55 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Servlet with name 'chapter2' will try to create custom WebApplicationContext context of class 'org.springframework.web.context.support.XmlWebApplicationContext', using parent context [Root WebApplicationContext: startup date [Mon Mar 12 13:33:55 CST 2012]; root of context hierarchy]

    //此处使用Root WebApplicationContext作为父容器。

    2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.support.XmlWebApplicationContext - Refreshing WebApplicationContext for namespace 'chapter2-servlet': startup date [Mon Mar 12 13:33:55 CST 2012]; parent: Root WebApplicationContext

    2012-03-12 13:33:55 [main] INFO  org.springframework.beans.factory.xml.XmlBeanDefinitionReader - Loading XML bean definitions from ServletContext resource [/WEB-INF/chapter2-servlet.xml]

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader - Loading bean definitions

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - Neither XML 'id' nor 'name' specified - using generated bean name[org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping#0]  //我们配置的HandlerMapping

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - Neither XML 'id' nor 'name' specified - using generated bean name[org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter#0] //我们配置的HandlerAdapter

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - Neither XML 'id' nor 'name' specified - using generated bean name [org.springframework.web.servlet.view.InternalResourceViewResolver#0] //我们配置的ViewResolver

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - No XML 'id' specified - using '/hello' as bean name and [] as aliases 

    //我们的处理器(HelloWorldController

    2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.XmlBeanDefinitionReader - Loaded 4 bean definitions from location pattern [/WEB-INF/chapter2-servlet.xml]

    2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.support.XmlWebApplicationContext - Bean factory for WebApplicationContext for namespace 'chapter2-servlet': org.springframework.beans.factory.support.DefaultListableBeanFactory@1372656: defining beans [org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping#0,org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter#0,org.springframework.web.servlet.view.InternalResourceViewResolver#0,/hello]; parent: org.springframework.beans.factory.support.DefaultListableBeanFactory@1c05ffd

    //到此容器注册的Bean初始化完毕

    2012-03-12 13:33:56 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Unable to locate MultipartResolver with name 'multipartResolver': no multipart request handling provided

    2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver'

    //默认的LocaleResolver注册

    2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.theme.FixedThemeResolver'

    //默认的ThemeResolver注册

    2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping#0'

    //发现我们定义的HandlerMapping 不再使用默认的HandlerMapping

    2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter#0'

    //发现我们定义的HandlerAdapter 不再使用默认的HandlerAdapter

    2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerExceptionResolver'

    //异常处理解析器ExceptionResolver

    2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerExceptionResolver'

    2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'org.springframework.web.servlet.view.InternalResourceViewResolver#0'

    2012-03-12 13:33:56 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Published WebApplicationContext of servlet 'chapter2' as ServletContext attribute with name [org.springframework.web.servlet.FrameworkServlet.CONTEXT.chapter2]

    //绑定FrameworkServlet初始化的Web上下文到ServletContext

    2012-03-12 13:33:56 [main] INFO  org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'chapter2': initialization completed in  297 ms

    2012-03-12 13:33:56 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Servlet 'chapter2' configured successfully

    //到此完整流程结束 

    从如上日志我们也可以看出,DispatcherServlet会进行一些默认的配置。

  • 相关阅读:
    2021-6-3 日报博客
    2021-6-2 日报博客
    2021-6-1 日报博客
    2021-5-31 日报博客
    团队博客——十日冲刺结束
    团队博客——十日冲刺9
    团队博客——十日冲刺8
    团队博客——十日冲刺7
    周总结9
    团队博客——十日冲刺6
  • 原文地址:https://www.cnblogs.com/ClassNotFoundException/p/5846019.html
Copyright © 2011-2022 走看看