SpringMVC源码分析之DispatcherServlet

向右看齐 2021-11-27 02:18 383阅读 0赞

> SpringMVC核心就是DispatcherServlet，被称为前端控制器，所有请求都会转发到DispatcherServlet，然后再通过DispatcherServlet执行具体的控制层，最后返回modelAndView给客户端视图展示。
> 
> SpringMVC中常用的几个概念，处理器映射器（HandlerMapping）、处理器适配器（HandlerAdapter）和视图解析器（ViewResolver）都在DispatcherServlet的doDispatch中有所体现。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70]

##### 一、DispatcherServlet与Servlet关系 #####

DispatcherServlet也是一个Servlet，它继承FrameworkServlet，又继承HTTPServlet  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 1]  
流程执行：

HttpServlet的service方法→FrameworkServlet的service方法→DispatchServlet的service方法

##### 二、DispatchServlet源码分析流程 #####

1.执行doDispatch

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 2]

2.调用getHandler方法获取Handler对象，gatHandler方法调用HandlerMapping，通过请求的路径查找Handler；返回值是一个HandlerExecutionChain对象。

handlerMappings的作用：用于查找控制器位置，比如xml和注解方式

/** * Return the HandlerExecutionChain for this request. * <p>Tries all handler mappings in order. * @param request current HTTP request * @return the HandlerExecutionChain, or {@code null} if no handler could be found */
    	@Nullable
    	protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception { 
    		if (this.handlerMappings != null) { 
    			for (HandlerMapping hm : this.handlerMappings) { 
    				if (logger.isTraceEnabled()) { 
    					logger.trace(
    							"Testing handler map [" + hm + "] in DispatcherServlet with name '" + getServletName() + "'");
    				}
    				HandlerExecutionChain handler = hm.getHandler(request);
    				if (handler != null) { 
    					return handler;
    				}
    			}
    		}
    		return null;
    	}

3.Handler需要借助于HandlerAdapter来执行，因此doDispatch就会调用getHandlerAdapter方法查找具体的HandlerAdapter。

/** * Return the HandlerAdapter for this handler object. * @param handler the handler object to find an adapter for * @throws ServletException if no HandlerAdapter can be found for the handler. This is a fatal error. */
    	protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletException { 
    		if (this.handlerAdapters != null) { 
    			for (HandlerAdapter ha : this.handlerAdapters) { 
    				if (logger.isTraceEnabled()) { 
    					logger.trace("Testing handler adapter [" + ha + "]");
    				}
    				if (ha.supports(handler)) { 
    					return ha;
    				}
    			}
    		}
    		throw new ServletException("No adapter for handler [" + handler +
    				"]: The DispatcherServlet configuration needs to include a HandlerAdapter that supports this handler");
    	}

4.判断网页是否需要重新生成

HTTP协议允许只发送带有Last-Modified的表头信息到服务器端，服务器端判断本地的信息是否修改了，如果没修改，最后的时间将与Last-Modified一致，此时不需要服务器端再生成信息，直接告诉浏览器信息没有改变，使用其本地数据即可。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 3]

// Process last-modified header, if supported by the handler.
    				String method = request.getMethod();
    				boolean isGet = "GET".equals(method);
    				if (isGet || "HEAD".equals(method)) { 
    					long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
    					if (logger.isDebugEnabled()) { 
    						logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
    					}
    					if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) { 
    						return;
    					}
    				}

5.拦截器  
在从处理器映射获取对应的处理器的时候（通过DispatcherServlet的getHandler方法），返回的不是处理器对象，而是一个HandlerExecutionChain，而这个HandlerExecutionChain中包含Handler对象；同时还包含一个HandlerInterceptor链表，而HandlerInterceptor就是拦截器。

而对于HandlerInterceptor接口中定义是哪三个方法中，preHandler在handler的执行前被调用；而postHandler在handler执行后，在进行视图解析之前执行；afterCompletion在view渲染完成、在DispatcherServlet返回之前执行。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 4]  
以上红色圈出applyPrehandle就是执行拦截器的preHandler，applyPostHandle就是postHandler方法，而afterCompletion则是在processDispatchResult方法中执行的，位置处于该方法的最后，view渲染完成后。

