SpringBoot中@PathVariable、@RequestParam和@RequestBody的區(qū)別和使用詳解
一、@PathVariable
1.1 restful風格
1.1.1 概念
一種軟件架構風格、設計風格,而不是標準,只是提供了一組設計原則和約束條件。它主要用于客戶端和服務器交互類的軟件?;谶@個風格設計的軟件可以更簡潔,更有層次,更易于實現緩存等機制。
1.1.2 特點
- REST:即 Representational State Transfer。(資源)表現層狀態(tài)轉化。是目前最流行的一種互聯網軟件架構。它結構清晰、符合標準、易于理解、擴展方便,所以正得到越來越多網站的采用
- 資源(Resources):網絡上的一個實體,或者說是網絡上的一個具體信息。它可以是一段文本、一張圖片、一首歌曲、一種服務,總之就是一個具體的存在??梢杂靡粋€URI(統(tǒng)一資源定位符)指向它,每種資源對應一個特定的 URI 。要獲取這個資源,訪問它的URI就可以,因此 URI 即為每一個資源的獨一無二的識別符。
- 表現層(Representation):把資源具體呈現出來的形式,叫做它的表現層(Representation)。比如,文本可以用 txt 格式表現,也可以用 HTML 格式、XML 格式、JSON 格式表現,甚至可以采用二進制格式。
- 狀態(tài)轉化(State Transfer):每發(fā)出一個請求,就代表了客戶端和服務器的一次交互過程。HTTP協議,是一個無狀態(tài)協議,即所有的狀態(tài)都保存在服務器端。因此,如果客戶端想要操作服務器,必須通過某種手段,讓服務器端發(fā)生**“狀態(tài)轉化”**(State Transfer)。而這種轉化是建立在表現層之上的,所以就是 “表現層狀態(tài)轉化”。具體說,就是 HTTP 協議里面,四個表示操作方式的動詞:GET、POST、PUT、DELETE。它們分別對應四種基本操作:GET 用來獲取資源,POST 用來新建資源,PUT 用來更新資源,DELETE 用來刪除資源。
1.1.3 restful風格和傳統(tǒng)操作方式的對比
| 功能 | 傳統(tǒng)方式 | restful風格 |
| 查詢 | http://127.0.0.1/item/selectUser?id=1 | GET http://127.0.0.1/item/selectUser/1 |
| 新增 | http://127.0.0.1/item/addUser | POST http://127.0.0.1/item/addUser |
| 更新 | http://127.0.0.1/item/updateUser | PUT http://127.0.0.1/item/updateUser |
| 刪除 | http://127.0.0.1/item/deleteUser?id=1 | DELETE http://127.0.0.1/item/deleteUser/1 |
1.2 @PathVariable的介紹
@PathVariable 映射 URL 綁定的占位符
- 帶占位符的 URL 是 Spring3.0 新增的功能,該功能在SpringMVC 向 REST 目標挺進發(fā)展過程中具有里程碑的意義
- 通過 @PathVariable 可以將 URL 中占位符參數綁定到控制器(controller)處理方法的形參中:URL 中的 {xxx} 占位符可以通過@PathVariable(“xxx“) 綁定到操作方法的形參中。
- 主要是根據請求方法進行類的區(qū)別
1.3 @PathVariable所具有的參數
- String value:可指定占位符 { } 中的參數名,若只指定value這一個屬性可省略屬性名不寫,若占位符中的參數名和處理方法中的參數名相同可省略此屬性。
- String name:等價與value,和value無本質上的差異,兩個屬性指定其一即可。
- boolean required:是否必需,默認為 true,即 請求中必須包含該參數,如果沒有包含,將會拋出異常(可選配置)
1.4 @PathVariable的使用
步驟:
- 通過@RequestMapping注解中的 { } 占位符來標識URL中的變量部分
- 在控制器中的處理方法的形參中使用@PathVariable注解去獲取@RequestMapping中 { } 中傳進來的值,并綁定到處理方法定一的形參上。
//請求路徑:http://127.0.0.1/user/tom
@RequestMapping(value="/user/{name}")
public String username(@PathVariable(value="name") String username) {
return username;
}
二、@RequestParam
2.1 @RequestParam定義
@RequestParam (org.springframework.web.bind.annotation.RequestParam)用于將指定的請求參數賦值給方法中的形參。
2.2 @RequestParam的參數
- String value:請求中傳入參數的名稱,如果不設置value值,則會默認為該變量名。
- String name:等價與value,和value無本質上的差異,兩個屬性指定其一即可。
- boolean required:是否必需,默認為 true,即 請求中必須包含該參數,如果沒有包含,將會拋出異常(可選配置)
- String defaultValue:參數的默認值,如果請求中沒有同名的參數時,該變量默認為此值。
2.3 注意事項
- 如果參數前寫了@RequestParam(xxx),那么前端必須有對應的xxx名字才行(不管其是否有值,當然可以通 過設置該注解的required屬性來調節(jié)是否必須傳),如果沒有xxx名的話,那么請求會出錯,報400。
- 如果參數前不寫@RequestParam(xxx)的話,那么就前端可以有可以沒有對應的xxx名字才行,如果有xxx名的話,那么就會自動匹配;沒有的話,請求也能正確發(fā)送。
2.4 @RequestParam使用
在SpringMVC框架中,可以通過定義@RequestMapping來處理URL請求。和@PathVariable一樣,需要在處理URL的控制方法中獲取URL中的參數,也就是?key1=value1&key2=value2這樣的參數列表。通過注解@RequestParam可以輕松地將URL中的參數綁定到處理函數方法的變量中。
//請求路徑:http://127.0.0.1/user/?name=tom
@RequestMapping(value="/user")
public String getUserBlog(@RequestParam(value="name") String username) {
return name;
}
三、@RequestBody
3.1 @RequestBody簡介
@RequestBody主要用來接收前端傳遞給后端的json字符串中的數據的(請求體中的數據的);GET方式無請求體,所以使用@RequestBody接收數據時,前端不能使用GET方式提交數據,而是用POST等方式進行提交。
3.2 注意事項
如果后端參數是一個對象,且該參數前是以@RequestBody修飾的,那么前端傳遞json參數時,必須滿足以下要求:
- 后端@RequestBody注解對應的類在將HTTP的輸入流(含請求體)裝配到目標類(即:@RequestBody后面的類)時,會根據json字符串中的key來匹配對應實體類的屬性,如果匹配一致且json中的該key對應的值符合(或可轉換為), 實體類的對應屬性的類型要求時,會調用實體類的setter方法將值賦給該屬性。
- json字符串中,如果value為""的話,后端對應屬性如果是String類型的,那么接受到的就是"",如果是后端屬性的類型是Integer、Double等類型,那么接收到的就是null。
- json字符串中,如果value為null的話,后端對應收到的就是null。
- 如果某個參數沒有value的話,在傳json字符串給后端時,要么干脆就不把該字段寫到json字符串中;要么寫value時, 必須有值,null 或""都行。
3.3 @RequestBody使用
3.3.1 編寫實體類User
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private int age;
private String gender;
}3.3.2 編寫controller
@RestController
@RequestMapping("/user")
public class UserController {
@PostMapping("/addUser")
public void addUser(@RequestBody User user){
System.out.println(user);
}
}3.3.3 使用postman進行接口測試

