Spring MVC系列（5）-SpringMVC执行流程及相关Servlet类简介

心已赠人 2023-10-10 13:17 14阅读 0赞

### 前言 ###

当发送HTTP请求时，Spring MVC接收到后，会进行一系列处理，然后将资源响应，这整个流程是怎么处理的呢？

### 执行流程 ###

#### 核心组件 ####

**DispatcherServlet**：**前端控制器**，不需要工程师开发，由框架提供，统一处理请求和响应，整个流程控制的中心，由它调用其它组件处理用户的请求

**HandlerMapping**：**处理器映射器**，不需要工程师开发，由框架提供，根据请求的url、method等信息查找Handler，即控制器方法

**Handler**：**处理器**，需要工程师开发，在DispatcherServlet的控制下Handler对具体的用户请求进行处理

**HandlerAdapter**：**处理器适配器**，不需要工程师开发，由框架提供，通过HandlerAdapter对处理器（控制器方法）进行执行

**ViewResolver**：**视图解析器**，不需要工程师开发，由框架提供，进行视图解析，得到相应的视图，例如：ThymeleafView、InternalResourceView、RedirectView

**View**：**视图**，将模型数据通过页面展示给用户

#### 流程 ####

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

1.  用户发起 request，进入前端控制器DispatcherServlet；
2.  DispatcherServlet请求处理映射器HandlerMapping查找Handler；
3.  HandlerMapping根据用户请求的 url ，查找与之匹配的Handler（也就是 Controller 中配置了相应路径的一个方法），返回一个执行链；
4.  DispatcherServlet再请求处理适配器HandlerAdapter执行Handler；
5.  Handler被执行；
6.  Handler返回ModelAndView对象；
7.  HandlerAdapter又将ModelAndView返回给DispatcherServlet；
8.  DispatcherServlet请求视图解析器View resolver对视图进行解析；
9.  View resolver根据View的信息，匹配相应的视图结果并返回；
10. DispatcherServlet收到View后，对视图进行渲染，将Model中的数据填充到视图中的request 区域，生成最终的视图；
11. 返回 response 。

### 核心类 ###

#### JDK中的Servlet ####

关于Servlet的知识可以查看[文档][Link 1]。

**Servlet**接口位于javax.servlet包下，定义所有 servlet 必须实现的方法。servlet 是在 Web 服务器中运行的小型 Java 程序。 Servlet 接收和响应来自 Web 客户端的请求，通常通过 HTTP，超文本传输协议。

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_11_color_FFFFFF_t_70_g_se_x_16]  
**ServletConfig**接口也位于javax.servlet包下，包含 servlet 的配置和初始化参数，在Servlet初始化时，传递给init方法。  
![在这里插入图片描述][febd3863e8a84b9cb366addc2175a750.png]  
**ServletContext**接口也位于javax.servlet包下，ServletContext官方叫servlet上下文。服务器会为每一个工程创建一个对象，这个对象就是ServletContext对象。这个对象全局唯一，而且工程内部的所有servlet都共享这个对象。所以叫全局应用程序共享对象。

ServletContext的作用如下：

*  是一个域对象
 *  可以读取全局配置参数
 *  可以搜索当前工程目录下面的资源文件
 *  可以获取当前工程名字

**ServletRequest**接口定义一个对象来向servlet 提供客户端请求信息。 servlet 容器创建一个ServletRequest对象并将其作为参数传递给 servlet 的service方法。 ServletRequest对象提供包括参数名称和值、属性和输入流的数据ServletReques的接口可以提供额外的协议特定数据（例如，HTTP 数据由 javax.servlet.http.HttpServletRequest提供）。  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_13_color_FFFFFF_t_70_g_se_x_16]

**ServletResponse**接口定义一个对象来帮助 servlet 向客户端发送响应。 servlet 容器创建一个ServletResponse对象并将其作为参数传递给 servlet 的 service方法。要在 MIME 正文响应中发送二进制数据，请使用 \{@link \#getOutputStream\} 返回的 \{@link ServletOutputStream\}。要发送字符数据，请使用 \* \{@link \#getWriter\} 返回的 PrintWrite对象。例如，要混合二进制和文本数据，以创建多部分响应，请使用 ServletOutputStream并手动管理字符部分。  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_10_color_FFFFFF_t_70_g_se_x_16]

##### GenericServlet抽象类 #####

GenericServlet抽象类实现了Servlet，ServletConfig接口，定义一个通用的、与协议无关的 servlet。新建的 Servlet 程序直接继承 GenericSerlvet 会使开发更简洁。 要编写通用 servlet，您只需覆盖抽象的service方法。  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 1]

##### HttpServlet抽象类 #####

HttpServlet抽象类继承了GenericServlet，是针对于 HTTP 协议所定制，在 service() 方法中直接把 ServletReuqest 和 ServletResponse 转为 HttpServletRequest 和 HttpServletResponse。

定义了HTTP请求方式的很多常量：