进入applyPreHandle方法中，当preHandle方法返回为false时，当前的请求将执行完afterCompletion后直接返回，handler也将不执行。

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception { 
    		HandlerInterceptor[] interceptors = getInterceptors();
    		if (!ObjectUtils.isEmpty(interceptors)) { 
    			for (int i = 0; i < interceptors.length; i++) { 
    				HandlerInterceptor interceptor = interceptors[i];
    				if (!interceptor.preHandle(request, response, this.handler)) { 
    					triggerAfterCompletion(request, response, null);
    					return false;
    				}
    				this.interceptorIndex = i;//此变量是便于让我们知道哪些拦截器执行了preHandler方法，因为preHandle一旦返回false，就会进入triggerAfterCompletion方法中，该方法会直接afterCompletion方法。但是不可能把所有拦截器的afterCompletion方法都执行一遍，所以使用interceptorIndex进行记数。
    			}
    		}
    		return true;
    	}
    
    //triggerAfterCompletion方法
    	void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex)
    			throws Exception { 
    
    		HandlerInterceptor[] interceptors = getInterceptors();
    		if (!ObjectUtils.isEmpty(interceptors)) { 
    			for (int i = this.interceptorIndex; i >= 0; i--) { 
    				HandlerInterceptor interceptor = interceptors[i];
    				try { 
    					interceptor.afterCompletion(request, response, this.handler, ex);
    				}
    				catch (Throwable ex2) { 
    					logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
    				}
    			}
    		}
    	}

6.HandlerAdapter去执行Handler对应方法，其中返回的mv就是ModelAndView对象。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 5]

7.视图解析器

DispatcherServlet在processDispatchResult中解析并返回View，在render方法中会根据ModelAndView渲染产生View对象。

##### 三、SpringMVC控制层容器初始化 #####

1.首先我们先看HttpServletBean的init()  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 6]  
2.进入initServletBean()方法  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 7]  
3.进入子类FrameworkServlet，对其initServletBean()方法进行重写  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 8]  
4.进入initWebApplicationContext()方法  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 9]  
5.进入onRefresh()方法  
![在这里插入图片描述][20190723165232524.png]  
6.进入FrameworkServlet的子类DispatcherServlet的onRefresh()方法  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 10]

protected void initStrategies(ApplicationContext context) { 
    		initMultipartResolver(context); //初始化上传文件解析器(或者是多部分请求解析器)
    		initLocaleResolver(context);//初始化本地化解析器
    		initThemeResolver(context);//初始化主题解析器
    		initHandlerMappings(context);//初始化处理器映射器
    		initHandlerAdapters(context);//初始化处理器适配器
    		initHandlerExceptionResolvers(context);//初始化处理器异常解析器
    		initRequestToViewNameTranslator(context);//初始化请求到视图名翻译器
    		initViewResolvers(context);//初始化视图解析器
    		initFlashMapManager(context);//初始化重定向数据管理器
    ｝

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70]: /images/20211126/1090bb1083a4427db0a73daeeb54edd6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 1]: /images/20211126/ecb8e37328684730b3ed5f8deb229c03.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 2]: /images/20211126/dddc9eaf296a46e89b23d734c7e2f354.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 3]: /images/20211126/e87e35b6e430466ab902fc85ddc71654.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 4]: /images/20211126/eb14843c353548abbbab07a33c120a8a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 5]: /images/20211126/2cfc9bf923cc44dc94d7e903ee0f55d8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 6]: /images/20211126/adaef3c6f79f413aa4ba787da73aa23e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 7]: /images/20211126/92010998acc1469586ccc18ac1265a55.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 8]: /images/20211126/07017ed27e4746d7810241effa5f93c8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 9]: /images/20211126/602e63cd709941f1a9f90f39bd79c488.png
[20190723165232524.png]: /images/20211126/bada5e6fce06484e994fa1153c7fd64b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDgyNjM0OQ_size_16_color_FFFFFF_t_70 10]: /images/20211126/e9e458b23c45404ebfd5ca11c6fc5239.png