我们常常在学习、开发Java程序时,会碰到 @ResponseBody 注解,如果不明白这个注解的作用,看下面这个文章希望能帮助到你 !
@ResponseBody 注解的作用是将Controller的方法返回的对象,通过转换器转换为指定的格式之后,写入到 Response 对象的 body 区,常用来返回 JSON 数据或 XML 数据 。
注意:在使用此注解之后不会再走视图处理器,而是直接将数据写入到输入流中,他的效果等同于通过 Response 对象输出指定格式的数据 。
1. @ResponseBody作用在方法上 。
@Controller
public class HelloWorld {
@RequestMapping("/hello")
@ResponseBody
public String testSpringBoot() {
return "Hello SpringBoot 2 !";
}
}
如上图所示:在使用 @RequestMapping后,返回值通常解析为跳转路径,但是加上 @ResponseBody 后返回结果不会被解析为跳转路径,而是直接写入 Http Response Body 中。通常在异步获取数据时使用(AJAX)。@RequestBody 将 HTTP 请求正文插入方法中,使用适合的 HttpMessageConverter 将请求体写入某个对象。
2. 不使用 @ResponseBody 注解 。
@Controller
@RequestMapping("/springboot")
public class HelloWorld {
@RequestMapping("/hello")
//@ResponseBody
public String testSpringBoot() {
return "SpringBoot";
}
}
SpringBoot.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1> 峻哥带你学 SpringBoot !</h1>
</body>
</html>
如上图所示,当你不加@ResponseBody的时候,代码在执行的时候,它就会给你解析成跳转路径进行对应的跳转。
3. @ResponseBody作用在方法形参上 。
如上图所示,@RequestBody 作用在形参列表上,用于将前台发送过来固定格式的数据(xml、json)封装为对应的 JavaBean 对象,封装时使用到的一个对象是系统默认配置的 HttpMessageConverter进行解析,然后封装到形参上 。
@RequestBody 注解则是将 HTTP 请求正文插入方法中,使用适合的 HttpMessageConverter 将请求体写入某个对象。
注意:
该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上; 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。
使用时机:
1. GET、POST方式提时, 根据request header Content-Type的值来判断:
① application/x-www-form-urlencoded, 可选(即非必须,因为这种情况的数据@RequestParam, @ModelAttribute也可以处理,当然@RequestBody也能处理);
② multipart/form-data, 不能处理(即使用@RequestBody不能处理这种格式的数据);
③ 其他格式, 必须(其他格式包括application/json, application/xml等。这些格式的数据,必须使用@RequestBody来处理)。2. PUT方式提交时, 根据request header Content-Type的值来判断:
- application/x-www-form-urlencoded,必须使用@RequestBody来处理
- multipart/form-data, 不能处理;
- 其他格式, 必须使用@RequestBody来处理
补充:
1. @ResponseBody 也可以直接作用在类上的 ,最典型的例子就是 @RestController 这个注解,它就包含了 @ResponseBody 这个注解(@RestController=@ResponseBody+@Controller)
2. 在类上用@RestController,其内的所有方法都会默认加上@ResponseBody,也就是默认返回JSON格式。如果某些方法不是返回JSON的,就只能用@Controller了吧,这也是它们俩的区别。