private static final String METHOD_DELETE = "DELETE";
        private static final String METHOD_HEAD = "HEAD";
        private static final String METHOD_GET = "GET";
        private static final String METHOD_OPTIONS = "OPTIONS";
        private static final String METHOD_POST = "POST";
        private static final String METHOD_PUT = "PUT";
        private static final String METHOD_TRACE = "TRACE";
        private static final String HEADER_IFMODSINCE = "If-Modified-Since";
        private static final String HEADER_LASTMOD = "Last-Modified";
        private static final String LSTRING_FILE = "javax.servlet.http.LocalStrings";
        private static ResourceBundle lStrings = ResourceBundle.getBundle(LSTRING_FILE);

HttpServlet定了针对HTTP请求处理的一系列方法。  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_18_color_FFFFFF_t_70_g_se_x_16]

#### Spring中的Servlet ####

Spring Web MVC 是最初建立在 Servlet API 之上的 Web 框架。

从源码就可以看出，spring-webmvc模块的代码都在servlet包下。

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

##### HttpServletBean抽象类 #####

HttpServletBean抽象类实现了EnvironmentCapable，EnvironmentAware接口，并继承了HttpServlet类。

他的作用主要有：

*  扩展HttpServlet，重新init方法。
 *  实现了EnvironmentAware接口重写setEnvironment方法。
 *  实现了EnvironmentCapable接口重写getEnvironment方法。

init方法主要是获取web.xml中的配置属性，将这些属性设置到HttpServletBean的对象中。

实现的两个接口就是对Environment提供getter和setter方法，这个Environment就是servlet运行时所处的环境包括profile和properties。

##### FrameworkServlet抽象类 #####

FrameworkServlet抽象类是Spring 的 web 框架的基础版的servlet了，继承了HttpServletBean类，并实现了ApplicationContextAware。

ApplicationContextAware可以获取applicationContext，并设置到当前对象中。

FrameworkServlet有个非常重要的方法initServletBean，这个方法是在父类HttpServletBean中的一个钩子方法(hook method), 也就是定义是在父类中，但是实现是在子类。

initServletBean会调用initWebApplicationContext方法初始化一个WebApplicationContext。然后调用initFrameworkServlet方法，这个方法又是一个钩子方法，在当前类里只有一个空的实现，真正的实现是在子类DispatcherServlet中。

##### DispatcherServlet类 #####

DispatcherServlet类继承自FrameworkServlet抽象类，它就是MVC中HTTP请求处理程序的中央调度器。可以调度注册的处理程序来处理一个 web 请求，提供映射和异常处理设施。 这个 servlet 非常灵活：它几乎可以用于任何工作流。

它的全部继承关系如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 3]

首先看下DispatcherServlet中定义的常量：

// 此命名空间的 bean 工厂中 MultipartResolver 对象的众所周知的名称
        public static final String MULTIPART_RESOLVER_BEAN_NAME = "multipartResolver";
        // 此命名空间的 bean 工厂中 LocaleResolver 对象的众所周知的名称
        public static final String LOCALE_RESOLVER_BEAN_NAME = "localeResolver";
        // 此命名空间的 bean 工厂中 ThemeResolver 对象的众所周知的名称
        public static final String THEME_RESOLVER_BEAN_NAME = "themeResolver";
        //  此命名空间的 bean 工厂中 HandlerMapping 对象的众所周知的名称
        public static final String HANDLER_MAPPING_BEAN_NAME = "handlerMapping";
        // 此命名空间的 bean 工厂中 HandlerAdapter 对象的众所周知的名称
        public static final String HANDLER_ADAPTER_BEAN_NAME = "handlerAdapter";
        // 此命名空间的 bean 工厂中 HandlerExceptionResolver 对象的众所周知的名称
        public static final String HANDLER_EXCEPTION_RESOLVER_BEAN_NAME = "handlerExceptionResolver";
        // 此命名空间的 bean 工厂中 RequestToViewNameTranslator 对象的众所周知的名称
        public static final String REQUEST_TO_VIEW_NAME_TRANSLATOR_BEAN_NAME = "viewNameTranslator";
        // 此命名空间的 bean 工厂中 ViewResolver 对象的众所周知的名称
        public static final String VIEW_RESOLVER_BEAN_NAME = "viewResolver";
        // 此命名空间的 bean 工厂中 FlashMapManager 对象的众所周知的名称
        public static final String FLASH_MAP_MANAGER_BEAN_NAME = "flashMapManager";
        // 请求属性以保存当前的 Web 应用程序上下文
        public static final String WEB_APPLICATION_CONTEXT_ATTRIBUTE = DispatcherServlet.class.getName() + ".CONTEXT";
        // 请求属性以保存当前的 LocaleResolver，可通过视图检索
        public static final String LOCALE_RESOLVER_ATTRIBUTE = DispatcherServlet.class.getName() + ".LOCALE_RESOLVER";
        // 请求属性以保存当前 ThemeResolver，可通过视图检索
        public static final String THEME_RESOLVER_ATTRIBUTE = DispatcherServlet.class.getName() + ".THEME_RESOLVER";
        public static final String THEME_SOURCE_ATTRIBUTE = DispatcherServlet.class.getName() + ".THEME_SOURCE";
        public static final String INPUT_FLASH_MAP_ATTRIBUTE = DispatcherServlet.class.getName() + ".INPUT_FLASH_MAP";
        public static final String OUTPUT_FLASH_MAP_ATTRIBUTE = DispatcherServlet.class.getName() + ".OUTPUT_FLASH_MAP";
        public static final String FLASH_MAP_MANAGER_ATTRIBUTE = DispatcherServlet.class.getName() + ".FLASH_MAP_MANAGER";
        public static final String EXCEPTION_ATTRIBUTE = DispatcherServlet.class.getName() + ".EXCEPTION";
        // 找不到请求的映射处理程序时要使用的日志类别
        public static final String PAGE_NOT_FOUND_LOG_CATEGORY = "org.springframework.web.servlet.PageNotFound";
        // 类路径资源的名称（相对于 DispatcherServlet 类）  定义了 DispatcherServlet 的默认策略名称。
        private static final String DEFAULT_STRATEGIES_PATH = "DispatcherServlet.properties";
        // DispatcherServlet 的默认策略属性开始的公共前缀
        private static final String DEFAULT_STRATEGIES_PREFIX = "org.springframework.web.servlet";
        protected static final Log pageNotFoundLogger = LogFactory.getLog("org.springframework.web.servlet.PageNotFound");

