@ResponseBody详解

@ResponseBody 是 Spring Framework 中的一种注解，用于表示返回的内容应该直接写入 HTTP 响应体，而不是通过视图解析器来渲染一个视图（如 JSP 页）。当你在控制器的方法上使用 @ResponseBody 时，Spring 会将方法的返回值直接转换成响应的内容，通常是 JSON、XML 或其他格式的内容。

1. 基本用法

当你在一个方法上使用 @ResponseBody 时，Spring 会自动将返回的对象转换为指定格式（如 JSON 或 XML），并将其写入响应体。例如，返回一个对象时，Spring 会使用 HttpMessageConverter 来将对象转换成 JSON 格式。

示例：

@RestController
public class MyController {

    @RequestMapping("/data")
    @ResponseBody
    public MyData getData() {
        MyData data = new MyData();
        data.setName("Spring");
        data.setValue("Framework");
        return data;  // Spring 会自动将这个对象转换为 JSON 格式
    }
}

在这个例子中，@ResponseBody 告诉 Spring 将 getData() 方法的返回值（一个 MyData 对象）直接作为响应体返回。默认情况下，Spring 会使用 Jackson 库将 Java 对象转换为 JSON。

2. @RestController 简化

在 Spring 4+ 中，@RestController 注解是 @Controller 和 @ResponseBody 的组合，意味着所有标注在 @RestController 类上的方法都将默认使用 @ResponseBody。

例如，上面的代码可以简化为：

@RestController
public class MyController {

    @RequestMapping("/data")
    public MyData getData() {
        MyData data = new MyData();
        data.setName("Spring");
        data.setValue("Framework");
        return data;  // Spring 会自动将这个对象转换为 JSON 格式
    }
}

3. 返回 JSON 或 XML 格式

@ResponseBody 会根据请求的 Accept 头信息来选择响应格式。例如，如果客户端请求的是 JSON 格式，Spring 会自动使用 Jackson 或其他相关的 HttpMessageConverter 将 Java 对象转成 JSON。

• 请求头： Accept: application/json
• 响应内容： {"name":"Spring", "value":"Framework"}

Spring 默认使用 Jackson 来进行对象与 JSON 的转换。如果你想返回其他格式（如 XML），可以配置不同的 HttpMessageConverter。

4. 结合 @RequestMapping 使用

你可以使用 @RequestMapping 配合 @ResponseBody 来处理不同的 HTTP 请求。例如：

@RequestMapping(value = "/getJsonData", method = RequestMethod.GET)
@ResponseBody
public MyData getJsonData() {
    MyData data = new MyData();
    data.setName("Spring");
    data.setValue("Framework");
    return data;  // 返回 JSON 格式
}

5. 常见的使用场景

• 返回 JSON 或 XML 数据：如 API 返回数据。
• Ajax 请求：客户端发起异步请求并期望从服务器获取数据（JSON、XML 等）。
• RESTful Web 服务 ：@ResponseBody 是 RESTful API 开发中常见的返回数据的方式。

6. 与 @RequestBody 对比

• @ResponseBody 用于方法的返回值，告诉 Spring 直接将方法的返回值写入响应体。
• @RequestBody 用于方法的参数，表示请求体中的数据应该被转换为对应的 Java 对象。

示例：

@RequestMapping(value = "/postData", method = RequestMethod.POST)
@ResponseBody
public String postData(@RequestBody MyData data) {
    // Spring 会将请求体中的 JSON 转换成 MyData 对象
    return "Received: " + data.getName();
}

总结

• @ResponseBody 注解用于直接返回数据给客户端，常用于 RESTful Web 服务和 AJAX 请求。
• 返回的数据可以是 Java 对象，Spring 会自动将其转换为 JSON、XML 等格式。
• @RestController 是 @Controller 和 @ResponseBody 的组合，可以简化代码。

通过使用 @ResponseBody，Spring 简化了与客户端交互时的数据格式处理，使得在构建 API 或 Web 服务时更加方便。