@RequestBody和@ResponseBody区别

zzzzzengjf

于 2024-09-06 16:05:14 发布

阅读量623

点赞数 19

分类专栏： Spring 文章标签： java spring

本文链接：https://blog.csdn.net/zzzzzengjf/article/details/141962256

版权

Spring 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

@RequestBody 和 @ResponseBody 都是 Spring MVC 中用于处理 HTTP 请求和响应的注解，它们的作用分别是将请求体的数据绑定到方法参数上和将方法返回值直接写入 HTTP 响应体中。它们在 RESTful API 开发中非常常用。下面是两者的区别和使用场景。

1. `@RequestBody` 注解

用途：
@RequestBody 用于将 HTTP 请求体中的 JSON 或 XML 数据直接转换为 Java 对象（反序列化）并绑定到处理方法的参数上。它通常用于处理 POST、PUT 请求的请求体数据。
用法：
在需要从客户端接收 JSON 或 XML 格式的数据，并将其转换为 Java 对象时使用。

示例：

@PostMapping("/users")
public User createUser(@RequestBody User user) {
    // 方法参数 user 会被自动绑定到请求体中的 JSON 数据
    return userService.saveUser(user);
}

解释：
- 当客户端发送 POST 请求到 /users，请求体包含用户数据（例如 JSON 格式的用户对象），@RequestBody 会自动将该 JSON 数据转换为 User 对象。
- Spring 使用 HttpMessageConverter 机制（例如 MappingJackson2HttpMessageConverter）来实现从 JSON 数据到 Java 对象的转换。
常见场景：
接收客户端发送的 JSON 或 XML 数据，并将其映射为 Java 对象，如 RESTful API 的 POST 或 PUT 请求。

2. `@ResponseBody` 注解

用途：
@ResponseBody 用于将处理方法的返回值直接写入 HTTP 响应体中。它通常用于返回 JSON 或 XML 格式的数据给客户端。
用法：
在需要将方法返回值直接作为 HTTP 响应的内容，而不是视图名称时使用。@ResponseBody 告诉 Spring MVC，不需要通过视图解析器去渲染视图，而是直接将返回值写入到 HTTP 响应体中。

示例：

@GetMapping("/users/{id}")
@ResponseBody
public User getUserById(@PathVariable Long id) {
    // 返回的 User 对象会自动转换为 JSON 格式，并写入响应体
    return userService.getUserById(id);
}

解释：
- @ResponseBody 告诉 Spring 将 getUserById 方法返回的 User 对象自动转换为 JSON 格式，并将其作为 HTTP 响应体返回给客户端。
- Spring 使用 HttpMessageConverter（例如 MappingJackson2HttpMessageConverter）将 Java 对象序列化为 JSON 或 XML。
常见场景：
返回 JSON 或 XML 格式的响应数据，例如 RESTful API 中的所有 GET 请求、返回状态信息或其他数据的情况。

3. `@RestController` 注解的关系

@RestController 作用：
@RestController 是一个组合注解，等同于 @Controller 和 @ResponseBody。它告诉 Spring 这是一个 REST 控制器，默认情况下所有方法的返回值都会被序列化为 JSON 或 XML 格式并写入到 HTTP 响应体中。

简化用法：
当使用 @RestController 时，就不需要在每个方法上单独添加 @ResponseBody 了。例如：

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        // 自动作为 JSON 格式响应体返回
        return userService.getUserById(id);
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        // 处理请求体中的 JSON 数据，并响应 JSON 数据
        return userService.saveUser(user);
    }
}

4. 区别总结

特性	`@RequestBody`	`@ResponseBody`
用途	将请求体的数据绑定到方法参数	将方法的返回值写入到 HTTP 响应体中
使用场景	处理客户端发送的 JSON 或 XML 数据，通常用于 `POST`、`PUT` 请求	返回 JSON 或 XML 数据给客户端，通常用于 RESTful API 的响应
数据流向	HTTP 请求体 -> Java 对象	Java 对象 -> HTTP 响应体
与 `@RestController` 的关系	无直接关系，通常与 `@RestController` 一起使用来处理请求数据	`@RestController` 包含了 `@ResponseBody`，自动返回 JSON/XML 数据