SpringBoot接收接口入參的方式小結

更新時間：2024年01月10日 10:01:15 作者：象牙酥

這篇文章主要給大家介紹了SpringBoot接收接口入參的幾種方式,我們從調用方的視角去看待這個問題,對調用方來說,它在調用接口時有好幾種傳參方式,下面,將會依次對這幾種參數方式進行講解和代碼示例,需要的朋友可以參考下

3.2.1 接口定義方式1：在方法形參的位置,把每個參數都平鋪開來
3.2.2 接口定義方式2：用一個實例來接收入參
3.2.3 接口定義方式3：用原生的HttpServletRequest接收參數
3.2.4 (error)接口定義方式4：用Map接收參數
3.2.5 (error)接口定義方式5：每個參數都平鋪開來,并嘗試獲取File文件入參

引言

我們從調用方的視角去看待這個問題，對調用方來說，它在調用接口時有如下的幾種傳參方式：

Query參數。表現形式是調用方在調用接口時，入參是拼接在接口的URI后面的，如/test_get/requestparam_1?name=wangwu&age=18。這種方式在入參個數比較少的GET請求方式中比較常用。

Path參數。這是REST風格的路徑參數，入參直接拼接在接口的URI里面,如/test_pathvar/test1/zhangsan/1，其中的zhangsan和1就是就是參數。這種方式在REST風格的接口中比較常用。

Body參數。這種方式是把入參放在了請求體當中！它跟前兩種入參方式的最大區(qū)別，就是：

1)前兩種入參方式它們的入參都是直接體現在了調用接口時候的URI中

2)而當前的這種Body參數方式，它的入參是放在了Body請求體內

而且，Body參數又可以細分成如下的幾種方式:

application/json 前后端分離項目中常用的傳參方式

x-www-form-urlencoded 上傳表單數據

form-data 上傳表單數據

raw

binary

另外需要強調的是，無論是GET、POST、PUT還是DELETE請求方式，從技術上來說，它們是都支持上面提到的幾種傳參方式的！只不過在日常的開發(fā)中，我們可能習慣了GET+Query參數或者POST+Body參數(application/json)這樣的搭配使用方式

下面，將會依次對這幾種參數方式進行講解和代碼示例。

重要說明

項目的pom依賴

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.9.RELEASE</version>
    </parent>

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

        <!--Hutool是一個小而全的Java工具類庫-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.6.3</version>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.30</version>
        </dependency>
        <!--fastjson-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.6</version>
        </dependency>
    </dependencies>

代碼的說明

下面所有接口的定義，使用的都是@RequestMapping，且都沒有指定具體的請求類型——如此故意為之就是為了使得接口從技術上支持各種請求方式（GET POST PUT DELETE等），好方便測試在不同的請求方式下，是否支持各種不同的傳參方式。但是大家在平日的業(yè)務代碼開發(fā)中，最好是在接口定義時指定特定的請求方式。
在下面所有的代碼中，我都在方法定義的形參中加上了HttpServletRequest，是因為我要從HttpServletRequest中獲取請求的方法類型（request.getMethod()）和URI（ request.getRequestURI()），從而在接口的返回結果在顯現出來，以方便調試。
大家在自己實際的業(yè)務代碼中可以根據自身需求決定是否加上這個。不加也不影響入參的接收！
下面所以接口的定義中，方法返回類型都是string類型，如：

method: [DELETE], uri: [/test_query/requestparam_1], param type: [Query]  ---> SUCCESS! requestParam1 name = wangwu-delete, age = 18

但是看后面調用方調用接口的返回結果，卻是如下所示的json串：

{
    "code": 0,
    "data": "method: [DELETE], uri: [/test_query/requestparam_1], param type: [Query]  ---> SUCCESS! requestParam1 name = wangwu-delete, age = 18",
    "msg": "操作成功",
    "timestamp": 1704766444205
}

可以看到方法返回的String內容則是在json串的data這個key當中。
這是因為在我的項目中，我結合@RestControllerAdvice和ResponseBodyAdvice，對接口返回結果進行了統(tǒng)一的處理。（核心的處理邏輯是：如果接口返回結果類型已經是指定的ResultVO，直接返回；否則將接口返回結果封裝到ResultVO對象的data字段中，再返回。）

4. 本文旨在展示在各種請求方式下對不同傳參方式的支持情況，因此下面代碼中，都沒有對接口入參進行任何的校驗——即：校驗不是本文的重點，關于接口入參的校驗，可以去看我的另一篇博客。

1.Query參數

Query參數，表現形式是調用方在調用接口時，入參是拼接在接口的URI后面的，如/test_query/requestparam_1?name=wangwu&age=18。

1.1接口定義方式1：在方法形參的位置,把每個參數都平鋪開來

定義方式: 在方法形參的位置,把每個參數都平鋪開來
兼容的請求方式：GET POST PUT DELETE
適用場景：雖然這種傳參方式，從技術上來說可用于GET POST PUT DELETE等請求方式，但是在日常開發(fā)中一般偏向于應用在入參個數少(一般少于5個)的GET請求方式中
優(yōu)點:方便簡單
缺點:
- 調用時入參直接顯示在uri中，不太安全
- 方法定義時參數個數如果過多,方法體結構會顯得很臃腫
- 沒有入參校驗

代碼

package com.su.demo.controller.param_type;

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;


@RestController
@RequestMapping(value = "/param_type/query")
public class TestQueryController {

    /**
     * <ul>
     *     <li><b>入參類別</b>：Query參數
     *     <li><b>定義方式</b>: 在方法形參的位置,把每個參數都平鋪開來</li>
     *     <li><b>調用方式</b>: 入參拼接在接口的uri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：雖然這種傳參方式,適用于GET POST PUT DELETE等請求方式,但是一般偏向于應用在 入參個數少(一般少于5個)的<b>GET</b>請求方式中</li>
     *     <li><b>優(yōu)點</b>:方便簡單</li>
     *     <li><b>缺點</b>:1) 入參直接顯示在uri中，不太安全 2）參數個數如果過多,方法體結構會顯得很臃腫; 3）沒有入參校驗</li>
     * </ul>
     * <p><b>注意</b>:根據自己的需求決定是否在形參中加上HttpServletRequest,我這里是為了從request中獲取method,所以加上了</p>
     */
    @RequestMapping(value = "/test1")
    public String test1(String name, Integer age, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = " + age;
    }

}

