SpringMVC源码分析

短命女 2021-11-16 17:28 443阅读 0赞

### 一. Servlet与SpringMVC的关系 ###

**1. Servlet与SpringMVC关系**

Sun公司在其API中提供了一个servlet接口，用户若想用发一个动态web资源(即开发一个Java程序向浏览器输出数据)，需要完成以下2个步骤：

① 编写一个Java类，实现servlet接口。

② 把开发好的Java类部署到web服务器中。

按照一种约定俗成的称呼习惯，通常我们也把实现了servlet接口的java程序，称之为Servlet

SpringMVC是基于Servlet封装的MVC框架

**2. 快速搭建一个Servlet项目：**

① 基于xml方式

<servlet>
        <servlet-name>MyServlet</servlet-name>
        <servlet-class>com.example.servlet.MyServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>MyServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

public class MyServlet extends HttpServlet {
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            resp.getWriter().print(" this is servlet");
        }
    }

② 基于注解方式

@WebServlet("/")
    public class MyServlet extends HttpServlet {
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            resp.getWriter().print(" this is servlet");
        }
    }

**3. 使用注解形式启动SpringMVC项目**

import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;
    
    @Configuration
    @ComponentScan("com.example.controller")
    @EnableWebMvc
    public class SpringMvcConfig {//   WebMvcConfigurerAdapter
          /*
            @Configuration 等同于 xml配置
            @ComponentScan等同于 mvc扫包范围：
                <context:component-scan base-package="com.example.controller"/>
            @EnableWebMvc 等于开启SpringMVC注解方式
                 <!- 注册apringMvc注解驱动, 开启消息转换器 ->
                <mvc:annotation-driven/>
         */
    }

import org.springframework.web.WebApplicationInitializer;
    import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
    import org.springframework.web.servlet.DispatcherServlet;
    import javax.servlet.ServletContext;
    import javax.servlet.ServletException;
    import javax.servlet.ServletRegistration;
    public class WebInitializer implements WebApplicationInitializer  {
    
        public void onStartup(ServletContext servletContext) throws ServletException {
            // 1.启动SpringMVC 容器 类注入到Spring中
            AnnotationConfigWebApplicationContext app = new AnnotationConfigWebApplicationContext();// 启动SpringMVC Web
            // 2.注入我们的springmvc 的配置文件
            app.register(SpringMvcConfig.class);
            // 3. 将我们的DispatcherServlet 注入到 servlet容器中
           ServletRegistration.Dynamic dynamic =
                    servletContext.addServlet("dispatcher", new DispatcherServlet(app));
            // 4.填写url路径映射
            dynamic.addMapping("/");
            dynamic.setLoadOnStartup(1);// 优先级最高表示 最早被加载
        }
        // 基本配置已经ok了（在SpringMvcConfig中），这时候需要加载servlet，
        // 想要加载servlet，传统方式必须用web.xml，这里使用WebApplicationInitializer 替代web.xml
    }

注意：启动的时候把webapp下的webapp等文件删掉，否则会报错。

**4. SpringServletContainerInitializer源码分析**

JavaEE项目必须有web.xml ？ 那么为什么在SpringBoot/MVC中不需要web.xml呢？

没错，靠的就是**SpringServletContainerInitializer**

①** **Spring-Web依赖Jar包，SpringServletContainerInitializer 提供给SpringMVC实现初始化

![20190729102754955.png][]

![20190729102842155.png][]

② 进入SpringServletContainerInitializer

![20190729103229954.png][]@HandlesTypes（WebApplicationInitializer）以后谁实现WebApplicationInitializer，谁就可以加在到Set集合中，该set集合官方定义为感兴趣的类。

③ 上面我们自定义的WebInitializer即实现了WebApplicationInitializer，所以在Servlet容器启动的时候，就可以拿到WebInitializer

### 二. DispatcherServlet源码分析 ###

**1. SpringMVC流程分析**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70][]

HttpServlet Service 判断请求如果Get请求，则先走父类（FrameworkServlet），走完父类走子类。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 3][]

![20190729115408371.png][]

自己的doService是抽象方法，让子类DispatcherServlet去实现：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 4][]

其中会调勇doService方法中的doDispatch()方法，SpringMVC原理核心就在doDispat该方法：

![20190729115557629.png][]

**一句话描述流程：**

Servlet容器在加载的时候会调用init方法，当客户端有请求时，会调用Servie方法（调用 service() 方法来处理来自客户端（浏览器）的请求，并把格式化的响应写回给客户端），所以步骤如下：

客户端发送请求 → HttpServlet的Service() → 判断请求，如果是get请求→ FrameworkServlet的doGet() →  FrameworkServlet的processRequest() → DispatcherServlet的doService() → DispatcherServlet的doDispatch()【doDispatch()是SpringMVC的核心，下面详细讲解该方法】

**2. doDispatch()源码分析**

**① getHandler**

通过url查询到具体的控制请求的方法，如果没有找到情况下直接返回404（handler 对应的其实就是我们的控制层类方法）。

![20190729151612863.png][] **doDispatch()**![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 5][] **getHandler()**

会返回相应的HandlerExecutionChain类型的mappedHandler，那么SpringMVC如何判断返回什么类型的？看下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 6][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 7][]

所以我们就知道了答案，如果是注解形式做映射，则返回RequestMappingHandlerMapping；如果是通过传统的xml方式定义url映射，则返回BeanNameUrlHandlerMapping类型的handlerMappings，然后去调用相应的getHandler方法拿到具体handler。

