@ResponseBody详解

五敷有你

已于 2024-01-06 10:24:45 修改

阅读量3.4k

点赞数 13

文章标签： java spring spring boot

于 2023-11-24 19:53:52 首次发布

本文链接：https://blog.csdn.net/m0_62645012/article/details/134605875

版权

本文详细介绍了SpringMVC框架中的@ResponseBody注解，用于将Controller方法的返回值转换为JSON或XML格式，并写入HTTP响应体。它常用于构建RESTful风格接口，支持前后端分离和移动端开发。

摘要由CSDN通过智能技术生成

@ResponseBody()

作用：

@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。

位置：

@ResponseBody是作用在方法上的，@ResponseBody 表示该方法的返回结果直接写入 HTTP response body 中，一般在异步获取数据时使用【也就是AJAX】。

@ResponseBody也可以作用在类上，表示这个类所有方法都是返回JSON数据。

注意事项：

注意：在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。
在使用 @RequestMapping后，返回值通常解析为跳转路径，但是加上 @ResponseBody 后返回结果不会被解析为跳转路径，而是直接写入 HTTP response body 中。
比如异步获取 json 数据，加上 @ResponseBody 后，会直接返回 json 数据。@RequestBody 将 HTTP 请求正文插入方法中，使用适合HttpMessageConverter 将请求体写入某个对象。

3. 使用场景

在开发过程中，@ResponseBody 经常用于构建 RESTful 风格的接口。通过这个注解，可以方便地返回结构化的数据，而不是页面视图。这种方式对于前后端分离的项目和移动端开发非常常见。

4.实例

@RestController
@RequestMapping("/api")
public class ExampleController {

    @GetMapping("/data")
    @ResponseBody
    public Map<String, String> getData() {
        Map<String, String> data = new HashMap<>();
        data.put("key1", "value1");
        data.put("key2", "value2");
        return data;
    }
}

在这个例子中，@RestController 注解表示这个控制器的所有方法都返回 JSON 数据。而 @GetMapping 和 @ResponseBody 注解组合使用，表示 /api/data 路径的 GET 请求将会返回一个 Map 对象，该对象将以 JSON 格式写入 HTTP response body 中。

总的来说，@ResponseBody 是 Spring MVC 中用于构建 RESTful 接口的重要注解之一，它简化了数据返回的操作，使得开发者更加专注于业务逻辑的处理。

创作不易，给个关注吧