調用case

注意看上面這個/param_type/query/test1接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以GET 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

發(fā)起請求：

在這里插入圖片描述

接口返回結果：

在這里插入圖片描述

1.2接口定義方式2：在方法形參的位置,結合@RequestParam把每個參數都平鋪開來

定義方式: 在方法形參的位置,結合@RequestParam把每個參數都平鋪開來
兼容的請求方式：GET POST PUT DELETE
適用場景：雖然這種傳參方式，從技術上來說可用于GET POST PUT DELETE等請求方式，但是在日常開發(fā)中一般偏向于應用在入參個數少(一般少于5個)的GET請求方式中
優(yōu)點:方便簡單，且結合@RequestParam，可實現入參的必填校驗/重命名/默認值等簡單的校驗功能
缺點:
- 調用時入參直接顯示在uri中，不太安全
- 方法定義時如果參數個數如果過多,方法體結構會顯得很臃腫
- @RequestParam能支持的校驗相對來說還是比較簡單

代碼

package com.su.demo.controller.param_type;

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;

@RestController
@RequestMapping(value = "/param_type/query")
public class TestQueryController {

    /**
     * <ul>
     *     <li><b>入參類別</b>：Query參數
     *     <li><b>定義方式</b>: 在方法形參的位置,把每個參數都平鋪開來.并且相較于前一種定義方式,這種方式使用 {@link RequestParam}綁定請求參數到方法形參， 且需要注意該注解中的各個屬性的作用！</li>
     *     <li><b>調用方式</b>: 入參拼接在接口的uri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：雖然這種傳參方式,適用于GET POST PUT DELETE等請求方式,但是一般偏向于應用在 入參個數少(一般少于5個)的<b>GET</b>請求方式中</li>
     *     <li><b>優(yōu)點</b>:方便簡單;且結合{@link RequestParam},可實現入參的必填校驗/重命名/默認值等簡單的功能</li>
     *     <li><b>缺點</b>:1) 入參直接顯示在uri中，不太安全
     *                    2）參數個數如果過多,方法體結構會顯得很臃腫(當前這個方法有4個入參,其實就已經有點臃腫了)
     *                    3){@link RequestParam}能支持的校驗相對來說還是比較簡單</li>
     * </ul>
     */
    @RequestMapping(value = "/test2_requestparam")
    public String test2(@RequestParam String name,
                                @RequestParam(name = "newAge") Integer age,
                                @RequestParam(name = "birth", required = false) @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") Date birth,
                                @RequestParam(defaultValue = "true") Boolean enable,
                                HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = " + age + ", birth = " + birth + ", enable = " + enable;
    }

}

調用case

注意看上面這個/param_type/query/test2_requestparam接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以GET 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

1.3接口定義方式3：把入參封裝到一個實體中

定義方式: 把入參封裝到一個實體中
兼容的請求方式：GET POST PUT DELETE
適用場景：雖然這種傳參方式，從技術上來說可用于GET POST PUT DELETE等請求方式，但是在日常開發(fā)中一般偏向于應用在入參個數多(一般大于5個)的GET請求方式中
優(yōu)點:因為參數都封裝在實體對象當中了，所以對參數的個數就沒有什么的限制了，接口定義的時候方便多了
缺點:對于這種入參的定義方式來說，它是沒有什么缺點的，硬要說缺點的話，其實是針對Query這種傳參方式來說的，即：當參數個數一多的時候，參數都放在請求uri中了，一個是不太安全，另外也容易造成uri的長度過過長 (雖然http協(xié)議中未明確對url進行長度限制，但在真正實現中，url的長度還是受到限制的，一是服務器端的限制，二就是游覽器端的限制)

注：再次申明，在下面代碼中，我在方法定義的形參中加上了HttpServletRequest，是因為我要從HttpServletRequest中獲取請求的方法類型（request.getMethod()）和URI（ request.getRequestURI()），從而在接口的返回結果在顯現出來，以方便調試。
大家在自己實際的業(yè)務代碼中可以根據自身需求決定是否加上這個。不加也不影響入參的接收！

代碼

package com.su.demo.controller.param_type;

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;

@RestController
@RequestMapping(value = "/param_type/query")
public class TestQueryController {

    /**
     * <ul>
     *     <li><b>入參類別</b>：Query參數
     *     <li><b>定義方式</b>: 把入參封裝到一個實體中(入參個數多于5個時一般用這種方式)
     *     <li><b>調用方式</b>: 入參拼接在接口的uri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術上來說這種傳參方式,同時適用于GET POST PUT DELETE等多種請求方式,但是一般我個從偏向于在入參個數大于5個的<b>GET</b>請求方式中使用</li>
     *     <li><b>優(yōu)點</b>:因為參數都封裝在實體bean當中了,所以對參數的個數就沒有什么的限制了,接口定義的時候方便多了
     *     <li><b>缺點</b>:對于這種入參的[定義方式]來說,它是沒有什么缺點的.硬要說缺點的話,其實是針對Query這種傳參方式來說的,即當參數個數一多的時候,參數都放在請求uri中容易造成uri的長度過過長
     *     (雖然http協(xié)議中未明確對url進行長度限制，但在真正實現中，url的長度還是受到限制的，一是服務器端的限制，二就是游覽器端的限制)</li>
     * </ul>
     */
    @RequestMapping(value = "/test3_entity")
    public String test3(UserDTO userDTO, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        return requestMetaInfo + " ---> SUCCESS! userDTO = " + userDTO;
    }

}

其中UserDTO 的代碼如下：

package com.su.demo.bean.dto;

import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import java.util.Date;

@Data
public class UserDTO {
    /**
     * 主鍵ID
     */
    private Long id;

    /**
     * 用戶姓名
     */
    private String name;

