SpringMVC——DispatcherServlet的IoC容器(Web应用的IoC容器的子容器)创建过程

在上一篇《Spring——Web应用中的IoC容器创建(WebApplicationContext根应用上下文的创建过程)》中说到了Web应用中的IoC容器创建过程.这一篇主要讲SpringMVC的核心DispatcherServlet.

从web.xml中简要回顾一下WebApplicationContext根应用上下文的创建过程.具体过程详见上篇博客.

　　<!--WebApplicationContext配置参数-->
　　<context-param>
    　　<param-name>contextConfigLocation</param-name>
    　　<param-value>classpath*:applicationContext.xml</param-value>
　　</context-param>
   <!--注册ContextLoaderListener,加载根应用上下文-->
　　<listener>
    　　<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
　　</listener>

DispatcherServlet实际上就是一个Servlet所以它在web.xml中的配置和普通的servlet没有区别.

    <!--注册DispatcherServlet，加载应用上下文-->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath*:spring-servlet.xml</param-value>    <!--若不显示添加配置文件路径,则会默认加载servlt-name的名字+"-servlet.xml"-->
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <!--servlet映射-->
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

用过原生Servlet写过web都知道自定义的Servlet需要继承HttpServlet类实现doPost和doGet方法.DispatcherServlet类的主要继承关系如下:

在这篇博客中从不细讲Servlet,从HttpServletBean的开始讲起.

---

DispatcherServlet是什么?它为什么在SpringMVC中起到核心作用?原因很简单:所有来自客户端的请求都会经过DispatcherServlet,由DispatcherServlet将不同的请求分发至不同的Controller,所以DispatcherServlet是一个前置控制器起的是分发来自客户端请求的作用.根据不同的配置会接收不同的请求,这在web.xml中servlet映射中可体现.如果配置的是"/"则是所有请求都会经过DispatcherServlet,但通常不会这么做,比如一些静态资源就不必经过DispatcherServlet.

首先大致了解一下Servlet.Web容器接收到来自客户端不同类型(post,get等)的时候,实际上是所有的请求都是访问Servlet接口的service方法,在HttpServlet抽象类中实现了service方法,在service方法中判断是哪种具体的请求,再将不同的请求分发至不同的处理方法.

用原生的Servlet编写的Web应用通常是继承HttpServlet方法,重写doGet和doPost方法.由于DispatcherServlet在SpringMVC中责任重大,作为一个前端控制器,所有的Web请求都需要通过它处理,进行转发,匹配,数据处理后,并转由页面进行展现.可以看到DispatcherServlet并没有直接继承HttpServlet,而是HttpServletBean.在Servlet初始化过程中,Servlet的init方法会被调用,而Servlet提供的API中init方法没有做任何事,也就是说我们可以通过重写init方法来实现我们自己的业务逻辑.

//GenericServlet.java
public void init(ServletConfig config) throws ServletException {
    this.config = config;
    this.init();
}
...
public void init() throws ServletException {

}
...

在HttpServletBean重写了init方法,并且不能被其子类所重写.

//HttpServletBean.java
public final void init() throws ServletException {
    if (logger.isDebugEnabled()) {
        logger.debug("Initializing servlet '" + getServletName() + "'");
    }

    // Set bean properties from init parameters.从初始化参数中设置bean属性
    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, getEnvironment()));
        initBeanWrapper(bw);
        bw.setPropertyValues(pvs, true);
    }
    catch (BeansException ex) {
        if (logger.isErrorEnabled()) {
            logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
        }
        throw ex;
    }

    // Let subclasses do whatever initialization they like.调用子类的initServletBean进行具体的初始化
    initServletBean();

    if (logger.isDebugEnabled()) {
        logger.debug("Servlet '" + getServletName() + "' configured successfully");
    }
}
...
//具体的初始化交由子类去完成,即FrameworkServlet
protected void initServletBean() throws ServletException {
}

顺着初始化这条线我们来到FrameworkServlet.照猫画虎,它重写了父类的initServletBean,但同样将它置为不能被其子类所重写.

//FrameServlet.java
protected final void initServletBean() throws ServletException {
    getServletContext().log("Initializing Spring FrameworkServlet '" + getServletName() + "'");
    if (this.logger.isInfoEnabled()) {
        this.logger.info("FrameworkServlet '" + getServletName() + "': initialization started");
    }
    long startTime = System.currentTimeMillis();

    try {
        this.webApplicationContext = initWebApplicationContext();   //在这里不是初始化Spring根应用上下文(Web应用的IoC容器),而是初始化SpringMVC的Servlet上下文创建自己所持有的IoC容器.如果没有则调用createWebApplicationContext方法进行创建.并将根应用上下文作为它的双亲上下文
        initFrameworkServlet(); //此方法也没有给出具体实现,再其子类DispatcherServlet也没有对它重写.
    }
    catch (ServletException ex) {
        this.logger.error("Context initialization failed", ex);
        throw ex;
    }
    catch (RuntimeException ex) {
        this.logger.error("Context initialization failed", ex);
        throw ex;
    }

    if (this.logger.isInfoEnabled()) {
        long elapsedTime = System.currentTimeMillis() - startTime;
        this.logger.info("FrameworkServlet '" + getServletName() + "': initialization completed in " +
                elapsedTime + " ms");
    }
}
...
//在所有的bean配置参数和WebApplicationContext被加载后会调用此方法,默认实现为空,它的子类可以重写此方法来实现需要的初始化操作.子类DispatcherServlet并没有重写.
protected void initFrameworkServlet() throws ServletException {
}

简单回顾一下整个初始化过程(一个不规范的图)

---

以上部分只是简要的说明了一下DispatcherServlet的IoC容器初始化过程,但还是没有说明一个请求是如何在DispatcherServlet做到分发到不同Controller的.

在DispatcherServlet类中有一个initStrategies方法,在这个方法中初始化整个SpringMVC框架的初始化,包括其中的http请求映射关系:

//DispatcherServlet.java
protected void initStrategies(ApplicationContext context) {
    initMultipartResolver(context);
    initLocaleResolver(context);
    initThemeResolver(context);
    initHandlerMappings(context);    //这里就是为http请求找到相应的Controller控制器
    initHandlerAdapters(context);
    initHandlerExceptionResolvers(context);
    initRequestToViewNameTranslator(context);
    initViewResolvers(context);
    initFlashMapManager(context);
}

容易得知,initStrategies方法是在onRefresh方法中调用的,FrameworkServlet没有对onRefresh做任何有意义的实现,而是交由它的子类DispatcherServlet去完成.在FramworkServlet的initWebApplicationContext方法中完成了对它的调用.所以再次回到FramworkServlet的initWebApplicationContext方法,只截取其中一段:

//FrameworkServlet.java
protected WebApplicationContext initWebApplicationContext() {
    ......
    if (this.webApplicationContext != null) {
        ......
        configureAndRefreshWebApplicationContext(cwac);     //在此方法中调用的onRefresh
        ......
    }
    if (wac == null) {
        wac = createWebApplicationContext(rootContext);     //此方法中最后也是调用的configureAndRefreshWebApplicationContext方法
    }

    if (!this.refreshEventReceived) {
        onRefresh(wac);
    }
    ......
    return wac;
}

更为具体的SpringMVC处理http分发请求,我们再下一篇中再来详细讲解initStrategies中的initHandlerMappings.