SpringBoot 中 @RequestBody的正确使用方法

Posted Archibald Witwicky

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot 中 @RequestBody的正确使用方法相关的知识,希望对你有一定的参考价值。

SpringBoot 中 @RequestBody的正确使用方法

 

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

 

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


  这个是一个请求映射方法,然后用浏览器输入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
 
  1. String add_url = "http://127.0.0.1:8080/test/doThis";  
  2.    URL url = new URL(add_url);  
  3.    HttpURLConnection connection = (HttpURLConnection)url.openConnection();  
  4.    connection.setDoInput(true);  
  5.    connection.setDoOutput(true);  
  6.    connection.setRequestMethod("POST");  
  7.    connection.setUseCaches(false);  
  8.    connection.setInstanceFollowRedirects(true);  
  9.    connection.setRequestProperty("Content-Type","application/json");  
  10.    connection.connect();  
  11.    DataOutputStream out = new DataOutputStream(connection.getOutputStream());  
  12.    JSONObject obj = new JSONObject();  
  13.       
  14.    obj.put("code", -1002);       
  15.    obj.put("message", "msg");  
  16.    out.writeBytes(obj.toString());  
  17.    out.flush();  
  18.    out.close();  

  请求还是失败,经过调试,发现需要去掉所有的@RequestParam注解才能成功

 

  总结:

    1、@RequestBody需要把所有请求参数作为json解析,因此,不能包含key=value这样的写法在请求url中,所有的请求参数都是一个json

    2、直接通过浏览器输入url时,@RequestBody获取不到json对象,需要用java编程或者基于ajax的方法请求,将Content-Type设置为application/json


以上是关于SpringBoot 中 @RequestBody的正确使用方法的主要内容,如果未能解决你的问题,请参考以下文章

SpringBoot Controller 中使用多个@RequestBody的正确姿势

springboot @RequestBody注解学习

在 SpringBoot 中使用 @Valid 和 @Requestbody 验证 JSON 对象

SpringBoot 实战:在 RequestBody 中优雅的使用枚举参数

解决SpringBoot中@RequestBody不能和Multipart同时传递的问题

SpringBoot Mock测试RequestBody参数并包含其他参数接口