快捷導(dǎo)航

SpringBoot項目中rest接口定義與參數(shù)傳遞和接收方式

更新時間：2026年04月02日 09:04:44 作者：撞撞～

本文介紹了使用RestClient測試接口的兩種方式：form-data和content-type,form-data適用于所有請求方式,但URL長度有限制,content-type只適用于POST/DELETE/PUT請求,處理application/json格式參數(shù),對于參數(shù)較多的情況,建議使用JavaBean接收

方式一：form-data形式

參數(shù)以key-value形式傳遞，參數(shù)和值會直接拼接到請求url后邊顯示存在（POST http://localhost:8080/users/insert?id=5&userName=劉明）；

適用于所有請求方式；

后臺接收參數(shù)時使用注解@RequestParam

POST

提交資源時一般post請求方式，當(dāng)然所有的增刪改也可已使用post請求

使用@RequestParam(value = “key”) 綁定請求參數(shù)到方法入?yún)r,參數(shù)名可以不與前臺key一致

@RestController
@RequestMapping("/users")
public class UsersController {
    @PostMapping("/insert")
    public RestResult insertUserInfo(@RequestParam("userId") int id, String userName, String passWord, int age,String sex, String phone) {...}
}

請求參數(shù)可以這樣顯示接收，也可以從 request 中獲取

insertUserInfo(HttpServletRequest request) {
        String userId = request.getParameter("userId");
        String phone = request.getParameter("phone");
		...
}

如果請求參數(shù)為定義的對象屬性時，可以直接使用對象接收參數(shù)

public class User {
    private int id;
    private String userName;
    private String passWord;
    private int age;
    private String sex;
    private String phone;
}

@PostMapping("/insert")
    public RestResult insertUserInfo(User user) {...}

DELETE

刪除資源

使用@PathVariable 獲取url路徑中的參數(shù)

@DeleteMapping("/delete/{id}")
public RestResult deleteUser(@PathVariable("id") int userId) {...}

PUT

更新資源

@PutMapping("/update/{id}")
public RestResult updateUser(@PathVariable int id, String phone) ｛...｝

GET

獲取資源

@GetMapping("/query/{id}")
    public RestResult queryUser(@PathVariable int id) {...}

方式二、content-type形式

因為GET請求頭中無content-type字段，所以此種方式只適用于POST/DELETE/PUT請求，用來處理：applicatin/json格式的參數(shù)

參數(shù)以json形式傳遞，后臺獲取參數(shù)時使用注解@RequestBody

@PostMapping("/insert")
    public RestResult insertUserInfo(@RequestBody User user) {...}

我們也可以使用@JsonProperty 注解來綁定Json中的key和Bean實體的屬性

這時候，前臺在傳遞參數(shù)時，可以使用與屬性名一致，也可以與注解中的value一致

但是這里得注意：這里返回給前臺的json對象中的key將會是直接中的值

public class User {
    private Integer id;
    @JsonProperty("name")
    private String userName;
    @JsonProperty("pass")
    private String passWord;
    private Integer age;
    private String sex;
    private String phone;
}