在Spring Boot开发中，处理请求参数是一个常见的需求。Spring提供了多种注解来帮助开发者轻松地获取HTTP请求中的参数。以下是一些常用的参数处理相关注解及其示例。
一、@RequestParam
@RequestParam用于获取GET或POST请求中的单个请求参数。你可以将请求参数直接映射到方法的参数中。
示例：
假设我们有一个简单的RESTful接口，能够根据用户ID查询用户信息。
@RestController
@RequestMapping("/users")
public class UserController {
@GetMapping("/{id}")
public ResponseEntity<User> getUserById(@PathVariable Long id) {
// 模拟获取用户
User user = userService.findUserById(id);
return ResponseEntity.ok(user);
}
@PostMapping("/")
public ResponseEntity<User> createUser(@RequestParam String name, @RequestParam int age) {
User user = new User();
user.setName(name);
user.setAge(age);
userService.saveUser(user);
return ResponseEntity.status(HttpStatus.CREATED).body(user);
}
}
在上面的示例中，@RequestParam注解把HTTP POST请求中的“name”和“age”参数映射到方法参数中。
二、@PathVariable
@PathVariable用于从URL中提取参数，通常用于RESTful风格的URL。
示例：
在上面的例子中，getUserById方法使用了@PathVariable来获取路径中的用户ID。
@GetMapping("/{id}")
public ResponseEntity<User> getUserById(@PathVariable Long id) {
User user = userService.findUserById(id);
return ResponseEntity.ok(user);
}
三、@RequestBody
@RequestBody可以将HTTP请求体中的JSON数据直接映射为Java对象，适用于POST、PUT等请求方式。
示例：
假设我们有一个创建用户的接口，用户数据以JSON格式放在请求体中。
@PostMapping("/")
public ResponseEntity<User> createUser(@RequestBody User user) {
userService.saveUser(user);
return ResponseEntity.status(HttpStatus.CREATED).body(user);
}
在上面的示例中，@RequestBody注解将请求体中的JSON数据映射到User对象。
四、@RequestHeader
@RequestHeader用于获取HTTP请求中的头部信息。
示例：
假设我们需要获取请求中的用户代理信息：
@GetMapping("/agent")
public ResponseEntity<String> getUserAgent(@RequestHeader("User-Agent") String userAgent) {
return ResponseEntity.ok(userAgent);
}
在这个示例中，@RequestHeader注解用于提取名为“User-Agent”的请求头。
五、@RequestParam的复杂用法
- 设置默认值：
你可以通过defaultValue属性为请求参数设置默认值。
@GetMapping("/")
public ResponseEntity<List<User>> getUsers(@RequestParam(defaultValue = "10") int limit) {
List<User> users = userService.findUsers(limit);
return ResponseEntity.ok(users);
}
- 允许参数为可选：
通过设置required = false，让请求参数变为可选的。
@GetMapping("/")
public ResponseEntity<List<User>> getUsers(@RequestParam(required = false) String name) {
List<User> users = userService.findUsersByName(name);
return ResponseEntity.ok(users);
}
总结
在Spring Boot中，处理请求参数的相关注解如@RequestParam、@PathVariable、@RequestBody和@RequestHeader极大地简化了开发者的工作，使得从HTTP请求中提取数据变得更加直观和轻松。通过灵活运用这些注解，开发者可以构建更加优雅和易维护的Web接口。
