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 + '\'' +
                '}';
    }
}

結果如下圖所示:

二、結果分析

從以上代碼和結果，可以看出SpringMVC框架帶來的好處之一就是，自動注入參數。
寫過servlet+jsp+bean代碼的程序員都清楚，在servlet中處理請求參數是一件十分麻煩的事，每次都需要從request中獲取字符串類型的數據，然後轉化爲我們所需要的參數。而在springmvc中已經幫我們處理注入了，我們只需要使用就行。
接下來不拓展springMVC的所有流程，只介紹一些主要的，瞭解controller層方法能注入哪些參數(如例子中的HttpServletRequest)，能返回哪些數據

三、源碼分析

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執行流程
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完成