**② getHandlerAdapter()（调用该方法返回某个类型的适配器）**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 8][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 9][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 10][]

使用**getHandlerAdapter()**获取对应的hanlder的具体HandlerAdapter。

可以看到，会循环遍历所有handlerAdapters，该集合是泛型为HandlerAdapter的List集合，其中HandlerAdapter为接口，一共有上图中5个实现类，下面详解常用三种HandlerAdapter处理请求适配器【因为SpringMVC默认帮我们初始化一下三个适配器，这三个适配器是在initStrategies方法被初始化的】：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 11][]

--------------------

**SimpleControllerHandlerAdapter：**实现Controller方式所使用的适配器（即我们的controller层的类实现了Controller注解）

![20190729173709751.png][]

注意实现Controller接口要导入mvc的，不是spring的。

**RequestMappingHandlerAdapter：**注解方式@Controller的处理器适配器（最常用，即在controller类上加入@Controller注解）

**HttpRequestHandlerAdapter** ：HTTP请求处理器适配器（即我们的controller层的类实现了HttpRequestHandler接口）

--------------------

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 12][]

@Override
    public final boolean supports(Object handler) {
        return (handler instanceof HandlerMethod && supportsInternal((HandlerMethod) handler));
    }

在上面getHandlerAdapter()方法中遍历的时候，就已经得到了适配器的类型，即如果加了@Controller注解的时候，ha就是指的RequestMappingHandlerAdapter，而supports()方法判断当前handler是否是HandlerMethod类型，是的话则直接返回ha到DispatcherServlet的doDispatch()方法。![20190729181140164.png][]

**那么为什么SpringMVC要加一层适配器？**

**答案：**为了做扩展，不同的请求，针对不同的handler，针对不同的适配器；然后适配器帮助我们调用具体方法。

**③ 后续则先后调用** **preHandle()，目标方法，PostHandle()，afterCompletion()等**

### 三. 总结 ###

**【DispatcherServlet源码流程分析】：**

**1>** 执行doDispatch

**2>** 调用**getHandler**方法获取请求目标的方法  也就是 请求url映射路径对应的控制层具体的方法（即根据url获取handler）

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

**3>** 调用**getHandlerAdapter**获取控制层适配器 RequestMappingHandlerAdapter

**4>** 执行拦截器前置方法 **preHandle()** 如果返回为true的话，则继续往后执行，否则return

**5>** 执行实际请求**目标方法**（反射技术），返回modeAndView对象

**6>** 执行拦截器**postHandle()**方法

**7>** 设置渲染视图层内容 processDispatchResult → processDispatchResult 的**render()**进行渲染页面

**8>** 同样还是processDispatchResult方法，其mappedHandler.triggerAfterCompletion() → interceptor.afterCompletion() 执行拦截器**afterCompletion()**方法

【**SpringMVC控制层容器初始化**】**：**

SpringMVC映射路径的容器（即url和handler映射map集合）在什么时候被创建呢？

答案：Servlet初始化调用**init()**方法的时候

验证：1> HttpServletBean  init ()方法【容器启动调用init方法】

2> FrameworkServlet initServletBean方法→  initWebApplicationContext() 【FrameworkServlet 中间做了个转接】

3> DispatcherServlet onRefresh方法→  initStrategies()方法【最后执行到DispatcherServlet 的initStrategies方法】

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

想要充分理解SpringMVC源码，手动去Debug走一遍吧 ~

[20190729102754955.png]: /images/20211116/5857aa34943f4a0bb149dba47f5945d7.png
[20190729102842155.png]: /images/20211116/a2aa15f3936f44419e49cf103b00efc9.png
[20190729103229954.png]: /images/20211116/30727411758d4757b894c540852388ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70]: /images/20211116/75366344de0d46d2aa9d2e430c93f411.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 1]: /images/20211116/033a07f510ba42aababb034431d1a383.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 2]: /images/20211116/7f4c92ad4bcd4448be2798c8b6b951fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 3]: /images/20211116/f38de40c6f274cb59dd1802c8bf04a4f.png
[20190729115408371.png]: /images/20211116/60f0efc765114a1882f2f5571bd2697e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 4]: /images/20211116/7785bc5520024a04a48b3049c872200c.png
[20190729115557629.png]: /images/20211116/dcf4a463516343feb9c8c77e3d35a945.png
[20190729151612863.png]: https://img-blog.csdnimg.cn/20190729151612863.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 5]: /images/20211116/f0b9fcad75d048f29d5f37851552c925.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 6]: /images/20211116/731f13abc3e84174bd304177c51f1801.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 7]: /images/20211116/567e009235a44f599b8b910d0a49d2b1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 8]: /images/20211116/6f96ffd14876429493ad7918f507e457.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 9]: /images/20211116/3466a6a72f83438cb1140ba57ef17f29.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 10]: /images/20211116/7ef3a8d53d6e44859afd5b13f3e54047.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 11]: /images/20211116/21920bca99f742d8a3d6b562959abd97.png
[20190729173709751.png]: /images/20211116/8b9abae04b7645cb8fe0e1b6c06e1df9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FraXJhTmlja3k_size_16_color_FFFFFF_t_70 12]: /images/20211116/0718cb913db54c91b0de29c80c86ab34.png
[20190729181140164.png]: /images/20211116/a3c0a16c1fd8407d88747f822e69ea05.png