3.3.4 后臺數據輸出

3.4 @RequestParam和@RequestBody
當同時使用 @RequestParam 和 @RequestBody 時,@RequestParam指定的參數可以是普通元素、 數組、集合、對象等等(即:當,@RequestBody 與@RequestParam 可以同時使用時,原SpringMVC接收 參數的機制不變,只不過RequestBody 接收的是請求體里面的數據;而@RequestParam接收的是key-value 里面的參數,所以它會被切面進行處理從而可以用普通元素、數組、集合、對象等接收)。
即:如果參數時放在請求體中,傳入后臺的話,那么后臺要用@RequestBody才能接收到;如果不是放在 請求體中的話,那么后臺接收前臺傳過來的參數時,要用@RequestParam來接收,或則形參前什么也不寫也能接收。
四、@RequestParam和@PathVariable的區(qū)別
@RequestParam和@PathVariable都能夠完成類似的功能——因為本質上,它們都是用戶的輸入,只不過輸入的部分不同,一個在URL路徑部分,另一個在參數部分。要訪問一篇博客文章,這兩種URL設計都是可以的:
- 通過@PathVariable,例如/blogs/1
- 通過@RequestParam,例如blogs?blogId=1
那么究竟應該選擇哪一種呢?建議:
1、當URL指向的是某一具體業(yè)務資源(或資源列表),例如博客,用戶時,使用@PathVariable
2、當URL需要對資源或者資源列表進行過濾,篩選時,用@RequestParam
例如我們會這樣設計URL:
- /blogs/{blogId}
- /blogs?state=publish而不是/blogs/state/publish來表示處于發(fā)布狀態(tài)的博客文章
到此這篇關于SpringBoot中@PathVariable、@RequestParam和@RequestBody的區(qū)別和使用詳解的文章就介紹到這了,更多相關@PathVariable、@RequestParam和@RequestBody的區(qū)別內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
- springboot中@RequestParam和@PathVariable區(qū)別
- Spring中@PathVariable和@RequestParam注解的用法區(qū)別
- Spring中@RequestParam、@RequestBody和@PathVariable的用法詳解
- Springboot中@RequestParam和@PathVariable的用法與區(qū)別詳解
- @PathVariable、@RequestParam和@RequestBody的區(qū)別
- 方法參數屬性params,@PathVariable和@RequestParam用法及區(qū)別
- @PathVariable和@RequestParam傳參為空問題及解決
- 使用@pathvariable與@requestparam碰到的一些問題及解決
- 聊聊@RequestParam,@PathParam,@PathVariable等注解的區(qū)別
- Java中@PathVariable 和 @RequestParam的區(qū)別小結
相關文章
Tomcat Cannot assign requested address: JVM_Bind 非端口占用沖突
這篇文章主要介紹了 Tomcat Cannot assign requested address: JVM_Bind 非端口占用沖突的相關資料,需要的朋友可以參考下2017-01-01
Java中的重寫(Override)與重載(Overload)詳解
這篇文章主要介紹了Java中的重寫(Override)與重載(Overload)使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-05-05

