springboot常用的請求參數(shù)的接收方式
在Spring Boot中,接收請求參數(shù)的方式有多種,主要有以下幾種方式:
1. 使用 @RequestParam 注解
@RequestParam 用于接收請求中的查詢參數(shù)(query parameters)。它通常用于處理 URL 中的鍵值對,如 ?key=value。
示例:接收查詢參數(shù)
@GetMapping("/example")
public String example(@RequestParam String name, @RequestParam int age) {
return "Name: " + name + ", Age: " + age;
}
在這個例子中,如果 URL 是 /example?name=John&age=30,name 和 age 的值會被傳遞給方法。
參數(shù)類型轉(zhuǎn)換:Spring 會自動進行參數(shù)類型的轉(zhuǎn)換。如果類型不匹配(例如將字符串轉(zhuǎn)為整數(shù)失敗),會拋出異常。
默認值:可以設(shè)置默認值,當請求中沒有對應(yīng)參數(shù)時會使用默認值。
@GetMapping("/example")
public String example(@RequestParam(defaultValue = "John") String name) {
return "Name: " + name;
}
2. 使用 @PathVariable 注解
@PathVariable 用于接收路徑中的參數(shù),通常用于 RESTful 風格的 URL。
示例:接收 URL 中的路徑參數(shù)
@GetMapping("/user/{id}")
public String getUser(@PathVariable String id) {
return "User ID: " + id;
}
例如,當請求路徑為 /user/123 時,id 參數(shù)會接收到 123。
3. 使用 @RequestBody 注解
@RequestBody 用于接收請求體中的數(shù)據(jù),通常用于 POST 請求或 PUT 請求。它可以將請求體的數(shù)據(jù)反序列化成指定的 Java 對象(如 JSON、XML 等)。
示例:接收 JSON 格式的請求體
@PostMapping("/createUser")
public String createUser(@RequestBody User user) {
return "User created: " + user.getName();
}
假設(shè)發(fā)送的請求體是:
{
"name": "John",
"age": 30
}
@RequestBody 會將請求體的 JSON 數(shù)據(jù)轉(zhuǎn)換為 User 對象。
4. 使用 @ModelAttribute 注解
@ModelAttribute 用于將請求參數(shù)綁定到方法參數(shù)的 JavaBean 中。它常用于表單提交或使用 GET 請求傳遞的數(shù)據(jù)。
示例:表單數(shù)據(jù)綁定到 Java 對象
@PostMapping("/submitForm")
public String submitForm(@ModelAttribute User user) {
return "Form submitted by: " + user.getName();
}
假設(shè) HTML 表單提交的數(shù)據(jù)為:
<form action="/submitForm" method="post">
<input type="text" name="name" />
<input type="number" name="age" />
</form>
注意:@ModelAttribute 會將請求中的所有參數(shù)與 Java 對象的字段進行匹配。
5. 使用 @RequestHeader 注解
@RequestHeader 用于獲取請求頭中的數(shù)據(jù)??梢酝ㄟ^此注解獲取 HTTP 請求頭的某些信息。
示例:接收請求頭
@GetMapping("/header")
public String getHeader(@RequestHeader("User-Agent") String userAgent) {
return "User-Agent: " + userAgent;
}
假設(shè)請求頭中包含 User-Agent 字段,@RequestHeader 會將其值傳遞給 userAgent 變量。
6. 使用 @CookieValue 注解
@CookieValue 用于獲取請求中的 cookie 值。
示例:接收請求中的 cookie
@GetMapping("/cookie")
public String getCookie(@CookieValue("JSESSIONID") String sessionId) {
return "Session ID: " + sessionId;
}
假設(shè)請求中包含名為 JSESSIONID 的 cookie,@CookieValue 會將其值傳遞給 sessionId。
7. 使用 @RequestParam 的集合類型
@RequestParam 也支持接收數(shù)組或集合類型的參數(shù)。
示例:接收多個相同名稱的參數(shù)
@GetMapping("/items")
public String getItems(@RequestParam List<String> items) {
return "Items: " + items;
}
例如請求 /items?items=apple&items=banana&items=cherry,items 將接收到 ["apple", "banana", "cherry"]。
8. 使用 @RequestPart 注解
@RequestPart 用于處理上傳的文件或多部分表單數(shù)據(jù)(multipart/form-data)。它用于從請求中提取文件或其他部分的數(shù)據(jù)。
示例:接收文件和其他表單字段
@PostMapping("/upload")
public String uploadFile(@RequestPart("file") MultipartFile file, @RequestPart("description") String description) {
return "File uploaded: " + file.getOriginalFilename() + ", Description: " + description;
}
這里,file 是通過 @RequestPart 注解接收的文件,而 description 是接收到的其他字段。
9. 使用 @RequestMapping 注解的 params 屬性
可以在 @RequestMapping 中使用 params 屬性來限制方法僅在滿足特定查詢參數(shù)時才會被調(diào)用。
示例:請求必須包含特定參數(shù)才能執(zhí)行
@RequestMapping(value = "/search", params = "query")
public String search(@RequestParam String query) {
return "Search query: " + query;
}
只有當請求路徑為 /search?query=value 時,才會匹配到這個方法。
總結(jié)
- @RequestParam:用于查詢參數(shù)。
- @PathVariable:用于路徑參數(shù)。
- @RequestBody:用于請求體,常用于接收 JSON、XML 等格式的數(shù)據(jù)。
- @ModelAttribute:用于將請求參數(shù)綁定到 JavaBean 中。
- @RequestHeader:用于接收請求頭數(shù)據(jù)。
- @CookieValue:用于接收 Cookie 值。
- @RequestPart:用于處理上傳的文件和表單字段。
- 集合類型的 @RequestParam:用于接收多個相同名稱的參數(shù)。
- @RequestMapping params 屬性:用于限制特定查詢參數(shù)的接收。
這些方式可以根據(jù)不同的需求選擇使用,靈活地處理 Spring Boot 中的請求參數(shù)。
以上就是springboot常用的請求參數(shù)的接收方式的詳細內(nèi)容,更多關(guān)于springboot請求參數(shù)接收方式的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Java封裝Redis非阻塞分布式鎖徹底解決表單重復提交主鍵沖突問題
本文基于原生RedisTemplate封裝通用非阻塞分布式鎖工具類,實現(xiàn)鎖邏輯與業(yè)務(wù)邏輯解耦,兼顧易用性與安全性,同時解決鎖與事務(wù)配合、鎖釋放時機、失敗重試等核心坑點,感興趣的朋友跟隨小編一起看看吧2026-03-03
IDEA常用插件之類Jar包搜索Maven Search解讀
文章介紹了IDEA常用插件MavenSearch的使用方法,該插件可以幫助用戶快速查找和瀏覽Maven中央存儲庫中可用的依賴項和插件,方便用戶管理項目依賴項2025-01-01
SpringBoot集成Mybatis實現(xiàn)對多數(shù)據(jù)源訪問原理
本文主要分析討論在SpringBoot應(yīng)用中我們該如何配置SqlSessionFactoryBean對象,進而實現(xiàn)對多個不同的數(shù)據(jù)源的操縱,文章通過代碼示例介紹的非常詳細,需要的朋友可以參考下2023-11-11
關(guān)于Spring中@Transactional事務(wù)回滾的注意事項
這篇文章主要介紹了關(guān)于Spring中@Transactional事務(wù)回滾的注意事項,回滾(Rollback)指的是程序或數(shù)據(jù)處理錯誤,將程序或數(shù)據(jù)恢復到上一次正確狀態(tài)的行為?;貪L包括程序回滾和數(shù)據(jù)回滾等類型,需要的朋友可以參考下2023-05-05
Spring Boot實現(xiàn)數(shù)據(jù)訪問計數(shù)器方案詳解
在Spring Boot項目中,有時需要數(shù)據(jù)訪問計數(shù)器,怎么實現(xiàn)數(shù)據(jù)訪問計數(shù)器呢?下面小編給大家?guī)砹薙pring Boot數(shù)據(jù)訪問計數(shù)器的實現(xiàn)方案,需要的朋友參考下吧2021-08-08
SpringAI+Ollama本地模型實現(xiàn)快速對話的實戰(zhàn)指南
SpringAI是Spring官方推出的AI應(yīng)用開發(fā)框架,旨在統(tǒng)一封裝多種大模型,提供一套代碼無縫切換不同模型的功能,下面我們就來看看SpringAI如何結(jié)合Ollama實現(xiàn)快速對話功能吧2026-05-05