    /**
     * 用戶狀態(tài) true：啟用；false：禁用
     */
    private Boolean enable;

    /**
     * 用戶生日
     */
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date birth;
}

調用case

注意看上面這個/param_type/query/test3_entity接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以POST 請求方式的調用結果為例，看是否可以在controller代碼中獲到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

1.4接口定義方式4：用原生的HttpServletRequest接收參數

定義方式: 在方式形參的位置,用原生的HttpServletRequest接收
兼容的請求方式：GET POST PUT DELETE
適用場景：現在很少用這種方式去接收入參了。
優(yōu)點:HttpServletRequest是整個請求，可以獲取到所有的數據.且HttpServletRequest、HttpServletResponse都是內置對象，可以使用
缺點:代碼中再去從request中拿到參數,比較麻煩

代碼

package com.su.demo.controller.param_type;

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;

@RestController
@RequestMapping(value = "/param_type/query")
public class TestQueryController {

    /**
     * <ul>
     *     <li><b>入參類別</b>：Query參數
     *     <li><b>定義方式</b>: 在方式形參的位置,用原生的{@link HttpServletRequest}接收
     *     <li><b>調用方式</b>: 入參拼接在接口的uri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下比較少用這種方式來獲取參數了</li>
     *     <li><b>優(yōu)點</b>:{@link HttpServletRequest}是整個請求，可以獲取到所有的數據.且HttpServletRequest、HttpServletResponse都是內置對象，可以使用</li>
     *     <li><b>缺點</b>:代碼中再去從request中拿到參數,比較麻煩</li>
     * </ul>
     * <p> 注意,這種方式其實也可以獲取body請求體里面的數據,參考https://blog.csdn.net/qq_24850045/article/details/121927722
     */
    @RequestMapping(value = "/test4_request")
    public String test4(HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        String name = request.getParameter("name");
        Integer age = Integer.parseInt(request.getParameter("age")); // 需要進行類型轉換

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = "  + age;
    }

}

調用case

注意看上面這個/param_type/query/test4_request接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以PUT 請求方式的調用結果為例，看是否可以在controller代碼中獲到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

1.5接口定義方式5：用Map結合RequestParam接收參數

定義方式: 在方式形參的位置,用Map結合RequestParam接收參數
兼容的請求方式：GET POST PUT DELETE
適用場景：適用于參數個數較多，但是自己又想偷懶不想專門定義一個實體來接收入參的場景。一般不推薦使用這種方式。
優(yōu)點:簡單方便，偷懶很開心
缺點:1）需要在代碼中通過指定特定的key的方式去獲取入參，比較麻煩；2）利用map去get到入參之后，還需要手動的去做非空判斷+數據類型轉換等，很麻煩；3）而且這種接收入參的方式，沒有辦法結合org.springframework.validation.annotation.Validated來做入參校驗！

代碼

package com.su.demo.controller.param_type;

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;

@RestController
@RequestMapping(value = "/param_type/query")
public class TestQueryController {

    /**
     * <ul>
     *     <li><b>入參類別</b>：Query參數
     *     <li><b>定義方式</b>: 在方式形參的位置,結合{@link RequestParam}用Map接收
     *     <li><b>調用方式</b>: 入參拼接在接口的uri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：適用于參數個數較多，但是自己又想偷懶不想專門定義一個實體來接收入參的場景。一般不推薦使用這種方式。</li>
     *     <li><b>優(yōu)點</b>:簡單方便</li>
     *     <li><b>缺點</b>:需要在代碼中通過指定特定的key的方式去獲取入參，比較麻煩；而且這種接收入參的方式，沒有辦法結合{@link org.springframework.validation.annotation.Validated}來做入參校驗</li>
     * </ul>
     */
    @RequestMapping(value = "/test5_map")
    public String test5(@RequestParam Map<String, String> paramMap, HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        String name = paramMap.get("name");
        // 判斷：如果paramMap.get("age")為null，則age賦默認值0；否則進行入參類型的轉換
        Integer age = null == paramMap.get("age") ? 0: Integer.parseInt(paramMap.get("age"));

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = "  + age;
    }

}

調用case

注意看上面這個/param_type/query/test5_map接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以DELETE 請求方式的調用結果為例，看是否可以在controller代碼中獲到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

2.Path參數

Path參數，表現形式是入參直接拼接在接口的URI里面,如/test_pathvar/test1/zhangsan/1，其中的zhangsan和1就是就是參數。這種方式在REST風格的接口中比較常用。

REST(英文：Representational State Transfer，簡稱REST，意思：表述性狀態(tài)轉換，描述了一個架構樣式的網絡系統(tǒng)，比如web應用)，一定要記住==它是一種軟件架構風格！而不是標準！==它只是提供了一組設計原則和約束條件。它主要用于客戶端和服務器交互類的軟件?；谶@個風格設計的軟件可以更簡潔，更有層次，更易于實現緩存等機制。
REST指的是一組架構（約束條件）和原則。滿足這些（約束條件）和（原則）的應用程序或設計就是 Restful。

2.1接口定義方式：用占位符的方式把入參封裝到請求路徑中

定義方式: 用占位符的方式把入參封裝到請求路徑中,然后再通過@PathVariable注解可以將URL中的占位符參數綁定到控制器（controller）處理方法的形參中
兼容的請求方式：GET POST PUT DELETE
適用場景：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等多種請求方式。但是一般入參個數較少，且你開發(fā)的是REST風格的接口，那可以考慮用這種方式
優(yōu)點和缺點:優(yōu)點和缺點，其實就是REST風格的接口的優(yōu)點和缺點了，大家可以自行去查閱

代碼

package com.su.demo.controller.param_type;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;

@RestController
@RequestMapping(value = "/param_type/path_variable")
public class TestPathVarController {


