@RequestBody注解用法

码农UP2U · 简书 · · 2019-11-10 14:50

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

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

function addRoomPic() {
   var housingPic = document.getElementById("housingPic").value;
   var remarks1    = document.getElementById("remarks1").value;
   
   if ( remarks1 == '' ) {
       return ;
   }
   
   document.getElementById("housingPic").value = "";
   document.getElementById("remarks1").value    = "";
   
   $.post(
       "${ctx}/housingresource/housingPics/ajaxSave",
       {housingPic: housingPic, remarks:remarks1},
       function (result) {
           // ...
       }
   );
}

Controller 中代码如下：

@RequestMapping(value = "ajaxSave")
@ResponseBody
public HousingPics ajaxSave(HttpServletRequest request) {
    HousingPics hrp = new HousingPics();
    hrp.setHousingPic(request.getParameter("housingPic"));
    hrp.setRemarks(request.getParameter("remarks"));

    // ....
}

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

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

@RequestMapping(value = "ajaxSave")
@ResponseBody
public HousingPics ajaxSave(@RequestBody HousingPics hrp) {
    // ...
}

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

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

Unsupported Media Type 415

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

function addRoomPic() {
   var housingPic  = document.getElementById("housingPic").value;
   var remarks1    = document.getElementById("remarks1").value;
   
   if ( remarks1 == '' ) {
       return ;
   }
   
   document.getElementById("housingPic").value = "";
   document.getElementById("remarks1").value    = "";
   
   $.ajax({
       url:"${ctx}/housingresource/housingPics/ajaxSave",
       dataType:"json",
       contentType:"application/json",
       type:"post",
       data:JSON.stringify({housingPic: housingPic, remarks:remarks1}),
       success:function(result) {
           // ...
       }});
}

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

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

我的微信公众号：“码农UP2U”

我的公众号

原文地址：访问原文地址
快照地址：访问文章快照

分享到微博