@ResponseBody详解

执键行天涯

已于 2024-08-11 12:31:25 修改

阅读量1k

点赞数 21

分类专栏： JAVA基础文章标签： java

于 2024-08-11 12:25:05 首次发布

本文链接：https://blog.csdn.net/qq_39666711/article/details/141104029

版权

JAVA基础专栏收录该内容

14 篇文章 1 订阅

订阅专栏

注解一：@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 接口的重要注解之一，它简化了数据返回的操作，使得开发者更加专注于业务逻辑的处理。

注解二：@RestController
是 Spring Framework 中的注解，是 @Controller 注解的一个变体。与 @Controller 注解不同，@RestController 注解用于标识一个类是 RESTful 风格的控制器组件，它结合了 @Controller 和 @ResponseBody 的功能，使得处理请求并返回数据更加方便。

作用：
标识类为 RESTful 风格的控制器组件，专门用于处理 HTTP 请求并返回数据（通常是 JSON 格式）。
使用方法：

在控制器类上使用 @RestController 注解。
定义处理不同请求的方法，这些方法会自动将返回值转换为适当的数据格式（通常是 JSON）。

示例，展示了 @RestController 的使用方法：

  /**
     * 验证签名
     * @param data
     * @return
     */
    @VerifySign(type = "head")
    @GetMapping("sign/testAnnotation")
    @ResponseBody
    public String test(@RequestParam Map<String,String> data){
        // 模拟业务逻辑
        // TODO Something
        log.info("做一些业务，业务模拟");
        return "成功通过AOP切面中的校验，执行了业务逻辑";
    }

在这个示例中，Controller 类被标记为 @RestController，因此它是一个 RESTful 风格的控制器组件。通过使用
@RequestMapping 注解，我们将路径 “sign/testAnnotation” 映射到这个控制器。在 test方法上使用了
@GetMapping 注解，这表示当用户访问 “sign/testAnnotation” 路径时，该方法会处理请求并将字符串
“成功通过AOP切面中的校验，执行了业务逻辑” 作为 JSON 格式的响应返回给客户端。

与传统的 @Controller 不同，@RestController 不需要在每个处理方法上使用 @ResponseBody
注解，因为它默认将所有返回值都转换为适当的数据格式（例如 JSON）并包含在响应体中。

总之，@RestController 是一种方便的方式来创建 RESTful 风格的控制器，用于处理请求并返回数据，无需额外的配置即可实现数据的自动转换和封装

上面说了一堆，其实直白点说：当我不直接返回页面，而是返回JSON数据的时候，需要加上@ResponseBody注解或者 @RestController

参考链接：https://blog.csdn.net/qq_43406318/article/details/132190650
参考链接：https://blog.csdn.net/m0_62645012/article/details/134605875