@RequestBody和@RequestParam的原理及使用

一、@RequestBody

      @RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的);而最常用的使用请求体传参的无疑是POST请求了,所以使用@RequestBody接收数据时,一般都用POST方式进行提交。在后端的同一个接收方法里,@RequestBody与@RequestParam()可以同时使用,@RequestBody最多只能有一个,而@RequestParam()可以有多个。

       注解@RequestBody接收的参数是来自requestBody中,即请求体。一般用于处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据,比如:application/json、application/xml等类型的数据。
就application/json类型的数据而言,使用注解@RequestBody可以将body里面所有的json数据传到后端,后端再进行解析。
  GET请求中,因为没有HttpEntity,所以@RequestBody并不适用。
  POST请求中,通过HttpEntity传递的参数,必须要在请求头中声明数据的类型Content-Type,SpringMVC通过使用
  HandlerAdapter 配置的HttpMessageConverters来解析HttpEntity中的数据,然后绑定到相应的bean上。

  Restful请求由DispatcherServlet处理,找到相应的HandlerAdapter进行处理,RequestMappingHandlerAdapter会处理@RequestMapping注解的请求,设置一系列参数解析器进行解析,如果参数使用@RequestBody注解,则使用RequestResponseBodyMethodProcessor进行解析,此参数解析器用HttpMessageConverter将HttpMessage封装为具体的JavaBean对象,json格式的数据内部使用jackson进行json数据的解析。

使用说明:
1、一个请求,只有一个RequestBody;一个请求,可以有多个RequestParam。
2、当同时使用@RequestParam()和@RequestBody时,@RequestParam()指定的参数可以是普通元素、数组、集合、对象等等(即:当,@RequestBody 与@RequestParam()可以同时使用时,原SpringMVC接收参数的机制不变,只不过RequestBody 接收的是请求体里面的数据;而RequestParam接收的是key-value里面的参数,所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。
       即:如果参数时放在请求体中,application/json传入后台的话,那么后台要用@RequestBody才能接收到;
             如果不是放在请求体中的话,那么后台接收前台传过来的参数时,要用@RequestParam来接收,或则形参前 什么也不写也能接收。
3、如果参数前写了@RequestParam(paramName),那么前端必须有对应的paramName名字才行(不管其是否有值,当然可以通过设置该注解的required属性来调节是否必须传),如果没有paramName名的话,那么请求会出错,报400。
4、如果参数前不写@RequestParam(paramName)的话,那么就前端可以有可以没有对应的paramName名字才行,如果有paramName名的话,那么就会自动匹配;没有的话,请求也能正确发送。
5、如果后端参数是一个对象,且该参数前是以@RequestBody修饰的,那么前端传递json参数时,必须满足以下要求:

  •      后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即:@RequestBody后面的类)时,会根据json字符串中的key来匹配对应实体类的属性,如果匹配一致且json中的该key对应的值符合(或可转换为),这一条我会在下面详细分析,其他的都可简单略过,但是本文末的核心逻辑代码以及几个结论一定要看! 实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性。
  •     json字符串中,如果value为""的话,后端对应属性如果是String类型的,那么接受到的就是"",如果是后端属性的类型是Integer、Double等类型,那么接收到的就是null。
  •     json字符串中,如果value为null的话,后端对应收到的就是null。
  •     如果某个参数没有value的话,在传json字符串给后端时,要么干脆就不把该字段写到json字符串中;要么写value时, 必须有值,null  或""都行。

二、@RequestParam

     注解@RequestParam接收的参数是来自HTTP请求体或请求url的QueryString中。
     RequestParam可以接受简单类型的属性,也可以接受对象类型。
    @RequestParam有三个配置参数:

  •     required 表示是否必须,默认为 true,必须。
  •     defaultValue 可设置请求参数的默认值。
  •     value 为接收url的参数名(相当于key值)。

     @RequestParam用来处理 Content-Type 为 application/x-www-form-urlencoded 编码的内容,Content-Type默认为该属性。@RequestParam也可用于其它类型的请求,例如:POST、DELETE等请求。
所以在postman中,要选择body的类型为 x-www-form-urlencoded,这样在headers中就自动变为了 Content-Type : application/x-www-form-urlencoded 编码格式。不推荐使用@RequestParam接收application/json,这时候就需要使用到@RequestBody。

posted @ 2022-01-17 21:11  xuzhujack  阅读(1804)  评论(0编辑  收藏  举报
;