Spring学习经验—@ResponseBody注解的使用说明

分类:计算机 | Spring | 综合 775
更新:2020-11-22 11:34:15
编辑

说明

@ResponseBody注解的作用是将Controller的方法返回的对象通过适当的转换器转换为指定格式之后,写入到response对象的body区,通常用来返回json或者xml数据。在使用这个注解之后就不会再走视图处理器,而是直接将数据写入输出流中,效果等同于通过response对象输出指定格式的数据。

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

@ResponseBody可以作用在controller的方法上,也可以直接作用在类上,最典型的例子就是@RestController这个注解,它就包含了@ResponseBody注解,和作用在方法上的用处是一样的,只是作用在类上就不需要每个方法都加上这个注解了,减少了代码的冗余。

示例

@RequestMapping("/login")
@ResponseBody
public User login(User user){
   return user;
}

User的字段有userName,pwd。那么在前端接收到的数据为:'{"userName":"xxx","pwd":"xxx"}' 效果等同于如下代码:

@RequestMapping("/login")
public void login(User user, HttpServletResponse response){
   response.getWriter.write(JSONObject.fromObject(user).toString());
}

参考资料

https://www.jianshu.com/p/0a9c247571f9
https://blog.csdn.net/originations/article/details/89492884