快捷導(dǎo)航

Java中的6種請(qǐng)求方式的示例詳解

更新時(shí)間：2024年07月19日 09:23:36 作者：碼農(nóng)研究僧

這篇文章主要詳細(xì)介紹了Java中的6種請(qǐng)求方式,@RequestParam、@PathVariable、@MatrixVariable、@RequestBody、@RequestHeader和@CookieValue的基本知識(shí)、詳細(xì)分析以及示例,需要的朋友可以參考下

1. @RequestParam

用于綁定HTTP請(qǐng)求參數(shù)到控制器方法的參數(shù)上，常用于處理表單數(shù)據(jù)或查詢參數(shù)

@GetMapping("/greeting")
public String greeting(@RequestParam(name="name", required=false, defaultValue="World") String name) {
    return "Hello, " + name;
}

基本的屬性如下：

value 或 name: 參數(shù)名
required: 是否為必需參數(shù)，默認(rèn)為true
defaultValue: 參數(shù)的默認(rèn)值

具體調(diào)用兩種方式：

/greeting?name=John，輸出Hello, John
/greeting，輸出默認(rèn)值 Hello, World

2. @PathVariable

用于綁定URL中的模板變量到控制器方法的參數(shù)上，常用于RESTful風(fēng)格的URL路徑中

@GetMapping("/users/{id}")
public User getUser(@PathVariable("id") Long id) {
    return userService.findById(id);
}

基本的屬性如下：

value 或 name: 路徑變量名。
required: 是否為必需參數(shù)，默認(rèn)為true

請(qǐng)求方式： /users/1，用戶ID為1的用戶對(duì)象

3. @MatrixVariable

用于綁定URL路徑中的矩陣變量到控制器方法的參數(shù)上，需要在Spring MVC中啟用矩陣變量支持
常與路徑變量結(jié)合使用

@GetMapping("/owners/{ownerId}/pets/{petId}")
public Pet findPet(@PathVariable String ownerId, 
                   @MatrixVariable(name="q", pathVar="petId") int query) {
    // 處理代碼
}

基本的屬性如下：

value 或 name: 矩陣變量名
pathVar: 矩陣變量所屬的路徑變量名

具體調(diào)用方式如下：
/owners/42/pets/21;q=123，提取: ownerId 為42, petId 為21, q 為123

4. @RequestBody

用于將HTTP請(qǐng)求體的內(nèi)容綁定到控制器方法的參數(shù)上，常用于處理JSON、XML等格式的請(qǐng)求數(shù)據(jù)

@PostMapping("/users")
public User createUser(@RequestBody User user) {
    return userService.save(user);
}

required: 是否為必需參數(shù)，默認(rèn)為true

具體調(diào)用方式如下：

HTTP POST請(qǐng)求，內(nèi)容: {“name”: “John”, “age”: 30}
返回: 創(chuàng)建的用戶對(duì)象

5. @RequestHeader

用于綁定HTTP請(qǐng)求頭到控制器方法的參數(shù)上

@GetMapping("/header")
public String getHeader(@RequestHeader("User-Agent") String userAgent) {
    return "User-Agent: " + userAgent;
}

value 或 name: 請(qǐng)求頭名
required: 是否為必需參數(shù)，默認(rèn)為true
defaultValue: 參數(shù)的默認(rèn)值

具體調(diào)用方式如下：

設(shè)置請(qǐng)求頭User-Agent
返回: 用戶代理信息

6. @CookieValue

用于綁定HTTP請(qǐng)求的Cookie值到控制器方法的參數(shù)上

@GetMapping("/cookie")
public String getCookie(@CookieValue(value = "sessionId", defaultValue = "defaultSessionId") String sessionId) {
    return "Session ID: " + sessionId;
}

具體的屬性如下：

value 或 name: Cookie名
required: 是否為必需參數(shù)，默認(rèn)為true
defaultValue: 參數(shù)的默認(rèn)值

具體調(diào)用方式如下：

設(shè)置Cookie sessionId
返回: 會(huì)話ID信息

7. 總結(jié)

注解	作用	屬性	示例調(diào)用
@RequestParam	綁定HTTP請(qǐng)求參數(shù)到控制器方法的參數(shù)上	value, required, defaultValue	/greeting?name=John
@PathVariable	綁定URL中的模板變量到控制器方法的參數(shù)上	value, required	/users/1
@MatrixVariable	綁定URL路徑中的矩陣變量到控制器方法的參數(shù)上	value, pathVar	/owners/42/pets/21;q=123
@RequestBody	將HTTP請(qǐng)求體的內(nèi)容綁定到控制器方法的參數(shù)上	required	HTTP POST 請(qǐng)求，內(nèi)容: {“name”: “John”}
@RequestHeader	綁定HTTP請(qǐng)求頭到控制器方法的參數(shù)上	value, required, defaultValue	設(shè)置請(qǐng)求頭User-Agent
@CookieValue	綁定HTTP請(qǐng)求的Cookie值到控制器方法的參數(shù)上	value, required, defaultValue	設(shè)置Cookie sessionId