    /**
     * <ul>
     *     <li><b>入參類別</b>：PathVariable路徑參數方式
     *     <li><b>定義方式</b>: 用占位符的方式把入參封裝到請求路徑中,然后再通過@PathVariable注解可以將URL中的占位符參數綁定到控制器（controller）處理方法的形參中. </li>
     *     <li><b>調用方式</b>: REST風格路徑參數,入參拼接在接口的URI里面,如/test_pathvar/test1/zhangsan/1 </li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等多種請求方式.
     *         但是一般入參個數小于5個,且你開發(fā)的是REST風格的接口,那可以考慮用這種方式
     *         </li>
     * </ul>
     * <p>REST(英文：Representational State Transfer，簡稱REST，意思：表述性狀態(tài)轉換，描述了一個架構樣式的網絡系統(tǒng)，比如web應用)，是一種軟件架構風格不是標準哦！
     * 只是提供了一組設計原則和約束條件。它主要用于客戶端和服務器交互類的軟件?；谶@個風格設計的軟件可以更簡潔，更有層次，更易于實現緩存等機制。
     * REST 指的是一組架構（約束條件）和原則。滿足這些（約束條件）和（原則）的應用程序或設計就是 Restful。</p>
     */
    @RequestMapping(value = "/test1/{name}/{age}")
    public String test1(@PathVariable("name") String name, @PathVariable("age") Integer myage, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));
        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", myage = "  + myage;
    }
}

調用case

注意看上面這個/param_type/path_variable/test1/{name}/{age}接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以GET 請求方式的調用結果為例，看是否可以在controller代碼中獲到調用方傳過來的實參。

可以看到，參數都獲取到了。

3.Body參數

Body參數，這種方式是把入參放在了請求體當中！它跟前兩種入參方式的最大區(qū)別，就是：

前兩種入參方式它們的入參都是直接體現在了調用接口時候的URI中
而當前的這種Body參數方式，它的入參是放在了http請求的請求體內
而且，Body參數又可以細分成如下的幾種方式:
- application/json 前后端分離項目中常用的傳參方式
- form-data
- x-www-form-urlencoded
- raw
- binary

下面分別進行說明

3.1 `application/json`

這種入參方式，入參放在http請求的請求體當中，并且Content-Type=application/json。

3.1.1 接口定義方式1：在方式形參的位置,用原生的`HttpServletRequest`接收

定義方式: 在方式形參的位置,用原生的HttpServletRequest接收
兼容的請求方式：GET POST PUT DELETE
適用場景：從技術上來說，這種傳參方式同時適用于GET POST PUT DELETE等請求方式，但是正常情況下比較少用這種方式來獲取Content-Type=application/json的body參數了
優(yōu)點:HttpServletRequest是整個請求，可以獲取到所有的數據。且HttpServletRequest、HttpServletResponse都是內置對象，可以使用
缺點:碼中再去從request中拿到參數，老麻煩了，可以看下面的代碼

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.alibaba.fastjson.JSON;
import com.su.demo.bean.dto.UserDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@RestController
@RequestMapping(value = "/param_type/body_json")
public class TestBodyController {


    /**
     * <ul>
     *     <li><b>入參類別</b>：body參數方式
     *     <li><b>定義方式</b>: 在方式形參的位置,用原生的{@link HttpServletRequest}接收
     *     <li><b>調用方式</b>: 參數放在請求體 body 當中
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下比較少用這種方式來獲取body參數了</li>
     *     <li><b>優(yōu)點</b>:{@link HttpServletRequest}是整個請求，可以獲取到所有的數據.且HttpServletRequest、HttpServletResponse都是內置對象，可以使用</li>
     *     <li><b>缺點</b>:代碼中再去從request中拿到參數,老麻煩,可以看下面的代碼</li>
     * </ul>
     * <p> 注意,這種方式其實也可以獲取body請求體里面的數據,參考https://blog.csdn.net/qq_24850045/article/details/121927722
     */
    @RequestMapping(value = "/test1_request")
    public String test1(HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        ServletInputStream inputStream = request.getInputStream();
        // 用hutool工具包的read方式,將inputStream讀取成string
        String body = IoUtil.read(inputStream, "UTF-8");
        System.out.println("body = " + body);
        // 用fastjson將json字符串轉換成bean
        UserDTO userDTO = JSON.parseObject(body, UserDTO.class);

        return requestMetaInfo + " ---> SUCCESS! userDTO = " + userDTO;
    }
}

其中UserDTO的代碼如下：

package com.su.demo.bean.dto;

import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;

import java.util.Date;

@Data
public class UserDTO {
    /**
     * 主鍵ID
     */
    private Long id;

    /**
     * 用戶姓名
     */
    private String name;

    /**
     * 用戶狀態(tài) true：啟用；false：禁用
     */
    private Boolean enable;

    /**
     * 用戶生日
     */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private Date birth;
}

調用case

注意看上面這個/param_type/body_json/test1_request接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以POST 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

3.1.2 接口定義方式2：在方式形參的位置,用`RequestBody`接收

定義方式: 在在方式形參的位置,用RequestBody接收
兼容的請求方式：GET POST PUT DELETE
適用場景：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下一般用在POST或 PUT 請求中
優(yōu)點:
- 方法形參的定義非常簡潔;
- 調用的時候參數放在body中,參數體可以很大,不像Query入參方式在當參數過多的時候容易觸發(fā)服務器端Request header is too large的報錯
缺點:用String類型來接收參數，接收之后再轉換成bean實體，還是稍微顯得有點麻煩

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.alibaba.fastjson.JSON;
import com.su.demo.bean.dto.UserDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@RestController
@RequestMapping(value = "/param_type/body_json")
public class TestBodyController {

   /**
     * <ul>
     *     <li><b>入參類別</b>：body參數方式
     *     <li><b>定義方式</b>: 在方式形參的位置,用{@link RequestBody}接收
     *     <li><b>調用方式</b>: 參數放在請求體 body 當中
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下一般用在POST或PUT請求中</li>
     *     <li><b>優(yōu)點</b>:1)方法形參的定義非常簡潔;
     *                  2)調用的時候參數放在body中,參數體可以很大,不像Query入參方式在當參數過多的時候容易觸發(fā)服務器端"Request header is too large"的報錯
     *         </li>
     *     <li><b>缺點</b>:用String類型來接收參數,接收之后再轉換成bean實體,還是稍微顯得有點麻煩</li>
     * </ul>
     */
    @RequestMapping(value = "/test2_requestbody_string")
    public String test2(@RequestBody String body, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        System.out.println("body = " + body);
        // 用fastjson將json字符串轉換成bean
        UserDTO userDTO = JSON.parseObject(body, UserDTO.class);

        return requestMetaInfo + " ---> SUCCESS! userDTO = " + userDTO;
    }

}

