SpringMVC工作原理及DispatcherServlet源码解析

2024-02-07 08:32
文章标签 java 源码 工作 spring 原理 springmvc 解析 dispatcherservlet

本文主要是介绍SpringMVC工作原理及DispatcherServlet源码解析，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一、SpringMVC整体流程

先来看看SpringMVC的工作流程图：

下面来看看每一步都是在做什么：

第一步：用户发起request请求，请求至DispatcherServlet前端控制器。

第二步：DispatcherServlet前端控制器请求HandlerMapping处理器映射器查找Handler。

              DispatcherServlet：前端控制器，相当于中央调度器，各各组件都和前端控制器进行交互，降低了各组件之间耦合度。

第三步：HandlerMapping处理器映射器，根据url及一些配置规则（xml配置、注解配置）查找Handler，将Handler返回给                          DispatcherServlet前端控制器。

第四步：DispatcherServlet前端控制器调用适配器执行Handler，有了适配器通过适配器去扩展对不同Handler执行方式（比如：                原始servlet开发，注解开发）

第五步：适配器执行Handler。Handler是后端控制器，当成模型。

第六步：Handler执行完成返回ModelAndView

              ModelAndView是springmvc的一个对象，对Model和view进行封装。

第七步：适配器将ModelAndView返回给DispatcherServlet

第八步：DispatcherServlet调用视图解析器进行视图解析，解析后生成view。视图解析器根据逻辑视图名解析出真正的视图。

              View：springmvc视图封装对象，提供了很多view，比如：jsp、freemarker、pdf、excel。

第九步：ViewResolver视图解析器给前端控制器返回view

第十步：DispatcherServlet调用view的渲染视图的方法，将模型数据填充到request域 。

第十一步：DispatcherServlet向用户响应结果(jsp页面、json数据。)

在这里面有几个组件要说一下：

  • DispatcherServlet：前端控制器，由springmvc提供
  • HandlerMappting：处理器映射器，由springmvc提供
  • HandlerAdapter：处理器适配器，由springmvc提供
  • Handler：处理器，需要程序员开发
  • ViewResolver：视图解析器，由springmvc提供
  • View：真正视图页面需要由程序编写

 由上面springMVC的工作流程图我们可以知道，其实springMVC的核心就是DispatcherServlet，所以接下来主要就是通过源码来看看DispatcherServlet是怎么工作的。

FROM 《SpringMVC - 运行流程图及原理分析》

流程示意图：

代码序列图：

FROM 《看透 Spring MVC：源代码分析与实践》 P123

流程示意图：

 

二、服务流程

一般而言，Servlet有一个服务方法 doService来为HTTP请求提供服务(如参照前面的servlet源码解析)， DispatcherServlet也是如此，它的 doService 方法如下面代码所示：

//将DispatcherServlet特定的请求转发给doDispatch处理
@Override
protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception {if (logger.isDebugEnabled()) {String resumed = WebAsyncUtils.getAsyncManager(request).hasConcurrentResult() ? " resumed" : "";logger.debug("DispatcherServlet with name '" + getServletName() + "'" + resumed +" processing " + request.getMethod() + " request for [" + getRequestUri(request) + "]");}// 快照处理，使用快照可以更快响应用户请求Map<String, Object> attributesSnapshot = null;if (WebUtils.isIncludeRequest(request)) {attributesSnapshot = new HashMap<String, Object>();Enumeration<?> attrNames = request.getAttributeNames();while (attrNames.hasMoreElements()) {String attrName = (String) attrNames.nextElement();if (this.cleanupAfterInclude || attrName.startsWith("org.springframework.web.servlet")) {attributesSnapshot.put(attrName, request.getAttribute(attrName));}}}// 设置Web IOC容器request.setAttribute(WEB_APPLICATION_CONTEXT_ATTRIBUTE, getWebApplicationContext());//设置国际化request.setAttribute(LOCALE_RESOLVER_ATTRIBUTE, this.localeResolver);//主题属性request.setAttribute(THEME_RESOLVER_ATTRIBUTE, this.themeResolver);//主题源属性request.setAttribute(THEME_SOURCE_ATTRIBUTE, getThemeSource());FlashMap inputFlashMap = this.flashMapManager.retrieveAndUpdate(request, response);if (inputFlashMap != null) {request.setAttribute(INPUT_FLASH_MAP_ATTRIBUTE, Collections.unmodifiableMap(inputFlashMap));}request.setAttribute(OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());request.setAttribute(FLASH_MAP_MANAGER_ATTRIBUTE, this.flashMapManager);try {//处理分发doDispatch(request, response);}finally {if (!WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {// Restore the original attribute snapshot, in case of an include.if (attributesSnapshot != null) {restoreAttributesAfterInclude(request, attributesSnapshot);}}}
}

