DispatcherServlet的作用

springmvc(二) springmvc的大脑—DispatcherServlet源码小解DispatcherServlet的作用将请求交予springmvc处理的过程

上面是网上找的一张图，大概可以说明DispatcherServlet在整个数据流中起到的作用。

初始化springmvc所需的组件
截获请求，交给springmvc框架处理
协调组件处理请求

本文不注重细节的分析，只简单分析下是如何截获http请求和如何协调组件进行处理http请求

将请求交予springmvc处理的过程

首先看下DispatcherServlet的继承关系：

springmvc(二) springmvc的大脑—DispatcherServlet源码小解DispatcherServlet的作用将请求交予springmvc处理的过程

HttpServlet我们都很熟悉了，对Http请求做了封装。

看下以下几个类：

HttpServletBean

public abstract class HttpServletBean extends HttpServlet implements EnvironmentCapable, EnvironmentAware

这个类除了继承了HttpServlet，还实现了两个接口，EnvironmentCapable和EnvironmentAware，说明这个类及其子类拥有了获取和设置运行时Environment的能力。

同时，这个类实现了init方法，在servlet初始化时，用来初始化bean。

public final void init() throws ServletException {
		if (logger.isDebugEnabled()) {
			logger.debug("Initializing servlet '" + getServletName() + "'");
		}
 
		// Set bean properties from init parameters.
		try {
			//获得web.xml中的contextConfigLocation配置属性，就是spring MVC的配置文件
			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()));
			//模板方法，可以在子类中调用，做一些初始化工作，bw代表DispatcherServelt
			initBeanWrapper(bw);
			//将配置的初始化值设置到DispatcherServlet中
			bw.setPropertyValues(pvs, true);
		}
		catch (BeansException ex) {
			logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
			throw ex;
		}
 
		// Let subclasses do whatever initialization they like.
		//模板方法，子类初始化的入口方法
		initServletBean();
 
		if (logger.isDebugEnabled()) {
			logger.debug("Servlet '" + getServletName() + "' configured successfully");
		}
	}

FrameworkServlet

public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware

FrameworkServlet继承了HttpServletBean，同时实现了ApplicationContextAware接口，利用ApplicationContextAware接口的setApplicationContext方法，可以拿到bean容器，ApplicationContext，这个时候FrameworkServlet就有了可以获取容器里所有Bean的能力了。

@Override
	public void setApplicationContext(ApplicationContext applicationContext) {
		if (this.webApplicationContext == null && applicationContext instanceof WebApplicationContext) {
			this.webApplicationContext = (WebApplicationContext) applicationContext;
			this.webApplicationContextInjected = true;
		}
	}

同时FrameworkServlet实现了HttpServlet 的 doGet、doPost等一系列方法，将这些请求移交到processRequest这个方法中处理。

@Override
	protected final void doGet(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {

		processRequest(request, response);
	}

下面看下processRequest做了哪些事

protected final void processRequest(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        long startTime = System.currentTimeMillis();
        Throwable failureCause = null;
        //获取LocaleContextHolder中存储的原先的LocaleContext【存储Locale信息】
        LocaleContext previousLocaleContext = LocaleContextHolder.getLocaleContext();
        //获取当前请求中的LocaleContext
        LocaleContext localeContext = buildLocaleContext(request);
        //获取RequestContextHolder中存储的原先的RequestAttributes【RequestAttributes是Spring的一个接口，通过该接口可以get/set/removeAttribute】
        RequestAttributes previousAttributes = RequestContextHolder.getRequestAttributes();
        //获取当前请求中的ServletRequestAttributes
        ServletRequestAttributes requestAttributes = buildRequestAttributes(request, response, previousAttributes);
        //使用request获取异步处理管理器
        WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
        //为异步处理管理器注册拦截器
        asyncManager.registerCallableInterceptor(FrameworkServlet.class.getName(), new RequestBindingInterceptor());
        //initContextHolders将当前请求的LocaleContext、ServletRequestAttributes设置到LocaleContextHolder、RequestContextHolder【initContextHolders的代码在本代码块后部分】
        initContextHolders(request, localeContext, requestAttributes);
        try {
            //实际处理的方法，在FrameworkServlet只是一个抽象方法由DispatcherServlet来实现【也是DispatcherServlet处理请求的入口】
            doService(request, response);
        }
        catch (ServletException ex) {
            failureCause = ex;
            throw ex;
        }
        catch (IOException ex) {
            failureCause = ex;
            throw ex;
        }
        catch (Throwable ex) {
            failureCause = ex;
            throw new NestedServletException("Request processing failed", ex);
        }

        finally {
            //将请求之前的LocaleContext、RequestAttributes恢复到LocaleContextHolder、RequestContextHolder
            resetContextHolders(request, previousLocaleContext, previousAttributes);
            if (requestAttributes != null) {
                //标记requestActive为false，代表当前请求已完成
                requestAttributes.requestCompleted();
            }
            //日志相关输出
            if (logger.isDebugEnabled()) {
                if (failureCause != null) {
                    this.logger.debug("Could not complete request", failureCause);
                }
                else {
                    if (asyncManager.isConcurrentHandlingStarted()) {
                        logger.debug("Leaving response open for concurrent processing");
                    }
                    else {
                        this.logger.debug("Successfully completed request");
                    }
                }
            }
            //发布ServletRequestHandledEvent消息
            publishRequestHandledEvent(request, response, startTime, failureCause);
        }
    }

这个方法主要做了

异步请求的处理
调用doService方法具体处理请求
处理LocaleContext和RequestAttributes

这个doService是一个钩子，会直接调用DispatcherServlet的doService方法。

这里就可以得到请求处理过程的全貌了：

HttpServlet service(ServletRequest req, ServletResponse res)

→FrameworkServlet service(HttpServletRequest request, HttpServletResponse response)

→HttpServlet service(HttpServletRequest req, HttpServletResponse resp)

→FrameworkServlet doGet/doXxxx

→FrameworkServlet processRequest

→DispatcherServlet doService