調用case

注意看上面這個/param_type/body_json/test2_requestbody_string接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以PUT 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

3.1.3 接口定義方式3：用一個實例來接收RequestBody入參

定義方式: 在方式形參的位置,用RequestBody接收，而且是直接用一個實例類來接收了(spring自動調用相應的org.springframework.http.converter.HttpMessageConverter去做了入參的轉換)
兼容的請求方式：GET POST PUT DELETE
適用場景：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式，但是正常情況下一般用在POST或 PUT 請求中
優(yōu)點:
- 方法形參的定義非常簡潔;
- 調用的時候參數放在body中,參數體可以很大,不像Query入參方式在當參數過多的時候容易觸發(fā)服務器端Request header is too large的報錯
缺點:好像沒啥缺點

工作中前后端分離項目一般用這用方式比較多

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.alibaba.fastjson.JSON;
import com.su.demo.bean.dto.UserDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@RestController
@RequestMapping(value = "/param_type/body_json")
public class TestBodyController {

    /**
     * <ul>
     *     <li><b>入參類別</b>：body參數方式
     *     <li><b>定義方式</b>: 在方式形參的位置,用{@link RequestBody}接收,
     *         而且是直接用一個實例類來接收了(spring自動調用相應的{@link org.springframework.http.converter.HttpMessageConverter}去做轉換)
     *         </li>
     *     <li><b>調用方式</b>: 參數放在請求體 body 當中
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下一般用在POST或PUT請求中</li>
     *     <li><b>優(yōu)點</b>:1)方法形參的定義非常簡潔;
     *                  2)調用的時候參數放在body中,參數體可以很大,不像Query入參方式在當參數過多的時候容易觸發(fā)服務器端"Request header is too large"的報錯
     *         </li>
     *     <li><b>缺點</b>:好像沒啥缺點</li>
     * </ul>
     */
    @RequestMapping(value = "/test3_requestbody_entity")
    public String test3(@RequestBody UserDTO userDTO, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        return requestMetaInfo + " ---> SUCCESS! userDTO = " + userDTO;
    }

}

調用case

注意看上面這個/param_type/body_json/test3_requestbody_entity接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以DELETE 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

3.1.4 接口定義方式4：用Map來接收RequestBody入參

定義方式: 在方式形參的位置,用RequestBody接收，而且是直接用一個Map的實例類來接收了
兼容的請求方式：GET POST PUT DELETE
適用場景：適用于參數個數較多，但是自己又想偷懶不想專門定義一個實體來接收入參的場景。一般不推薦使用這種方式
優(yōu)點:簡單方便，偷懶很開心
缺點:1）需要在代碼中通過指定特定的key的方式去獲取入參，比較麻煩；2）利用map去get到入參之后，還需要手動的去做非空判斷+數據類型轉換等，很麻煩；3）而且這種接收入參的方式，沒有辦法結合org.springframework.validation.annotation.Validated來做入參校驗！

一般不推薦使用這種方式

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.alibaba.fastjson.JSON;
import com.su.demo.bean.dto.UserDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@RestController
@RequestMapping(value = "/param_type/body_json")
public class TestBodyController {

   /**
     * <ul>
     *     <li><b>入參類別</b>：body參數方式
     *     <li><b>定義方式</b>: 在方式形參的位置,用{@link RequestBody}接收,
     *         而且是直接用一個Map對象實例類來接收了(spring自動調用相應的{@link org.springframework.http.converter.HttpMessageConverter}去做轉換)
     *         </li>
     *     <li><b>調用方式</b>: 參數放在請求體 body 當中
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,一般使用在偷懶不想專門定義一個實體來接收入參的場景。一不太推薦使用這種方式/li>
     *     <li><b>優(yōu)點</b>:1)方法形參的定義非常簡潔;
     *                  2)調用的時候參數放在body中,參數體可以很大,不像Query入參方式在當參數過多的時候容易觸發(fā)服務器端"Request header is too large"的報錯
     *         </li>
     *     <li><b>缺點</b>:好像沒啥缺點</li>
     * </ul>
     */
    @RequestMapping(value = "/test4_requestbody_map")
    public String test4(@RequestBody Map<String, String> paramMap, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        String name = paramMap.get("name");
        // 判斷：如果paramMap.get("age")為null，則age賦默認值0；否則進行入參類型的轉換
        Integer age = null == paramMap.get("age") ? 0: Integer.parseInt(paramMap.get("age"));

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = " + age;
    }

}

調用case

注意看上面這個/param_type/body_json/test4_requestbody_map接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證），為了節(jié)約文章篇幅，下面只以POST 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

3.2 `x-www-form-urlencoded`

x-www-form-urlencoded和form-data，兩者都可以用來上傳前端表單數據，下面簡單將兩者的不同列舉出來

1.支持的入參類型不同： x-www-form-urlencoded只支持普通的文本內容，不支持上傳File文件！而form-data則支持上傳File文件(如圖片、音頻、視頻)。

2. 編碼不同： x-www-form-urlencoded的編碼方式就隱藏在名字里urlencoded，即使用js中encodeURI()函數；而form-data的格式，要比 x-www-form-urlencoded復雜的多，它會把內容分成多個部分，每個部分都支持不同的格式

3. x-www-form-urlencoded占用字節(jié)少，form-data占用字節(jié)多

x-www-form-urlencoded會將表單內的數據轉換為鍵值對，比如name=lisi&age=23，并放在請求體body中進行傳輸

3.2.1 接口定義方式1：在方法形參的位置,把每個參數都平鋪開來

