SpringBoot学习小结之SpringMVC处理流程

SpringBoot学习小结之SpringMVC处理流程

---

前言

所用SpringBoot版本为2.1.6.RELEASE,相对应的Spring版本为5.1.8.RELEASE

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.aabond</groupId>
    <artifactId>springboottodo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboottodo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

一、简单例子

package com.aabond.springboottodo.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @className: DemoController
 * @description: TODO
 * @author: aabond
 * @date: 2019/10/14 
 * @version: v1.0.0
 **/
@RestController
public class DemoController {

    private static final Logger logger = LoggerFactory.getLogger(DemoController.class);

    @GetMapping("/demo")
    public String demo() {
        return "demo";
    }

    @GetMapping("/demoParam")
    public String demoParam(Integer id, TestParam param, HttpServletRequest request) {
        return id + " | " + param + " | " + request.getMethod();
    }
    
}

package com.aabond.springboottodo.enity;

/**
 * @className: TestParam
 * @description: TODO
 * @author: aabond
 * @date: 2019/10/14
 * @version: v1.0.0
 **/
public class TestParam {
    private Integer id;
    private String name;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "TestParam{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}

结果如下图所示:

二、 结果分析

1. 从以上代码和结果，可以看出SpringMVC框架带来的好处之一就是，自动注入参数。
2. 写过servlet+jsp+bean代码的程序员都清楚，在servlet中处理请求参数是一件十分麻烦的事，每次都需要从request中获取字符串类型的数据，然后转化为我们所需要的参数。而在springmvc中已经帮我们处理注入了，我们只需要使用就行。
3. 接下来不拓展springMVC的所有流程，只介绍一些主要的，了解controller层方法能注入哪些参数(如例子中的HttpServletRequest)，能返回哪些数据

三、 源码分析

1. DispatcherServlet主要流程如下,暂时只详细分析前三行:

   mappedHandler = getHandler(processedRequest);
   HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
   mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
   applyDefaultViewName(processedRequest, mv);
   mappedHandler.applyPostHandle(processedRequest, response, mv);
   processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
   

   1. 根据request获取handler, 实际是包含interceptorList和handler的HandlerExecutionChain

      

   2. 根据handler获取HandlerAdapter，HandlerAdapter负责执行handler。一般我们会使用RequestMapping注解，会匹配第一个RequestMappingHandlerAdapter

      

   3. HandlerAdapter执行handler, 下面详细分析RequestMappingHandlerAdapter执行流程

2. RequestMappingHandlerAdapter

   • 执行handler方法，RequestMappingHandlerAdapter并没有handler这个方法，实际会执行父类AbstractHandlerMethodAdapter中的handler方法，
     

   • 然后又因为父类中handleInternal是个抽象方法，被RequestMappingHandlerAdapter重写，于是会执行子类中的handleInternal方法

     

   • 接着会执行invokeHandlerMethod这个方法，会设置argumentResolvers和returnValueHandlers

     

     

   • 然后就是执行invokeAndHandle这个方法，在这个方法中会得到我们在controller中写的方法的返回值
     

   • 由invokeForRequest得到返回值，会先获取方法上的参数，然后调用doInvoke执行

     

   • 获取方法参数getMethodArgumentValues，在此方法中会通过resolvers解析，resolvers有26种参数解析器

     
     

   • 进入resolves的resolveArgument方法，并通过getArgumentResolver获取那26种参数解析器之一，然后调用解析器的resolveArgument方法

     

     

   • 在上述调试中第一个参数会匹配RequestParamMethodArgumentResolver这个解析器，而这个解析器并没有resolveArgument方法，因此会调用父类AbstractNamedValueMethodArgumentResolver的resolveArgument方法

     

     

   • 父类会调用resolveName抽象方法，子类重写了此方法，于是会调用子类中的方法，从request根据name获取String数组，根据数组长度返回参数

     

   • 在上述调试中第二个参数会匹配ServletModelAttributeMethodProcessor这个解析器，而这个解析器同样没有resolveArgument方法，于是调用继承的父类的方法

     
     

   • 进入createAttribute方法中，会通过反射实例化TestParam, 参数为空。

     

   • 然后调用bindRequestParameters绑定参数设置值。会经过各种处理跳转，最终会通过反射执行实体的set方法注入
     

   • 第三个参数，会由ServletRequestMethodArgumentResolver匹配上，并注入参数

   • 获取完参数，会调用doInvoke通过反射执行
     

   • 执行完我们写的controller中的方法，得到返回Object，开始对返回结果处理，在这次调试中，使用了RestController注解，也就是加了RespouseBody注解，匹配上了RequestResponseBodyMethodProcessor，最终由处理器执行handleReturnValue完成