由上面的代码和注释可以看到，doService先对HTTP请求进行一些处理，然后设置一些属性，最后所有的流程都集中在了 doDispatch 方法中。所以接下来我们继续看doDispatch方法：

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {HttpServletRequest processedRequest = request;HandlerExecutionChain mappedHandler = null;boolean multipartRequestParsed = false;WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);try {//模型和视图ModelAndView mv = null;//错误处理Exception dispatchException = null;try {//文件上传处理解析器processedRequest = checkMultipart(request);//是否为文件上传请求multipartRequestParsed = (processedRequest != request);// 获得匹配的执行链，决定处理请求的handlermappedHandler = getHandler(processedRequest);//没有处理器错误if (mappedHandler == null || mappedHandler.getHandler() == null) {noHandlerFound(processedRequest, response);return;}// 找到对应的处理器适配器(HandlerAdapter)HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());// Process last-modified header, if supported by the handler.///判断是 http 的 get 方法还是 post 方法或其他String method = request.getMethod();//如果是GET方法的处理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;}}//执行拦截器的事前方法，如果返回 false，则流程结束if (!mappedHandler.applyPreHandle(processedRequest, response)) {return;}// Actually invoke the handler.//执行处理器，返回 ModelAndViewmv = ha.handle(processedRequest, response, mappedHandler.getHandler());if (asyncManager.isConcurrentHandlingStarted()) {return;}//如果视图为空，给予设置默认视图的名称applyDefaultViewName(processedRequest, mv);//执行处理器拦截器的事后方法mappedHandler.applyPostHandle(processedRequest, response, mv);}catch (Exception ex) {//记录异常dispatchException = ex;}processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);}catch (Throwable ex) {//记录异常dispatchException = new NestedServletException(”Handler dispatch failed ”, err) ;}//处理请求结果，显然这里已经通过处理器得到最后的结果和视图 //如果是逻辑视图，则解析名称，否则就不解析，最后渲染视图processDispatchResult(processedRequest, response,mappedHandler, mv, dispatchException);}catch (Exception ex) {//异常处理，拦截器完成方法triggerAfterCompletion(processedRequest, response, mappedHandler, ex);}catch (Throwable err) {//错误处理triggerAfterCompletionWithError(processedRequest, response, mappedHandler, new NestedServletException (”Handler processing failed ",err)) ;}finally {//处理资源的释放if (asyncManager.isConcurrentHandlingStarted()) {// Instead of postHandle and afterCompletionif (mappedHandler != null) {//拦截器完成方法mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);}}else {// Clean up any resources used by a multipart request.//文件请求资源释放if (multipartRequestParsed) {cleanupMultipart(processedRequest);}}}}

通过源码可以看出其流程是 :
(l)通过请求找到对应的执行链，执行链包含了拦截器和开发者控制器。

(2)通过处理器找到对应的适配器。

(3)执行拦截器的事前方法，如果返回 false，则流程结束，不再处理 。

(4)通过适配器运行处理器，然后返回模型和视图。

(5)如果视图没有名称 ，则 给出默认的视图名称。

(6)执行拦截器的事后方法。

(7)处理分发请求得到的数据模型和视图的渲染。

三、处理器和执行器

在上面，我们已经了解了一个请求到达springMVC后，DispatcherServlet是怎么处理这个请求的，接下来就是看看处理器和拦截器，即DispatcherServlet的getHandler方法：

protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {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;}

在启动期间， SpringMVC已经初始化了处理器映射--HandlerMappings，所以这里先根据请求找到对应的 HandlerMapping，找到 HandlerMapping 后，就把相关处理的内容转化成一个 HandlerExecutionChain 对象。

接下来就来看看HandlerExecutionChain的结构是什么样的：

public class HandlerExecutionChain {private static final Log logger = LogFactory.getLog(HandlerExecutionChain.class);//处理器，自己写的控制器(或其方法)private final Object handler;//拦截器数组private HandlerInterceptor[] interceptors;//拦截器列表private List<HandlerInterceptor> interceptorList;//当前拦截器下标，当使用数组时有效private int interceptorIndex = -1;...
}

由源码可以看出，主要是定义一些拦截器相关的属性，可以在进入控制器之前 ， 运行对应的拦截器，这样就可以在进入处理器前做一些逻辑了。如果在做电商系统的时候，用户可以再未登录状态浏览商品，并加入购物车，但是如果要结算的时候，这个时候就要拦截请求，要求用户登录。这个时候就可以通过拦截器实现。接下来就来看看拦截器Handlerlnterceptor的相关方法：

public interface HandlerInterceptor {boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throws Exception;void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception;void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception;

依据 doDispatch 方法，当preHandle方法返回为 true 的时候才会继续运行，否则就会结束流程，而在数据模型渲染视图之前调用 postHandle方法， 在流程的 finally语 句中还会调用 afterCompletion方法， 这就是处理器拦截器的内容。如果要自己做一个拦截器的话，可以实现Handlerlnterceptor接口，然后重写这三个方法，你可以在这三个方法里面加入相应的业务逻辑进行处理。

四、视图渲染

在第二点的时候，我们知道processDispatchResult对模型和视图的处理，接下来我们来看看SpringMVC是怎么实现视图渲染。

private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,HandlerExecutionChain mappedHandler, ModelAndView mv, Exception exception) throws Exception {boolean errorView = false;//处理器发生异常if (exception != null) {//视图和模型定义方面的异常if (exception instanceof ModelAndViewDefiningException) {logger.debug("ModelAndViewDefiningException encountered", exception);mv = ((ModelAndViewDefiningException) exception).getModelAndView();}//处理器的异常else {Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);mv = processHandlerException(request, response, handler, exception);errorView = (mv != null);}}//处理器是否返回视图和模型if (mv != null && !mv.wasCleared()) {//渲染视图render(mv, request, response);if (errorView) {WebUtils.clearErrorRequestAttributes(request);}}else {//视图为 null，或者已经被处理过if (logger.isDebugEnabled()) {logger.debug("Null ModelAndView returned to DispatcherServlet with name '" + getServletName() +"': assuming HandlerAdapter completed request handling");}}//是否存在并发处理if (WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {// Concurrent handling started during a forwardreturn;}//完成方法if (mappedHandler != null) {mappedHandler.triggerAfterCompletion(request, response, null);}}

由上面的源码可以看出，首先是先判断是否异常，如果有异常就再进一步处理是什么异常，如果没有异常就通过render方法进行进一步处理，相关逻辑也在注释中表明了，接下来就来看看render这个方法：

protected void render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) throws Exception {// Determine locale for request and apply it to the response.
//国际化Locale locale = this.localeResolver.resolveLocale(request);response.setLocale(locale);View view;
//是否是逻辑视图，如果是需要转化为真实路径下的视图if (mv.isReference()) {// We need to resolve the view name.
//转化逻辑视图为真实视图view = resolveViewName(mv.getViewName(), mv.getModelInternal(), locale, request);if (view == null) {throw new ServletException("Could not resolve view with name '" + mv.getViewName() +"' in servlet with name '" + getServletName() + "'");}}
//非逻辑视图else {// No need to lookup: the ModelAndView object contains the actual View object.view = mv.getView();if (view == null) {throw new ServletException("ModelAndView [" + mv + "] neither contains a view name nor a " +"View object in servlet with name '" + getServletName() + "'");}}// Delegate to the View object for rendering.if (logger.isDebugEnabled()) {logger.debug("Rendering view [" + view + "] in DispatcherServlet with name '" + getServletName() + "'");}try {
//渲染视图， view 为视圈， mv.getModelInternal ()为数据模型view.render(mv.getModelInternal(), request, response);}catch (Exception ex) {if (logger.isDebugEnabled()) {logger.debug("Error rendering view [" + view + "] in DispatcherServlet with name '" +getServletName() + "'", ex);}throw ex;}}

首先是国际化的设置，然后判断是否是逻辑视图，如果是就转化它为 真实视图，或者 直接获取视图即可，最后进入视图的 render方法，将模型和视图中的数据模型传递到该方 法中去，这样就完成了视图的渲染，展示给用户。

这篇关于SpringMVC工作原理及DispatcherServlet源码解析的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/687127。

相关文章

Spring Boot中WebSocket常用使用方法详解

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP
阅读更多...
SpringBoot+Docker+Graylog 如何让错误自动报警

SpringBoot+Docker+Graylog 如何让错误自动报警

《SpringBoot+Docker+Graylog如何让错误自动报警》SpringBoot默认使用SLF4J与Logback,支持多日志级别和配置方式,可输出到控制台、文件及远程服务器,集成ELK... 目录01 Spring Boot 默认日志框架解析02 Spring Boot 日志级别详解03 Sp
阅读更多...
java中反射Reflection的4个作用详解

java中反射Reflection的4个作用详解

《java中反射Reflection的4个作用详解》反射Reflection是Java等编程语言中的一个重要特性,它允许程序在运行时进行自我检查和对内部成员（如字段、方法、类等）的操作,本文将详细介绍... 目录作用1、在运行时判断任意一个对象所属的类作用2、在运行时构造任意一个类的对象作用3、在运行时判断
阅读更多...
java如何解压zip压缩包

java如何解压zip压缩包

《java如何解压zip压缩包》：本文主要介绍java如何解压zip压缩包问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解压zip压缩包实例代码结果如下总结java解压zip压缩包坐在旁边的小伙伴问我怎么用 java 将服务器上的压缩文件解压出来，
阅读更多...
PostgreSQL的扩展dict_int应用案例解析

PostgreSQL的扩展dict_int应用案例解析

《PostgreSQL的扩展dict_int应用案例解析》dict_int扩展为PostgreSQL提供了专业的整数文本处理能力,特别适合需要精确处理数字内容的搜索场景,本文给大家介绍PostgreS... 目录PostgreSQL的扩展dict_int一、扩展概述二、核心功能三、安装与启用四、字典配置方法
阅读更多...
SpringBoot中SM2公钥加密、私钥解密的实现示例详解

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具
阅读更多...
Spring WebFlux 与 WebClient 使用指南及最佳实践

Spring WebFlux 与 WebClient 使用指南及最佳实践

《SpringWebFlux与WebClient使用指南及最佳实践》WebClient是SpringWebFlux模块提供的非阻塞、响应式HTTP客户端,基于ProjectReactor实现,... 目录Spring WebFlux 与 WebClient 使用指南1. WebClient 概述2. 核心依
阅读更多...
Spring Boot @RestControllerAdvice全局异常处理最佳实践

Spring Boot @RestControllerAdvice全局异常处理最佳实践

《SpringBoot@RestControllerAdvice全局异常处理最佳实践》本文详解SpringBoot中通过@RestControllerAdvice实现全局异常处理,强调代码复用、统... 目录前言一、为什么要使用全局异常处理？二、核心注解解析1. @RestControllerAdvice2
阅读更多...
Spring IoC 容器的使用详解(最新整理)

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注
阅读更多...
Spring事务传播机制最佳实践

Spring事务传播机制最佳实践

《Spring事务传播机制最佳实践》Spring的事务传播机制为我们提供了优雅的解决方案,本文将带您深入理解这一机制,掌握不同场景下的最佳实践,感兴趣的朋友一起看看吧... 目录1. 什么是事务传播行为2. Spring支持的七种事务传播行为2.1 REQUIRED（默认）2.2 SUPPORTS2
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2