深入理解Spring系列之十：DispatcherServlet请求分发源码分析

DispatcherServlet是SpringMVC的核心分发器，它实现了请求分发，是处理请求的入口，本篇将深入源码分析它的请求分发过程。可点击文末左下角“阅读原文”畅读。

DispatcherServlet初始化

、

首先，从DispatcherServlet的名称上可以看出它是一个Servlet，通过一张图来看一下它的实现关系。

既然DispatcherServlet是一个Servlet，那么初始化的时候一定会执行init方法，查看源码发现DispatcherServlet的init方法继承自HttpServletBean，具体代码如下图所示。

对于上面的代码，配合一个实际的web.xml配置样例更容易理解，具体如下图所示。

上面示例配置中，配置了一个 contextConfigLocation参数，该参数用于构造SpringMVC上下文。对于initServletBean方法，FrameworkServlet中进行了重写，具体代码如下图所示。

initWebApplicationContext方法主要代码如下图所示。

如果web.xml中配置了如下参数，将会在应用启动的时候初始化一个WebApplicationContext实例，并将其保存在ServletContext中。

上图中的代码很容易理解，接下来进入DispatcherServlet的onRefresh方法，具体代码如下图所示。

initStrategies方法中的各个方法，从方法名上可以很容易理解其作用，大部分的执行逻辑都是先从WebApplicationContext中查找，找不到的情况下再加载和DispatcherServlet同目录下的DispatcherServlet.properties中的各个策略，如初始化HandlerMapping，具体如下图所示。

源码分析

进入主题前，回顾一下DispatcherServlet的继承关系图。

Servlet在service方法中进行请求接收与分发，DispatcherServlet的service方法继承自HttpServlet，具体代码如下图所示。

在FrameworkServlet中对这个protected修饰的service方法进行了重写，重写的目的是支持PATCH方式请求，具体代码如下图所示。

上述分析中的doGet、doPost等方法在HttpServlet中没有实际可用的实现，如果要使用这些方法，子类需要重写这些方法，DispatcherServlet没有重写这些方法，在DispatcherServlet的父类FrameworkServlet中进行了重写，看几个重写后的方法代码。

可以看到这些请求都会进入当前FrameworkServlet类的processRequest方法进行处理，具体代码如下图所示。

FrameworkServlet中的doService是一个抽象方法，DispatcherServlet重写了这个方法，具体代码如下图。

进入doDispatch方法，这个方法实现了将请求分发到具体Handler、执行拦截器的preHandle方法、调用Handler（编写的Controller）处理具体逻辑、执行拦截器的postHandle方法、处理返回的ModelAndView或异常、执行拦截器的afterCompletion方法，具体代码如下。

上图描述中的HandlerMethod和HandlerExecutionChain代码如下所示。

总结

首先，SpringMVC框架在启动的时候会遍历Spring容器中的所有bean，对标注了@Controller或@RequestMapping注解的类中方法进行遍历，将类和方法上的@RequestMapping注解值进行合并，使用@RequestMapping注解的相关参数值(如value、method等)封装一个RequestMappingInfo，将这个Controller实例、方法及方法参数信息(类型、注解等)封装到HandlerMethod中，然后以RequestMappingInfo为key，HandlerMethod为value存到一个以Map为结构的handlerMethods中。

接着，将@RequestMapping注解中的value(即请求路径)值取出，即url，然后以url为key，以RequestMappingInfo为value，存到一个以Map为结构的urlMap属性中。

客户端发起请求的时候，根据请求的URL到urlMap中查找，找到RequestMappingInfo，然后根据RequestMappingInfo到handlerMethods中查找，找到对应的HandlerMethod，接着将HandlerMethod封装到HandlerExecutionChain；接着遍历容器中所有HandlerAdapter实现类，找到支持这次请求的HandlerAdapter，如RequestMappingHandlerAdapter，然后执行SpringMVC拦截器的前置方法(preHandle方法)，然后对请求参数解析及转换，然后(使用反射)调用具体Controller的对应方法返回一个ModelAndView对象，执行拦截器的后置方法(postHandle方法)，然后对返回的结果进行处理，最后执行afterCompletion方法。