定義方式: 方法形參的位置,把每個參數都平鋪開來，也可以使用@RequestParam注解
兼容的請求方式：POST PUT DELETE，注意，不兼容GET請示方式
適用場景：雖然這種傳參方式,適用于POST PUT DELETE等請求方式,但是一般偏向于應用在用POST或 PUT方式去發(fā)送的表單數據，且參數個數少，且表單字段都是普通類型(即表單字段不是File文件)
優(yōu)點:方便簡單
缺點:1)參數個數如果過多,方法體結構會顯得很臃腫

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.su.demo.bean.dto.TeacherDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.net.URLDecoder;
import java.util.Map;

@RestController
@RequestMapping(value = "/param_type/body_form_urlencoded")
public class TestFormUrlEncodeController {

    /**
     * <p>注意，如果使用GET請求方式，則后端獲取不到入參?。。?lt;/p>
     * <ul>
     *     <li><b>入參類別</b>：表單參數方式，Content-Type=application/x-www-form-urlencoded
     *     <li><b>定義方式</b>: 在方法形參的位置,把每個參數都平鋪開來</li>
     *     <li><b>調用方式</b>: 入參放在表單中，且Content-Type=application/x-www-form-urlencoded</li>
     *     <li><b>兼容的請求方式</b>：POST PUT DELETE</li>
     *     <li><b>適用場景</b>：雖然這種傳參方式,適用于POST PUT DELETE等請求方式,但是一般偏向于應用在 用<b>POST</b>或b>PUT</b>方式去發(fā)送的表單數據，且參數個數少，且表單字段都是普通類型(即表單字段不是File文件)，</li>
     *     <li><b>優(yōu)點</b>:方便簡單</li>
     *     <li><b>缺點</b>:1)參數個數如果過多,方法體結構會顯得很臃腫</li>
     * </ul>
     */
    @RequestMapping(value = "/test1_requestparam")
    public String test1(String name, @RequestParam(name = "age", required = false) Integer age, Boolean enable, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = " + age + ", enable = " + enable;
    }
}

調用case

注意看上面這個/param_type/body_form_urlencoded/test1_requestparam接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證）——經過實測發(fā)現，當請示方式為GET 的時候，后端代碼獲取不到入參！而當請求方式為POST PUT DELETE的時候，后端可以獲取到入參。
下面是示例

GET，傳參失敗

在這里插入圖片描述

可以看到，沒有獲取到入參！

POST PUT DELETE 傳參成功

為了節(jié)約文章篇幅，下面只以POST 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

3.2.2 接口定義方式2：用一個實例來接收入參

定義方式: 把入參封裝到一個實體中，且實體一定不能使用@RequestParam或@RequestBody注解修飾
兼容的請求方式：POST PUT DELETE，注意，不兼容GET請示方式
適用場景：雖然這種傳參方式,適用于POST PUT DELETE等請求方式,但是一般偏向于應用在用POST或PUT方式去發(fā)送的表單數據，且表單字段都是普通類型(即表單字段不是File文件)
優(yōu)點:方便簡單，不管表單字段個個數多或少，一般如果表單字段類型沒有File文件類型的，都可以使用這種方式
缺點:缺點的話就是針對Content-Type=application/x-www-form-urlencoded這種入參方式來說了：不能上傳文件

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.su.demo.bean.dto.TeacherDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.net.URLDecoder;
import java.util.Map;

@RestController
@RequestMapping(value = "/param_type/body_form_urlencoded")
public class TestFormUrlEncodeController {

    /**
     * <p>注意，如果使用GET請求方式，則后端獲取不到入參?。。≈恢С諴OST PUT DELETE</p>
     * <p>且形參定義那里，一定不能使用{@link RequestParam}修飾</p>
     * <ul>
     *     <li><b>入參類別</b>：表單參數方式，Content-Type=application/x-www-form-urlencoded
     *     <li><b>定義方式</b>: 把入參封裝到一個實體中(入參個數多于5個時一般用這種方式)</li>
     *     <li><b>調用方式</b>: 入參放在表單中，且Content-Type=application/x-www-form-urlencoded</li>
     *     <li><b>兼容的請求方式</b>：POST PUT DELETE</li>
     *     <li><b>適用場景</b>：雖然這種傳參方式,適用于POST PUT DELETE等請求方式,但是一般偏向于應用在 用<b>POST</b>或<b>PUT</b>方式去發(fā)送的表單數據，且表單字段都是普通類型(即表單字段不是File文件)，</li>
     *     <li><b>優(yōu)點</b>:方便簡單，不管表單字段個個數多或少，一般如果表單字段類型沒有File文件類型的，都可以使用這種方式</li>
     *     <li><b>缺點</b>:缺點的話就是針對Content-Type=application/x-www-form-urlencoded這種入參方式來說了：不能上傳文件</li>
     * </ul>
     */
    @RequestMapping(value = "/test2_entity")
    public String test2(TeacherDTO teacherDTO, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        return requestMetaInfo + " ---> SUCCESS! teacherDTO = " + teacherDTO;
    }

}

調用case

注意看上面這個/param_type/body_form_urlencoded/test2_entity接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證）——經過實測發(fā)現，當請示方式為GET 的時候，后端代碼獲取不到入參！而當請求方式為POST PUT DELETE的時候，后端可以獲取到入參。
下面是示例

GET，傳參失敗

在這里插入圖片描述

可以看到，沒有獲取到入參！

POST PUT DELETE 傳參成功

為了節(jié)約文章篇幅，下面只以PUT 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，參數都獲取到了。

3.2.3 接口定義方式3：用原生的HttpServletRequest接收參數

定義方式: 用原生的HttpServletRequest接收參數
兼容的請求方式：POST PUT DELETE，注意，不兼容GET請示方式
適用場景：由于當請求的Content-Type=application/x-www-form-urlencoded時，只支持GET請求方式，并且即使是GET請求方式能獲取到入參了，之后的校驗和處理也很麻煩，所以一般不用這種方式來接收Content-Type=application/x-www-form-urlencoded的請求
優(yōu)點:方便簡單，且這接收入參的方式，直接調用方用GET的請求方式傳參
缺點:
- 1）需要自己在代碼中顯式的從request的inputStream流【獲取+轉換+解碼】數據，很麻煩
- 2）如果請求方式是POST PUT DELETE等，同時Content-Type=application/x-www-form-urlencoded，則無法將入參傳到后面代碼中！

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.su.demo.bean.dto.TeacherDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.net.URLDecoder;
import java.util.Map;

