当前位置：首页 > article >正文

springboot 接口接收参数的注解介绍（@RequestParam，@PathVariable，@RequestBody 等）

article 2025/3/6 21:13:29

springboot 接收参数的注解介绍（使用方法）

在Spring Boot中，接收参数的方式主要依赖于Spring MVC提供的注解。这些注解帮助你将HTTP请求中的参数绑定到控制器（Controller）方法的参数上。以下是一些常用的接收参数的注解：

1. `@RequestParam`

用法：用于将HTTP请求参数绑定到控制器的方法参数上。如果请求参数不存在，可以指定一个默认值。

意义：这个注解主要用于处理请求中的查询参数（即URL中?后面的部分），使得你可以轻松地从请求中获取这些参数的值。

示例：

@GetMapping("/greeting")  
public String greeting(@RequestParam(value = "name", defaultValue = "World") String name) {  
    return String.format("Hello, %s!", name);  
}

2. `@PathVariable`

用法：用于将URL模板变量值绑定到控制器处理方法的参数上。

意义：这个注解使得你可以从URL的路径中提取变量值，这在构建RESTful API时非常有用。

示例：

@GetMapping("/user/{id}")  
public String getUserById(@PathVariable("id") Long id) {  
    // 根据id获取用户信息  
    return "User ID is: " + id;  
}

3. `@RequestBody`

用法：用于处理HTTP请求的内容体（Body），将请求体中的数据绑定到Java对象上。

意义：这个注解通常用于处理POST和PUT请求，特别是当请求的内容类型为application/json或application/xml时。它允许你直接将请求体中的数据映射到Java对象上，便于后续处理。

示例：

@PostMapping("/user")  
public ResponseEntity<String> createUser(@RequestBody User user) {  
    // 处理user对象  
    return ResponseEntity.ok("User created successfully");  
}

4. `@CookieValue`

用法：用于将请求的Cookie数据绑定到控制器方法的参数上。

意义：这个注解允许你访问HTTP请求中的Cookie信息，这在处理需要身份验证或会话管理的Web应用时非常有用。

示例：

@GetMapping("/cookie")  
public String readCookie(@CookieValue(name = "theme", defaultValue = "default") String theme) {  
    return "Theme is: " + theme;  
}

5. `@RequestHeader`

用法：用于将HTTP请求头信息绑定到控制器方法的参数上。

意义：这个注解允许你访问HTTP请求中的头部信息，比如User-Agent、Content-Type等，这对于日志记录、内容协商等场景非常有用。

示例：

@GetMapping("/header")  
public String readHeader(@RequestHeader(name = "User-Agent", defaultValue = "Unknown") String userAgent) {  
    return "User-Agent header is: " + userAgent;  
}

6. `@ModelAttribute`

用法：用于将请求参数绑定到JavaBean上，也可以用在方法上，表示该方法的返回值应该添加到模型（Model）中。

意义：这个注解主要用于处理表单数据，它可以将请求中的参数自动绑定到一个或多个JavaBean上，便于后续处理。

示例（用于参数绑定）：

@PostMapping("/addUser")  
public String addUser(@ModelAttribute User user) {  
    // 处理user对象  
    return "User added successfully";  
}

7. `@MatrixVariable`

用法：用于访问URI中的矩阵变量（Matrix Variables），这些变量是附加在URL路径段后的键值对。

意义：虽然这个注解在Web开发中不是特别常用，但它提供了一种在URL中传递额外信息的方式，而不需要改变路径结构。

示例：

@GetMapping("/cars/{carId}/owners/{ownerId}/cars/{carId}")  
public String carDetail(@MatrixVariable(name = "color", pathVar = "ownerId") String color) {  
    // 使用color变量  
    return "Color of the car: " + color;  
}

注意：上面的@GetMapping路径可能是一个错误的示例，因为通常不会在同一路径中两次使用相同的变量名（{carId}）。这里的重点是展示@MatrixVariable的用法，而不是路径的合理性。在实际应用中，路径应该是合理的，并且矩阵变量会附加在路径段之后，如/cars/1;color=red。

查看全文

http://www.kler.cn/a/286088.html