<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>

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

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

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>入?yún)㈩悇e</b>：Query參數(shù)
     *     <li><b>定義方式</b>: 在方法形參的位置,把每個參數(shù)都平鋪開來</li>
     *     <li><b>調(diào)用方式</b>: 入?yún)⑵唇釉诮涌诘膗ri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：雖然這種傳參方式,適用于GET POST PUT DELETE等請求方式,但是一般偏向于應(yīng)用在 入?yún)€數(shù)少(一般少于5個)的<b>GET</b>請求方式中</li>
     *     <li><b>優(yōu)點</b>:方便簡單</li>
     *     <li><b>缺點</b>:1) 入?yún)⒅苯语@示在uri中，不太安全 2）參數(shù)個數(shù)如果過多,方法體結(jié)構(gòu)會顯得很臃腫; 3）沒有入?yún)⑿ｒ?lt;/li>
     * </ul>
     * <p><b>注意</b>:根據(jù)自己的需求決定是否在形參中加上HttpServletRequest,我這里是為了從request中獲取method,所以加上了</p>
     */
    @RequestMapping(value = "/test1")
    public String test1(String name, Integer age, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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;
    }

}

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>入?yún)㈩悇e</b>：Query參數(shù)
     *     <li><b>定義方式</b>: 在方法形參的位置,把每個參數(shù)都平鋪開來.并且相較于前一種定義方式,這種方式使用 {@link RequestParam}綁定請求參數(shù)到方法形參， 且需要注意該注解中的各個屬性的作用！</li>
     *     <li><b>調(diào)用方式</b>: 入?yún)⑵唇釉诮涌诘膗ri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：雖然這種傳參方式,適用于GET POST PUT DELETE等請求方式,但是一般偏向于應(yīng)用在 入?yún)€數(shù)少(一般少于5個)的<b>GET</b>請求方式中</li>
     *     <li><b>優(yōu)點</b>:方便簡單;且結(jié)合{@link RequestParam},可實現(xiàn)入?yún)⒌谋靥钚ｒ?重命名/默認(rèn)值等簡單的功能</li>
     *     <li><b>缺點</b>:1) 入?yún)⒅苯语@示在uri中，不太安全
     *                    2）參數(shù)個數(shù)如果過多,方法體結(jié)構(gòu)會顯得很臃腫(當(dāng)前這個方法有4個入?yún)?其實就已經(jīng)有點臃腫了)
     *                    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中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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;
    }

}

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>入?yún)㈩悇e</b>：Query參數(shù)
     *     <li><b>定義方式</b>: 把入?yún)⒎庋b到一個實體中(入?yún)€數(shù)多于5個時一般用這種方式)
     *     <li><b>調(diào)用方式</b>: 入?yún)⑵唇釉诮涌诘膗ri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術(shù)上來說這種傳參方式,同時適用于GET POST PUT DELETE等多種請求方式,但是一般我個從偏向于在入?yún)€數(shù)大于5個的<b>GET</b>請求方式中使用</li>
     *     <li><b>優(yōu)點</b>:因為參數(shù)都封裝在實體bean當(dāng)中了,所以對參數(shù)的個數(shù)就沒有什么的限制了,接口定義的時候方便多了
     *     <li><b>缺點</b>:對于這種入?yún)⒌腫定義方式]來說,它是沒有什么缺點的.硬要說缺點的話,其實是針對Query這種傳參方式來說的,即當(dāng)參數(shù)個數(shù)一多的時候,參數(shù)都放在請求uri中容易造成uri的長度過過長
     *     (雖然http協(xié)議中未明確對url進行長度限制，但在真正實現(xiàn)中，url的長度還是受到限制的，一是服務(wù)器端的限制，二就是游覽器端的限制)</li>
     * </ul>
     */
    @RequestMapping(value = "/test3_entity")
    public String test3(UserDTO userDTO, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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;
    }

}

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;
}

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>入?yún)㈩悇e</b>：Query參數(shù)
     *     <li><b>定義方式</b>: 在方式形參的位置,用原生的{@link HttpServletRequest}接收
     *     <li><b>調(diào)用方式</b>: 入?yún)⑵唇釉诮涌诘膗ri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術(shù)上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下比較少用這種方式來獲取參數(shù)了</li>
     *     <li><b>優(yōu)點</b>:{@link HttpServletRequest}是整個請求，可以獲取到所有的數(shù)據(jù).且HttpServletRequest、HttpServletResponse都是內(nèi)置對象，可以使用</li>
     *     <li><b>缺點</b>:代碼中再去從request中拿到參數(shù),比較麻煩</li>
     * </ul>
     * <p> 注意,這種方式其實也可以獲取body請求體里面的數(shù)據(jù),參考https://blog.csdn.net/qq_24850045/article/details/121927722
     */
    @RequestMapping(value = "/test4_request")
    public String test4(HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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")); // 需要進行類型轉(zhuǎn)換

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

}

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>入?yún)㈩悇e</b>：Query參數(shù)
     *     <li><b>定義方式</b>: 在方式形參的位置,結(jié)合{@link RequestParam}用Map接收
     *     <li><b>調(diào)用方式</b>: 入?yún)⑵唇釉诮涌诘膗ri后面,如 /test_get/requestparam_1?name=wangwu&age=18</li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：適用于參數(shù)個數(shù)較多，但是自己又想偷懶不想專門定義一個實體來接收入?yún)⒌膱鼍?。一般不推薦使用這種方式。</li>
     *     <li><b>優(yōu)點</b>:簡單方便</li>
     *     <li><b>缺點</b>:需要在代碼中通過指定特定的key的方式去獲取入?yún)ⅲ容^麻煩；而且這種接收入?yún)⒌姆绞?，沒有辦法結(jié)合{@link org.springframework.validation.annotation.Validated}來做入?yún)⑿ｒ?lt;/li>
     * </ul>
     */
    @RequestMapping(value = "/test5_map")
    public String test5(@RequestParam Map<String, String> paramMap, HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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賦默認(rèn)值0；否則進行入?yún)㈩愋偷霓D(zhuǎn)換
        Integer age = null == paramMap.get("age") ? 0: Integer.parseInt(paramMap.get("age"));

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

}

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>入?yún)㈩悇e</b>：PathVariable路徑參數(shù)方式
     *     <li><b>定義方式</b>: 用占位符的方式把入?yún)⒎庋b到請求路徑中,然后再通過@PathVariable注解可以將URL中的占位符參數(shù)綁定到控制器（controller）處理方法的形參中. </li>
     *     <li><b>調(diào)用方式</b>: REST風(fēng)格路徑參數(shù),入?yún)⑵唇釉诮涌诘腢RI里面,如/test_pathvar/test1/zhangsan/1 </li>
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術(shù)上來說,這種傳參方式同時適用于GET POST PUT DELETE等多種請求方式.
     *         但是一般入?yún)€數(shù)小于5個,且你開發(fā)的是REST風(fēng)格的接口,那可以考慮用這種方式
     *         </li>
     * </ul>
     * <p>REST(英文：Representational State Transfer，簡稱REST，意思：表述性狀態(tài)轉(zhuǎn)換，描述了一個架構(gòu)樣式的網(wǎng)絡(luò)系統(tǒng)，比如web應(yīng)用)，是一種軟件架構(gòu)風(fēng)格不是標(biāo)準(zhǔn)哦！
     * 只是提供了一組設(shè)計原則和約束條件。它主要用于客戶端和服務(wù)器交互類的軟件?；谶@個風(fēng)格設(shè)計的軟件可以更簡潔，更有層次，更易于實現(xiàn)緩存等機制。
     * REST 指的是一組架構(gòu)（約束條件）和原則。滿足這些（約束條件）和（原則）的應(yīng)用程序或設(shè)計就是 Restful。</p>
     */
    @RequestMapping(value = "/test1/{name}/{age}")
    public String test1(@PathVariable("name") String name, @PathVariable("age") Integer myage, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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;
    }
}

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>入?yún)㈩悇e</b>：body參數(shù)方式
     *     <li><b>定義方式</b>: 在方式形參的位置,用原生的{@link HttpServletRequest}接收
     *     <li><b>調(diào)用方式</b>: 參數(shù)放在請求體 body 當(dāng)中
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術(shù)上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下比較少用這種方式來獲取body參數(shù)了</li>
     *     <li><b>優(yōu)點</b>:{@link HttpServletRequest}是整個請求，可以獲取到所有的數(shù)據(jù).且HttpServletRequest、HttpServletResponse都是內(nèi)置對象，可以使用</li>
     *     <li><b>缺點</b>:代碼中再去從request中拿到參數(shù),老麻煩,可以看下面的代碼</li>
     * </ul>
     * <p> 注意,這種方式其實也可以獲取body請求體里面的數(shù)據(jù),參考https://blog.csdn.net/qq_24850045/article/details/121927722
     */
    @RequestMapping(value = "/test1_request")
    public String test1(HttpServletRequest request) throws IOException {
        // 從request中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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字符串轉(zhuǎn)換成bean
        UserDTO userDTO = JSON.parseObject(body, UserDTO.class);

        return requestMetaInfo + " ---> SUCCESS! 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;
}

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>入?yún)㈩悇e</b>：body參數(shù)方式
     *     <li><b>定義方式</b>: 在方式形參的位置,用{@link RequestBody}接收
     *     <li><b>調(diào)用方式</b>: 參數(shù)放在請求體 body 當(dāng)中
     *     <li><b>兼容的請求方式</b>：GET POST PUT DELETE</li>
     *     <li><b>適用場景</b>：從技術(shù)上來說,這種傳參方式同時適用于GET POST PUT DELETE等請求方式,但是正常情況下一般用在POST或PUT請求中</li>
     *     <li><b>優(yōu)點</b>:1)方法形參的定義非常簡潔;
     *                  2)調(diào)用的時候參數(shù)放在body中,參數(shù)體可以很大,不像Query入?yún)⒎绞皆诋?dāng)參數(shù)過多的時候容易觸發(fā)服務(wù)器端"Request header is too large"的報錯
     *         </li>
     *     <li><b>缺點</b>:用String類型來接收參數(shù),接收之后再轉(zhuǎn)換成bean實體,還是稍微顯得有點麻煩</li>
     * </ul>
     */
    @RequestMapping(value = "/test2_requestbody_string")
    public String test2(@RequestBody String body, HttpServletRequest request) {
        // 從request中獲取一些接口請求時的元數(shù)據(jù)信息，包括請求方式，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字符串轉(zhuǎn)換成bean
        UserDTO userDTO = JSON.parseObject(body, UserDTO.class);

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

}