@RequestBody注解用法

本文主要是介绍@RequestBody注解用法，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

博客园
首页
新随笔
联系
订阅
管理

随笔 - 8 文章 - 0 评论 - 51

@RequestBody注解用法

　　做Java已经有8个多月了，但是基本没有学习过Java语言，因此在项目中写代码基本靠的是其他语言的基础来写Java代码，写出来的很多代码虽然能用，但是感觉很不地道，虽然从来没有同事说过，但是我自己觉得是，因为我经常用下中国象棋的套路去下国际象棋。

　　在手头的项目用的SSM的框架，其中有用到Ajax的地方不少，方法是再简单不过了，在Ajax中对指定的URL提交参数，然后在Controller里通过request.getParameter()方法来接收参数。代码差不多就像下面的结构，Ajax的代码如下：

 1 function addRoomPic() {
 2    var housingPic = document.getElementById("housingPic").value;
 3    var remarks1    = document.getElementById("remarks1").value;
 4    
 5    if ( remarks1 == '' ) {
 6        return ;
 7    }
 8    
 9    document.getElementById("housingPic").value = "";
10    document.getElementById("remarks1").value    = "";
11    
12    $.post(
13        "${ctx}/housingresource/housingPics/ajaxSave",
14        {housingPic: housingPic, remarks:remarks1},
15        function (result) {
16            // ...
17        }
18    );
19 }

　　Controller中代码如下：

1 @RequestMapping(value = "ajaxSave")
2 @ResponseBody
3 public HousingPics ajaxSave(HttpServletRequest request) {
4     HousingPics hrp = new HousingPics();
5     hrp.setHousingPic(request.getParameter("housingPic"));
6     hrp.setRemarks(request.getParameter("remarks"));
7 
8     // ....
9 }

　　这样的做法没有错，看着也比较直观，对于我这个用其他语言讨论来写Java代码的人来说，这样已经很好了。难道还有更好的方法吗？事实证明，无知会自大。

　　在Spring中有一个注解可以方便的获取以Json形式提交的参数，并且可以把各个参数直接...直接...直接设置到一个对象中（犹豫的表达出自己不一定正确的用于），这个注解就是该文章标题中的@RequestBody了。修改项目中的代码，修改后的Controller如下：

1 @RequestMapping(value = "ajaxSave")
2 @ResponseBody
3 public HousingPics ajaxSave(@RequestBody HousingPics hrp) {
4     // ...
5 }

　　在此处，传递的两个参数已经被@RequestBody注解直接设置到对象中了，方法中实例化对象，接收参数的过程就免掉了。

　　修改完Controller以后，直接进行测试，发现并没有得到预期的效果，那么在修改后的方法中下断。再次测试，但是竟然没有被断下，那么就在浏览器中进行调试，调试发现提示415报错，提示类似如下：

Unsupported Media Type 415

　　该问题因为传输的数据格式不太对，那么就修改Ajax请求的方式，代码如下：

 1 function addRoomPic() {
 2    var housingPic  = document.getElementById("housingPic").value;
 3    var remarks1    = document.getElementById("remarks1").value;
 4    
 5    if ( remarks1 == '' ) {
 6        return ;
 7    }
 8    
 9    document.getElementById("housingPic").value = "";
10    document.getElementById("remarks1").value    = "";
11    
12    $.ajax({
13        url:"${ctx}/housingresource/housingPics/ajaxSave",
14        dataType:"json",
15        contentType:"application/json",
16        type:"post",
17        data:JSON.stringify({housingPic: housingPic, remarks:remarks1}),
18        success:function(result) {
19            // ...
20        }});
21 }

　　在代码中，另外增加了dataType和contentType两个Http的标识，对data数据进行了json格式的转换。修改后再次测试，这次OK了。

　　相对的，在接收Json格式后需要设置入对象中使用@RequestBody注解，如果要将返回的对象转换为Json格式，需要使用@ResponseBody注解即可。

@RequestBody 的正确使用办法

1.以前一直以为在SpringMVC环境中，@RequestBody接收的是一个Json对象，一直在调试代码都没有成功，后来发现，其实 @RequestBody接收的是一个Json对象的字符串，而不是一个Json对象。然而在ajax请求往往传的都是Json对象，后来发现用 JSON.stringify(data)的方式就能将对象变成字符串。同时ajax请求的时候也要指定dataType: "json",contentType:"application/json" 这样就可以轻易的将一个对象或者List传到Java端，使用@RequestBody即可绑定对象或者List.

最近在接收一个要离职同事的工作，接手的项目是用SpringBoot搭建的，其中看到了这样的写法：

[java]  view plain  copy
 
@RequestMapping("doThis")  
public String doThis(HttpServletRequest request,  
        @RequestParam("id") Long id, // 用户ID  
        @RequestParam("back_url") String back_url, // 回调地址           
        @RequestBody TestEntity json_data // json数据，对于java实体类  
){//...  

这个是一个请求映射方法，然后用浏览器输入url：http://127.0.0.1:8080/test/doThis?id=1&back_url=url&json_data={"code":2,"message":"test"}

在这个方法中，使用@RequestParam获取参数，然后使用@RequestBody对json格式的参数转换为Java类型

在运行的时候发现报错：Required request body is missing

@RequestBody的使用需要加载MappingJackson2HttpMessageConverter，但是SpringBoot的官方文档提到，这个是默认已经加载的了，而且json字符串和javabean也没有书写的错误

因此考虑到应该是请求Content-Type的问题，因为使用浏览器输入url的方式没有办法定义Content-Type，因此spring无法发现request body

为了证实这个想法，自己书写一个请求类：

[java]  view plain  copy
 
String add_url = "http://127.0.0.1:8080/test/doThis";  
   URL url = new URL(add_url);  
   HttpURLConnection connection = (HttpURLConnection)url.openConnection();  
   connection.setDoInput(true);  
   connection.setDoOutput(true);  
   connection.setRequestMethod("POST");  
   connection.setUseCaches(false);  
   connection.setInstanceFollowRedirects(true);  
   connection.setRequestProperty("Content-Type","application/json");  
   connection.connect();  
   DataOutputStream out = new DataOutputStream(connection.getOutputStream());  
   JSONObject obj = new JSONObject();  
      
   obj.put("code", -1002);       
   obj.put("message", "msg");  
   out.writeBytes(obj.toString());  
   out.flush();  
   out.close();  