@ResponseBody用法详解

最新推荐文章于 2024-06-11 07:30:00 发布

笑尘~Y

最新推荐文章于 2024-06-11 07:30:00 发布

阅读量3.3w

点赞数 60

分类专栏： springboot 文章标签： json java restful

本文链接：https://blog.csdn.net/weixin_47609799/article/details/124843709

版权

springboot 专栏收录该内容

1 篇文章 1 订阅

订阅专栏

概念性理解

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

本质

@ResponseBody的作用其实是将java对象转为json格式的数据，然后直接写入HTTP response 的body中；一般在异步获取数据时使用

注意

在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

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

在使用 @RequestMapping后，返回值通常解析为跳转路径，但是加上 @ResponseBody 后返回结果不会被解析为跳转路径，而是直接写入 HTTP response body 中。比如异步获取 json 数据，加上 @ResponseBody 后，会直接返回 json 数据。@RequestBody 将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。

案例

登录小案例分析

比如我要在登陆的时候跳转到一个“success.html”页面，当你加上@ResponseBody注解后，代码在执行的时候，它就不会给你解析成跳转路径，它会给你返回success字符串。

success.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>欢迎您，登陆成功</h1>
</body>
</html>

Controller：

@ResponseBody
@RequestMapping(value = "/loginIn", produces = "application/json;charset=UTF-8")
public Object login(UserBean user) {
    result = userService.loginIn(user.getUsername(), user.getPassword());
    if(result!=null){
        return "success";
    }else {
        return "error";
    }
}

运行结果：
在这里插入图片描述
②、当你不加@ResponseBody的时候，代码在执行的时候，它就会给你解析成跳转路径进行对应的跳转。

@RequestMapping(value = "/loginIn", produces = "application/json;charset=UTF-8")
public Object login(UserBean user) {
    result = userService.loginIn(user.getUsername(), user.getPassword());
    if(result!=null){
        return "success";
    }else {
        return "error";
    }
}

运行结果：
在这里插入图片描述

总结：

（1）@ResponseBody 也是可以直接作用在类上的，最典型的例子就是 @RestController 这个注解，它就包含了 @ResponseBody 这个注解

（2）在类上用@RestController，其内的所有方法都会默认加上@ResponseBody，也就是默认返回JSON格式。如果某些方法不是返回JSON的，就只能用@Controller了吧，这也是它们俩的区别。

说一点@RequestBody

@RequestBody是作用在形参列表上，用于将前台发送过来固定格式的数据【xml格式或者 json等】封装为对应的 JavaBean 对象，封装时使用到的一个对象是系统默认配置的 HttpMessageConverter进行解析，然后封装到形参上。

@RequestBody 注解则是将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。

作用：

该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上；再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机：

①、GET、POST方式提时，根据request header Content-Type的值来判断：

application/x-www-form-urlencoded，可选（即非必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）；
multipart/form-data, 不能处理（即使用@RequestBody不能处理这种格式的数据）；
其他格式，必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使用@RequestBody来处理）；
②、PUT方式提交时，根据request header Content-Type的值来判断：

application/x-www-form-urlencoded，必须；
multipart/form-data, 不能处理；
其他格式，必须；
说明：request的body部分的数据编码格式由header部分的Content-Type指定；

@RequestMapping(value = "user/login")
@ResponseBody
// 将ajax（datas）发出的请求写入 User 对象中
public User login(@RequestBody User user) {   
// 这样就不会再被解析为跳转路径，而是直接将user对象写入 HTTP 响应正文中
    return user;    
}

笑尘~Y

关注

60
点赞
踩
252

收藏

觉得还不错? 一键收藏
3
评论
@ResponseBody用法详解

概念性理解@ResponseBody 注解的作用是将Controller的方法返回的对象，通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。本质@ResponseBody的作用其实是将java对象转为json格式的数据，然后直接写入HTTP response 的body中；一般在异步获取数据时使用注意在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。@
复制链接

扫一扫

专栏目录