@RestController
@RequestMapping(value = "/param_type/body_form_urlencoded")
public class TestFormUrlEncodeController {

    /**
     * <p>注意，只支持GET請求方式，如果使用POST、PUT、DELETE請求方式，則后端獲取不到入參?。?！</p>
     * <ul>
     *     <li><b>入參類別</b>：表單參數方式，Content-Type=application/x-www-form-urlencoded
     *     <li><b>定義方式</b>: 在方法形參的位置，用{@link HttpServletRequest}來接收入參</li>
     *     <li><b>調用方式</b>: 入參放在表單中，且Content-Type=application/x-www-form-urlencoded</li>
     *     <li><b>兼容的請求方式</b>：GET</li>
     *     <li><b>適用場景</b>：由于當請求的Content-Type=application/x-www-form-urlencoded時，只支持GET請求方式，
     *     并且即使是GET請求方式能獲取到入參了，之后的校驗和處理也很麻煩，所以一般不用這種方式來接收Content-Type=application/x-www-form-urlencoded的請求</li>
     *     <li><b>優(yōu)點</b>:方便簡單，且這接收入參的方式，直接調用方用GET的請求方式傳參</li>
     *     <li><b>缺點</b>:1）需要自己在代碼中顯式的從request的inputStream流【獲取+轉換+解碼】數據，很麻煩
     *                    2）如果請求方式是POST PUT DELETE等，同時Content-Type=application/x-www-form-urlencoded，則無法將入參傳到后面代碼中！
     *      </li>
     * </ul>
     */
    @RequestMapping(value = "/test3_request")
    public String test3(HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        ServletInputStream inputStream = request.getInputStream();
        String inputStr = IoUtil.read(inputStream, "UTF-8");
        String decodeRes = URLDecoder.decode(inputStr, "UTF-8");

        return requestMetaInfo + " ---> SUCCESS! " + inputStr + ", decodeResult = " + decodeRes;
    }

}

調用case

注意看上面這個/param_type/body_form_urlencoded/test3_request接口的定義方式，它并沒有指定請求方式，因此它支持GET POST PUT DELETE等所有的請求方式（已經過驗證）——但是經過實測發(fā)現，只有當請示方式為GET 的時候，后端代碼才能獲取到入參！而當請求方式為POST PUT DELETE的時候，后端獲取入參失敗。
下面是示例

GET，傳參成功

在這里插入圖片描述

可以看到，獲取到入參！

POST PUT DELETE 傳參失敗

為了節(jié)約文章篇幅，下面只以POST 請求方式的調用結果為例，看是否可以在controller代碼中獲取到調用方傳過來的實參。

在這里插入圖片描述

可以看到，沒有獲取到參數！

3.2.4 (error)接口定義方式4：用Map接收參數

提前說明：這是一種錯誤的定義方式，這種方式，無論是否在map前面添加RequestParam還是RequestBody, 后端代碼都獲取不到 Content-Type=application/x-www-form-urlencoded類型請求的入參?。?！

定義方式: 用Map接收參數

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.su.demo.bean.dto.TeacherDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.net.URLDecoder;
import java.util.Map;

@RestController
@RequestMapping(value = "/param_type/body_form_urlencoded")
public class TestFormUrlEncodeController {

    /**
     * <p>這是一種錯誤的定義方式，這種方式，無論是否在map前面添加{@link RequestParam}還是{@link RequestBody}, 代碼都獲取不到 Content-Type=application/x-www-form-urlencoded類型請求的入參！?。?lt;/p>
     * <ul>
     *     <li><b>入參類別</b>：表單參數方式，Content-Type=application/x-www-form-urlencoded
     *     <li><b>定義方式</b>: 在方法形參的位置，用Map來接收入參</li>
     *     <li><b>調用方式</b>: 入參放在表單中，且Content-Type=application/x-www-form-urlencoded</li>
     * </ul>
     */
    @RequestMapping(value = "/test4_map")
    public String test4(Map<String, String> paramMap, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));

        String name = paramMap.get("name");
        // 判斷：如果paramMap.get("age")為null，則age賦默認值0；否則進行入參類型的轉換
        Integer age = null == paramMap.get("age") ? 0: Integer.parseInt(paramMap.get("age"));

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = " + age;
    }

}

調用case

無論哪種請求方式，后端獲取入參都失??！下面以PUT請求方式作為示例
下面是示例

PUT，傳參失敗

在這里插入圖片描述

可以看到，獲取不到入參！

3.2.5 (error)接口定義方式5：每個參數都平鋪開來,并嘗試獲取File文件入參

先說結論，雖然在下面方法定義的，=形參中添加了MultipartFile，但是如果調用接口的時候入參類型是Content-Type=application/x-www-form-urlencoded，那由于Content-Type=application/x-www-form-urlencoded入參類型限制了入參就無法將【文件】傳過來，所以該方法的MultipartFile對象始終為空！

定義方式: 方法形參的位置,把每個參數都平鋪開來，也可以使用@RequestParam注解，是時嘗試使用MultipartFile類型入參，去接收文件

代碼

package com.su.demo.controller.param_type;

import cn.hutool.core.io.IoUtil;
import com.su.demo.bean.dto.TeacherDTO;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.net.URLDecoder;
import java.util.Map;

@RestController
@RequestMapping(value = "/param_type/body_form_urlencoded")
public class TestFormUrlEncodeController {

