@ResponseBody返回4种数据格式的数据

前言

@ResponseBody这个注解通常使用在控制层（controller）的方法上，其作用是将方法的返回值以特定的格式写入到response的body区域，进而将数据返回给客户端。当方法上面没有写ResponseBody,底层会将方法的返回值封装为ModelAndView对象。

假如是字符串则直接将字符串写到客户端,假如是一个对象，此时会将对象转化为json串然后写到客户端。这里需要注意的是，如果返回对象,按utf-8编码。如果返回String，默认按iso8859-1编码，页面可能出现乱码。因此在注解中我们可以手动修改编码格式，例如@RequestMapping(value="/cat/query",produces="text/html;charset=utf-8")，前面是请求的路径，后面是编码格式。

那么，控制层方法的返回值是如何转化为json格式的字符串的呢？其实是通过HttpMessageConverter中的方法实现的，因为它是一个接口，因此由其实现类完成转换。如果是bean对象，会调用对象的getXXX（）方法获取属性值并且以键值对的形式进行封装，进而转化为json串。如果是map集合，采用get(key)方式获取value值，然后进行封装。

1、返回一个键值对或者集合

前端JS请求：

 //返回值为map的形式
		$(".name").blur(function(){
		 	$.ajax({
			type:"Post",//请求类型
			url:"/mvc-demo/user/nameProving?t="+new Date().getTime(),//请求的url
			data:{name:$(".name").val()},//请求参数
			dataType:"json",//ajax接口（请求url）返回的数据类型
			success:function(data){//data：返回数据（json对象）
				if(data.name == "empty"){//name为空，错误提示
					$(".errorFont").text("用户名为不能为空！");
					$(".errorFont").css("color","red");
				}else if(data.name == "exist"){
					$(".errorFont").text("用户名已注册");
					$(".errorFont").css("color","green");
				}else if(data.name == "noexist"){
					$(".errorFont").text("用户名未注册");
					$(".errorFont").css("color","red");
				}
			},
			error:function(data){
				$(".errorFont").text("发生未知错误，请联系管理员！");
				$(".errorFont").css("color","red");
			}
		});
		});

后端逻辑处理：

//验证用户是否存在,返回一个键值对的数据
	@RequestMapping("/nameProving")	
	@ResponseBody
	public Object nameProving(String name){
		HashMap<String,String> resultMap=new HashMap<String,String>();
		if(StringUtils.isEmpty(name)){
			resultMap.put("name", "empty");
		}else{
			Userss user=userService.getUserByName(name);
			if(user!=null)
				resultMap.put("name", "exist");
			else
				resultMap.put("name", "noexist");
		}
		return JSONArray.toJSONString(resultMap);
	}

2、返回一个JSON格式的String字符串

前端js请求：

            //返回值为String的形式,dataType:"json"
		    $(".name").blur(function(){
		 	$.ajax({
			type:"Post",//请求类型
			url:"/mvc-demo/user/nameProving2?t="+new Date().getTime(),//请求的url
			data:{name:$(".name").val()},//请求参数
			dataType:"json",//ajax接口（请求url）返回的数据类型
			success:function(data){//data：返回数据（json对象）
				if(data ==  "empty"){//name为空，错误提示
					$(".errorFont").text("用户名为不能为空2！");
					$(".errorFont").css("color","red");
				}else if(data==  "exist"){
					$(".errorFont").text("用户名已注册2");
					$(".errorFont").css("color","green");
				}else if(data == "noexist"){
					$(".errorFont").text("用户名未注册2");
					$(".errorFont").css("color","red");
				}
			},
			error:function(data){
				$(".errorFont").text("发生未知错误，请联系管理员2！");
				$(".errorFont").css("color","red");
			}
		});
		});

后端逻辑处理：

//验证用户是否存在,返回一个转成json字符串的数据
	@RequestMapping("/nameProving2")	
	@ResponseBody
	public String nameProving2(String name){
		String result="";
		if(StringUtils.isEmpty(name)){
			result= "empty";
		}else{
			Userss user=userService.getUserByName(name);
			if(user!=null)
				result= "exist";
			else
				result= "noexist";
		}
		return JSONArray.toJSONString(result);
	}

3、返回一个字符串

前端js请求：

重点：datatype:"text"

//返回值为String的形式,dataType:"text"
		$(".name").blur(function(){
		 	$.ajax({
			type:"Post",//请求类型
			url:"/mvc-demo/user/nameProving3?t="+new Date().getTime(),//请求的url
			data:{name:$(".name").val()},//请求参数
			dataType:"text",//ajax接口（请求url）返回的数据类型
			success:function(data){//data：返回数据（json对象）
				if(data ==  "\"empty\""){//name为空，错误提示
					$(".errorFont").text("用户名为不能为空3！");
					$(".errorFont").css("color","red");
				}else if(data==  "\"exist\""){
					$(".errorFont").text("用户名已注册3");
					$(".errorFont").css("color","green");
				}else if(data == "\"noexist\""){
					$(".errorFont").text("用户名未注册3");
					$(".errorFont").css("color","red");
				}
			},
			error:function(data){
				$(".errorFont").text("发生未知错误，请联系管理员3！");
				$(".errorFont").css("color","red");
			}
		});
		});

后端逻辑处理：

//验证用户是否存在,返回一个字符串的数据
	/**
	 * 此方法中有多个注解  method：指定请求方式
	 * required：表示参数是否必须  默认为必须  fslse为不是必须
	 * @param name
	 * @return
	 */
	@RequestMapping(value="/nameProving3",method=RequestMethod.POST,params="name")	
	@ResponseBody
	public String nameProving3(@RequestParam(value="name",required=false)String name){
		String result="";
		if(StringUtils.isEmpty(name)){
			result= "empty";
		}else{
			Userss user=userService.getUserByName(name);
			if(user!=null)
				result= "exist";
			else
				result= "noexist";
		}
		return result;
	}

4、返回一个类对象的数据

前端js请求：

//返回值为类对象的形式,dataType:"json"
		$(".name").blur(function(){
		 	$.ajax({
			type:"Post",//请求类型
			url:"/mvc-demo/user/nameProving4?t="+new Date().getTime(),//请求的url
			data:{name:$(".name").val()},//请求参数
			dataType:"json",//ajax接口（请求url）返回的数据类型
			success:function(data){//data：返回数据（json对象）
				if(data == null){//name为空，错误提示
					$(".errorFont").text("用户名为空或者用户名不存在4！");
					$(".errorFont").css("color","red");
				}else{
					$(".errorFont").text("用户名"+data.name+"已注册4");
					$(".errorFont").css("color","green");
				}
			},
			error:function(data){
				$(".errorFont").text("发生未知错误，请联系管理员2！");
				$(".errorFont").css("color","red");
			}
		});
		});

后端逻辑处理：

//返回一个类对象
	@RequestMapping("/nameProving4")	
	@ResponseBody
	public Userss nameProving4(String name){
		System.out.println("进来了4");
		Userss user=userService.getUserByName(name);
			if(user==null){
				return null;
			}
			return user;
	}