在 Spring Boot 的 Controller
层中,有许多常用的注解可以用来处理请求、验证输入、绑定参数等。以下是一些常见的注解及其使用方式:
1. @PathVariable
- 用途: 用于绑定 URL 路径中的占位符到方法参数上。
- 示例:
@GetMapping("/users/{id}")
public User getUserById(@PathVariable(name = "id") Integer userId) {
return userService.getUserById(userId);
}
2. @RequestParam
- 用途: 用于绑定 URL 查询参数到方法参数上,通常用于处理 GET 请求中的查询参数。
- 示例:
@GetMapping("/search")
public List<User> searchUsers(@RequestParam(name = "name") String userName) {
return userService.searchUsers(userName);
}
3. @RequestBody
- 用途: 用于将请求体中的 JSON 数据绑定到方法参数上,通常用于处理 POST 请求中的数据。
- 示例:
@PostMapping("/users")
public User createUser(@RequestBody UserCreateRequest userRequest) {
return userService.createUser(userRequest);
}
4.@RequestHeader
- 用途: 用于将请求头中的值绑定到方法参数上。
- 示例:
@GetMapping("/headers")
public String getHeaderInfo(@RequestHeader(name = "Authorization") String authToken) {
return "Token: " + authToken;
}
5.@Validated
- 用途: 用于触发 Spring 的验证机制,通常与
@RequestBody
或 @RequestParam
等注解一起使用,对传入参数进行验证。 - 示例:
@PostMapping("/users")
public User createUser(@Validated @RequestBody UserCreateRequest userRequest) {
return userService.createUser(userRequest);
}
6.@ModelAttribute
- 用途:用于绑定请求参数到方法参数或将模型属性添加到模型中,适用于表单提交。
- 示例:
@PostMapping("/form")
public String handleFormSubmit(@ModelAttribute UserForm userForm) {
return "formResult";
}
7.@CookieValue
- 用途: 用于将请求中的 Cookie 值绑定到方法参数上。
- 示例:
@GetMapping("/cookie")
public String getCookieValue(@CookieValue(name = "sessionId") String sessionId) {
return "Session ID: " + sessionId;
}
8.@SessionAttribute
- 用途:用于从 HTTP Session 中获取属性值并绑定到方法参数上。
- 示例:
@GetMapping("/session")
public String getSessionAttribute(@SessionAttribute(name = "userId") Integer userId) {
return "User ID: " + userId;
}