SpringBoot?獲取請求參數(shù)的常用注解及用法

更新時間：2025年07月26日 10:42:04 作者：Full?Stack?Developme

Spring?Boot通過@RequestParam、@PathVariable等注解支持從HTTP請求中獲取參數(shù),涵蓋查詢、路徑、請求體、頭、Cookie等類型,還可綁定到對象或使用Servlet?API,需注意參數(shù)匹配規(guī)則及配置支持隱藏方法過濾器,本文介紹SpringBoot獲取請求參數(shù)的常用注解,感興趣朋友一起看看吧

SpringBoot 提供了多種注解來方便地從 HTTP 請求中獲取參數(shù)

以下是主要的注解及其用法：

1.@RequestParam

用于獲取查詢參數(shù)(URL 參數(shù))，適用于 GET 請求或 POST 表單提交。

@GetMapping("/user")
public String getUser(@RequestParam("id") Long userId) {
    return "User ID: " + userId;
}
// 可選參數(shù)，設(shè)置默認值
@GetMapping("/search")
public String search(@RequestParam(value = "q", required = false, defaultValue = "") String query) {
    return "Search: " + query;
}

2.@PathVariable

用于獲取 URL 路徑中的變量。

@GetMapping("/user/{id}")
public String getUser(@PathVariable("id") Long userId) {
    return "User ID: " + userId;
}
// 當變量名與方法參數(shù)名相同時可省略
@GetMapping("/article/{slug}")
public String getArticle(@PathVariable String slug) {
    return "Article: " + slug;
}

3.@RequestBody

用于獲取請求體中的 JSON/XML 數(shù)據(jù)，通常用于 POST/PUT 請求。

@PostMapping("/user")
public String createUser(@RequestBody User user) {
    return "Created user: " + user.getName();
}

4.@RequestHeader

用于獲取 HTTP 請求頭中的值。

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

5.@CookieValue

用于獲取 HTTP 請求中的 Cookie 值。

@GetMapping("/home")
public String home(@CookieValue("JSESSIONID") String sessionId) {
    return "Session ID: " + sessionId;
}

6.@ModelAttribute

用于綁定請求參數(shù)到模型對象，適用于表單提交。

@PostMapping("/register")
public String register(@ModelAttribute User user) {
    return "Registered: " + user.getName();
}

7.@RequestPart

用于處理 multipart/form-data 請求中的文件上傳。

@PostMapping("/upload")
public String uploadFile(@RequestPart("file") MultipartFile file) {
    return "Uploaded: " + file.getOriginalFilename();
}

8. 直接使用 Servlet API

SpringBoot 也支持直接使用 Servlet API 對象：

@GetMapping("/example")
public String example(HttpServletRequest request, HttpServletResponse response) {
    String param = request.getParameter("param");
    return "Parameter: " + param;
}

9. 獲取所有參數(shù)

@RequestParam Map獲取所有查詢參數(shù)

@GetMapping("/params")
public String getAllParams(@RequestParam Map<String, String> allParams) {
    return "All params: " + allParams.toString();
}

@RequestParam MultiValueMap獲取可能有多個值的參數(shù)

@GetMapping("/multiParams")
public String getMultiParams(@RequestParam MultiValueMap<String, String> params) {
    return "Multi params: " + params.toString();
}

10. 參數(shù)綁定到對象

SpringBoot 支持自動將請求參數(shù)綁定到 Java 對象：

@GetMapping("/filter")
public String filterUsers(UserFilter filter) {
    return "Filtering by: " + filter.toString();
}
// UserFilter 類示例
public class UserFilter {
    private String name;
    private Integer age;
    // getters and setters
}