然后看下属性：

@Nullable
    	// 存储默认策略实现
        private static Properties defaultStrategies;
        // 检测所有 HandlerMapping 还是只期望“handlerMapping”bean？
        private boolean detectAllHandlerMappings = true;
        // 检测所有 HandlerAdapter 还是只期望“handlerAdapter”bean？
        private boolean detectAllHandlerAdapters = true;
        // 检测所有 HandlerExceptionResolver 还是只期望“handlerExceptionResolver”bean？
        private boolean detectAllHandlerExceptionResolvers = true;
        // 检测所有 ViewResolver 还是只期望“viewResolver”bean？
        private boolean detectAllViewResolvers = true;
        // 如果没有找到处理此请求的处理程序，则抛出 NoHandlerFoundException？
        private boolean throwExceptionIfNoHandlerFound = false;
        // 在包含请求之后执行请求属性的清理？
        private boolean cleanupAfterInclude = true;
        // Resolvers 解析器
        @Nullable
        private MultipartResolver multipartResolver;
        @Nullable
        private LocaleResolver localeResolver;
        @Nullable
        private ThemeResolver themeResolver;
        @Nullable
        // HandlerMapping集合
        private List<HandlerMapping> handlerMappings;
        @Nullable
        // HandlerAdapter集合
        private List<HandlerAdapter> handlerAdapters;
        @Nullable
        private List<HandlerExceptionResolver> handlerExceptionResolvers;
        @Nullable
        private RequestToViewNameTranslator viewNameTranslator;
        @Nullable
        private FlashMapManager flashMapManager;
        @Nullable
        private List<ViewResolver> viewResolvers;
        private boolean parseRequestPath;

核心方法：

1.  initStrategies()，该方法负责初始化此 servlet 使用的策略。可以看到调用了很多init方法用于初始化。该方法会在FrameworkServlet在初始化ApplicationContext时调用initWebApplicationContext时被调用。

protected void initStrategies(ApplicationContext context) {
        
    		initMultipartResolver(context);
    		initLocaleResolver(context);
    		initThemeResolver(context);
    		initHandlerMappings(context);
    		initHandlerAdapters(context);
    		initHandlerExceptionResolvers(context);
    		initRequestToViewNameTranslator(context);
    		initViewResolvers(context);
    		initFlashMapManager(context);
    	}

1.  doService方法，就是我们处理请求的入口了，它主要是将一些解析器设置在Request中，真正的请求处理在doDispatch方法中。  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 4]
2.  doDispatch就是处理请求并调度的核心方法了，具体逻辑处理过程后续会介绍  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 5]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/fe40c9d99ba946638c176c0391a7eeb2.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_20,color_FFFFFF,t_70,g_se,x_16
[Link 1]: https://www.runoob.com/servlet/servlet-life-cycle.html
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_11_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/d24e8368c9774a9ca02c758b0f59d4dd.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_11,color_FFFFFF,t_70,g_se,x_16
[febd3863e8a84b9cb366addc2175a750.png]: https://img-blog.csdnimg.cn/febd3863e8a84b9cb366addc2175a750.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_13_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/af3774f7085a4b56b948856a35956bf9.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_13,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_10_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/6c4b7ff705394f87a4dbe14cef08ca54.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_10,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/f425fa5ed25c4de6897ad4a2d68d4c7d.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_18_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/6fcac1cb9bde40549e996c952e5563eb.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_18,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/5202dcdfb1d645e39c2783e1abbe8c24.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/79199057ee76409b8619fad0c5ba3403.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 4]: https://img-blog.csdnimg.cn/49ffecaa91d240659da0520e645568ac.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg_size_20_color_FFFFFF_t_70_g_se_x_16 5]: https://img-blog.csdnimg.cn/f2ee645e84f84a6282d8796abab4c683.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5LqR54Of5oiQ6ZuoY3Nkbg==,size_20,color_FFFFFF,t_70,g_se,x_16