@RequestMapping、@ResponseBody 和 @RequestBody 注解的用法与区别

时间:2022-11-01 20:23:02

背景:

帮助同事解决文件上传的bug(文件上传成功,但是页面提示上传接口异常,数据的确是插入了),从前端layui页面找错误,然后浏览器调试,找了半天无果。layui文件上传格式code返回是数值,后台返回是success。然后尝试从后台返回值入手,使用map返回。结果告败。最后当我回到位置上运行自己的项目时,想起来了,可能是后台没有响应体。果然是,bingo解决!

@RequestMapping @ResponseBody 和 @RequestBody 我们经常使用,它们的区别是什么呢,下面简单介绍下:

@RequestMapping

@RequestMapping 是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径;用于方法上,表示在类的父路径下追加方法上注解中的地址将会访问到该方法。例如.:

 /**
* 用于类上,可以没有
*/
@RequestMapping(value = "/controllerDemo")
public class ControllerDemo {
// 用于方法上,必须有
@RequestMapping(value = "/methodDemo")
public String methodDemo() {
return "helloWorld";
}
}

RequestMapping注解有六个属性,下面我们把她分成三类进行说明。

1、value, method

value: 指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明)

method:指定请求的method类型,GET、POST、PUT、DELETE等

2、consumes,produces

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

3、params,headers

params:指定request中必须包含某些参数值是,才让该方法处理。

headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。

@ResponseBody

@Responsebody 注解表示该方法的返回的结果直接写入 HTTP 响应正文(ResponseBody)中,一般在异步获取数据时使用,通常是在使用 @RequestMapping 后,返回值通常解析为跳转路径,加上 @Responsebody 后返回结果不会被解析为跳转路径,而是直接写入HTTP 响应正文中。
作用: 
   该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。 
使用时机: 
   返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;

当页面发出异步请求时:

 function login(){
var datas='{"username":"'+$('#username').val()+'","userid":"'+$('#userid').val()+'","status":"'+$('#status').val()+'"}';
$.ajax({
type:'POST',
contentType:'application/json',
url:"${pageContext.request.contextPath}/user/login",
processData:false,
dataType:'json',
data:datas,
success:function(data){
alert("userid:"+data.userid+"username:"+data.username+"status:"+data.status);     },
error:function(XMLHttpRequest,textStatus,errorThrown){
alert("出现异常,异常信息:"+textStatus,"error");
}
});
};

后端代码:

 @RequestMapping(value="user/login")
@ResponseBody
//将ajax(datas)发出的请求写入User对象中,返回json对象响应回去
public User login(User user) {
User user = new User();
user.setUserid(1);
user.setUsername("MrF");
user.setStatus("1");
return user ;
}

异步获取 json 数据,加上 @Responsebody 注解后,就会直接返回 json 数据。

@RequestBody

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

作用:

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

使用时机:

A) GET、POST方式提时, 根据request header Content-Type的值来判断:

 application/x-www-form-urlencoded,可选(即非必须,因为这种情况的数据@RequestParam,@ModelAttribute也可以处理,当然@RequestBody也能处理);
multipart/form-data,不能处理(即使用@RequestBody不能处理这种格式的数据);
其他格式,必须(其他格式包括application/json,application/xml等。这些格式的数据,必须使用@RequestBody来处理);

B) 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;
}