深入剖析@RequestBody、@PathVariable和@RequestParam注解-Toy模板网

这篇具有很好参考价值的文章主要介绍了深入剖析@RequestBody、@PathVariable和@RequestParam注解。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

当我们在开发服务端方法时，遇到给方法传参的有几个不同的注解，今天我们来介绍 @RequestBody、@PathVariable 和 @RequestParam 这几个注解的定义和使用场景示例，以便于同学们理解和掌握。

@RequestBody 注解：

定义： @RequestBody 注解用于从请求体中获取数据，并将其转换为指定的对象类型。它通常用于 处理 POST 或 PUT 请求，其中请求体包含要创建或更新的 对象数据。

示例代码：

@PostMapping("/users")
public void createUser(@RequestBody User user) {
    // 在这里处理接收到的用户对象 user
}

前端页面示例：

<form th:action="@{/users}" th:object="${user}" method="post">
    <input type="text" id="name" th:field="*{name}" placeholder="Name">
    <input type="email" id="email" th:field="*{email}" placeholder="Email">
    <button type="submit">Create User</button>
</form>

@PathVariable 注解：
- 定义： @PathVariable 注解用于从 URL 路径中获取变量值，并将其作为方法参数使用。它通常用于在 RESTful API 中获取资源的特定实例。
- 示例代码：
```
@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
    // 根据用户 ID 获取用户信息
}
```
- 前端页面示例：
```
<a th:href="@{/users/{id}(id=${user.id})}">Get User id=123</a>
```

@RequestParam 注解：

定义： @RequestParam 注解用于从查询字符串或表单数据中获取单个参数值。它通常用于 处理 GET 请求中的查询参数。

示例代码：

@GetMapping("/users")
public List<User> getUsersByRole(@RequestParam String role) {
    // 根据角色获取用户列表
}

前端页面示例：

<form th:action="@{/users}" method="get">
    <input type="text" id="role" th:field="${role}" placeholder="Role">
    <button type="submit">Get Users</button>
</form>