    /**
     * <p>
     *     雖然在方法定義這里，形參中添加了MultipartFile，但是如果調用接口的時候入參類型是Content-Type=application/x-www-form-urlencoded，
     *     那由于Content-Type=application/x-www-form-urlencoded入參類型限制了入參就無法將【文件】傳過來，所以該方法的MultipartFile對象始終為空！
     * </p>
     * <ul>
     *     <li><b>入參類別</b>：表單參數方式，Content-Type=application/x-www-form-urlencoded
     *     <li><b>定義方式</b>: 在方法形參的位置,把每個參數都平鋪開來</li>
     *     <li><b>調用方式</b>: 入參放在表單中，且Content-Type=application/x-www-form-urlencoded</li>
     * </ul>
     */
    @RequestMapping(value = "/test5_requestparam_file")
    public String test5(String name, Integer age, Boolean enable, MultipartFile myfile, HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數據信息，包括請求方式，Content-type等
        String requestMetaInfo = String.format("method: [%s], uri: [%s], Content-Type: [%s] ", request.getMethod(), request.getRequestURI(),  request.getHeader("Content-Type"));
        String fileName = null;
        if (null != myfile) {
            fileName = myfile.getOriginalFilename();
        }

        return requestMetaInfo + " ---> SUCCESS! name = " + name + ", age = " + age + ", enable = " + enable + ", fileName = " + fileName;
    }

}

調用case

實測發(fā)現，不管是哪種請求方式，只要請求的時候Content-Type=application/x-www-form-urlencoded，那都無法將文件傳給后端！
下面是用POST請求方式作示例：

在這里插入圖片描述

以上就是SpringBoot接收接口入參的方式小結的詳細內容，更多關于SpringBoot接收接口入參的資料請關注腳本之家其它相關文章！

您可能感興趣的文章:

利用Java實現word導入導出富文本(含圖片)的詳細代碼
這篇文章主要為大家詳細介紹了利用Java實現word導入導出富文本(含圖片),文中的示例代碼講解詳細,對大家的學習或工作有一定的幫助,感興趣的小伙伴可以學習一下
2024-02-02
Java微服務分布式調度Elastic-job環(huán)境搭建及配置
Elastic-Job在配置中提供了JobEventConfiguration，支持數據庫方式配置，會在數據庫中自動創(chuàng)建JOB_EXECUTION_LOG和JOB_STATUS_TRACE_LOG兩張表以及若干索引，來記錄作業(yè)的相關信息
2023-02-02
obix協(xié)議在java中的配置和使用詳解
這篇文章主要給大家介紹了關于obix協(xié)議在java中的配置和使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧。
2017-08-08
Spring引入外部屬性文件配置數據庫連接的步驟詳解
這篇文章主要介紹了Spring引入外部屬性文件配置數據庫連接的步驟詳解,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2021-01-01
JavaScript中HTML元素操作的實現
本文主要介紹了JavaScript中HTML元素操作的實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2023-06-06
spring boot 1.5.4 集成shiro+cas,實現單點登錄和權限控制
這篇文章主要介紹了spring boot 1.5.4 集成shiro+cas，實現單點登錄和權限控制,需要的朋友可以參考下
2017-06-06
java:無法訪問org.springframework.boot.SpringApplication的解決方法
這篇文章主要給大家介紹了關于java:無法訪問org.springframework.boot.SpringApplication的解決方法,文中通過實例代碼將解決的辦法介紹的非常詳細,需要的朋友可以參考下
2023-01-01
Springboot使用@RefreshScope注解實現配置文件的動態(tài)加載
本文主要介紹了Springboot使用@RefreshScope注解實現配置文件的動態(tài)加載，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-09-09
基于Protobuf動態(tài)解析在Java中的應用包含例子程序
下面小編就為大家?guī)硪黄赑rotobuf動態(tài)解析在Java中的應用包含例子程序。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2017-07-07
java從字符串中提取數字的簡單實例
下面小編就為大家?guī)硪黄猨ava從字符串中提取數字的簡單實例。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2016-10-10

国产无遮挡裸体免费直播视频,久久精品国产蜜臀av,动漫在线视频一区二区,欧亚日韩一区二区三区,久艹在线 免费视频,国产精品美女网站免费,正在播放 97超级视频在线观看,斗破苍穹年番在线观看免费,51最新乱码中文字幕

SpringBoot接收接口入參的方式小結

目錄

引言

重要說明

項目的pom依賴

1.Query參數

1.1接口定義方式1：在方法形參的位置,把每個參數都平鋪開來

代碼

調用case

1.2接口定義方式2：在方法形參的位置,結合@RequestParam把每個參數都平鋪開來

代碼

調用case

1.3接口定義方式3：把入參封裝到一個實體中

代碼

調用case

1.4接口定義方式4：用原生的HttpServletRequest接收參數

代碼

調用case

1.5接口定義方式5：用Map結合RequestParam接收參數

代碼

調用case

2.Path參數

2.1接口定義方式：用占位符的方式把入參封裝到請求路徑中

代碼

調用case

3.Body參數

3.1 application/json

3.1.1 接口定義方式1：在方式形參的位置,用原生的HttpServletRequest接收

3.1.2 接口定義方式2：在方式形參的位置,用RequestBody接收

3.1.3 接口定義方式3：用一個實例來接收RequestBody入參

3.1.4 接口定義方式4：用Map來接收RequestBody入參

3.2 x-www-form-urlencoded

3.2.1 接口定義方式1：在方法形參的位置,把每個參數都平鋪開來

3.2.2 接口定義方式2：用一個實例來接收入參

3.2.3 接口定義方式3：用原生的HttpServletRequest接收參數

3.2.4 (error)接口定義方式4：用Map接收參數

3.2.5 (error)接口定義方式5：每個參數都平鋪開來,并嘗試獲取File文件入參

相關文章

最新評論

大家感興趣的內容

最近更新的內容

常用在線小工具

国产无遮挡裸体免费直播视频,久久精品国产蜜臀av,动漫在线视频一区二区,欧亚日韩一区二区三区,久艹在线免费视频,国产精品美女网站免费,正在播放 97超级视频在线观看,斗破苍穹年番在线观看免费,51最新乱码中文字幕

3.1 `application/json`

3.1.1 接口定義方式1：在方式形參的位置,用原生的`HttpServletRequest`接收

3.1.2 接口定義方式2：在方式形參的位置,用`RequestBody`接收

3.2 `x-www-form-urlencoded`