【转载】@RequestBody的使用

最新推荐文章于 2024-09-17 21:07:26 发布

beidaol

最新推荐文章于 2024-09-17 21:07:26 发布

阅读量612

点赞数

原文链接：https://blog.csdn.net/justry_deng/article/details/80972817

版权

转自：https://blog.csdn.net/justry_deng/article/details/80972817

提示: 建议一定要看后面的@RequestBody的核心逻辑源码以及六个重要结论！本文前半部分的内容都是一些基本知
识常识，可选择性跳过。

说明:

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的);
@requestBody注解常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容，比如说：application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。

$.ajax({
　　　　　　　　url:"/login",
　　　　　　　　type:"POST",
　　　　　　　　data:'{"userName":"admin","pwd","admin123"}',
　　　　　　　　contentType:"application/json charset=utf-8",
　　　　　　　　success:function(data){
　　　　　　　　　　alert("request success ! ");
　　　　　　　　}
　　　　 });

使用时机：

A) GET、POST方式提时，根据request header Content-Type的值来判断:

application/x-www-form-urlencoded，可选（即非必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）；
multipart/form-data, 不能处理（即使用@RequestBody不能处理这种格式的数据）；
其他格式，必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使用@RequestBody来处理）；

B) PUT方式提交时，根据request header Content-Type的值来判断:

application/x-www-form-urlencoded，必须；
multipart/form-data, 不能处理；
其他格式，必须；

说明：request的body部分的数据编码格式由header部分的Content-Type指定；

GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。
在后端的同一个接收方法里，@RequestBody 与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。

注:一个请求，只有一个RequestBody;一个请求，可以有多个RequestParam

注:当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、数组、集合、对象等等(即:当，@RequestBody 与@RequestParam()可以同时使用时，原SpringMVC接收参数的机制不变，只不过RequestBody 接收的是请求体里面的数据；而RequestParam接收的是key-value里面的参数，所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。

即:如果参数时放在请求体中，传入后台的话，那么后台要用@RequestBody才能接收到;如果不是放在请求体中的话，那么后台接收前台传过来的参数时，要用@RequestParam（）来接收，或则形参前什么也不写也能接收。

注:如果参数前写了@RequestParam(xxx)，那么前端必须有对应的xxx名字才行(不管其是否有值)，如果没有xxx名的话，那么请求会出错，报400

注:如果参数前不写@RequestParam(xxx)的话，那么就前端可以有可以没有对应的xxx名字才行，如果有xxx名的话，那么就会自动匹配；没有的话，请求也能正确发送。

追注:这里与feign消费服务时不同；feign消费服务时，如果参数前什么也不写，那么会被默认是@RequestBody的

注:如果后端参数是一个对象，且该参数前是以@RequestBody修饰的，那么前端传递json参数时，必须满足以下要求:

◎后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即:@RequestBody后面的类)时,
   会根据json字符  串中的key来匹配对应实体类的属性,如果匹配一致且json中的该key对应的值符合(或可转换为)
   实体类的对应属性的类型要求时,会调用实体类的setter方法将值赋给该属性,这一条我会在本节末尾详细分析，
   其他的都可简单略过,但是本文末的核心逻辑代码以及几个结论一定要看！即先判断JSON字符的key 和实体类的属性是否一致，如果一致，再判断key对应的值符合(或可转换为) 实体类的对应属性的类型

◎json字符串中，如果value为""的话，后端对应属性如果是String类型的，那么接受到的就是"",如果是后端属性的
类型是Integer、Double等类型，那么接收到的就是null。

◎json字符串中，如果value为null的话，后端对应收到的就是null。

◎如果某个参数没有value的话，在传json字符串给后端时，要么干脆就不把该字段写到json字符串中;要么写value时，
必须有值，null 或""都行。千万不能有类似"stature":,这样的写法，如:

注:关于@RequestParam()的用法，这里就不再一一说明了，可详见《程序员成长笔记(一)》中的相关章节。

声明:以下代码为图片版，项目代码托管在https://github.com/JustryDeng/PublicRepository

示例详细说明:

先给出两个等下要用到的实体类

User实体类:

Team实体类:

@RequestBody以map接收前端传过来的json数据

       var jsonObj = {"openid":"xxx","username":"Ed sheeran","password":"123"};
          /*
              Jquery默认Content-Type为application/x-www-form-urlencoded类型
           */
          $.ajax({
              type: 'POST',
              url: "/login",
              dataType: "json",
              data: JSON.stringify(jsonObj),
              contentType : "application/json",
              success: function(data) {
                  console.log(data)
              },
              error: function() {
                  console.log("fucking error")
              }
          });

@Controller
public class LoginController {
  @PostMapping("/login")
  public void login(@RequestBody Map<String,Object> map){
      System.err.println(map.get("username"));
      System.err.println(map.get("password"));
      System.err.println(map.get("openid"));
}
}

@RequestBody直接以String接收前端传过来的json数据

后端对应的Controller:

使用PostMan测试:

@RequestBody以简单对象接收前端传过来的json数据

后端对应的Controller:

使用PostMan测试:

@RequestBody以复杂对象接收前端传过来的json数据

后端对应的Controller:

使用PostMan测试:

@RequestBody与简单的@RequestParam()同时使用

后端对应的Controller:

使用PostMan测试:

@RequestBody与复杂的@RequestParam()同时使用

后端对应的Controller:

使用PostMan测试:

@RequestBody接收请求体中的json数据;不加注解接收URL中的数据并组装为对象

后端对应的Controller:

使用PostMan测试:

注:如果在后端方法参数前，指定了@RequestParam()的话，那么前端必须要有对应字段才行，否者会报错;如果参数前没有任何该注解，那么前端可以传，也可以不传

如:

中，如果我们传参中没有指定token,那么请求能正常进去，但是token为null；如果在String token前指定了@RequestParam(“token”),那么前端必须要有token这个键时，请求才能正常进去，否者报400错误。

@RequestBody与前端传过来的json数据的匹配规则

声明:根据不同的Content-Type等情况,Spring-MVC会采取不同的HttpMessageConverter实现来进行信息转换解析。

下面介绍的是最常用的:前端以Content-Type 为application/json,传递json字符串数据;后端以@RequestBody

模型接收数据的情况。

解析json数据大体流程概述

Http传递请求体信息,最终会被封装进com.fasterxml.jackson.core.json.UTF8StreamJsonParser中(提

示:Spring采用CharacterEncodingFilter设置了默认编码为UTF-8。),然后在

public class BeanDeserializer extends BeanDeserializerBase implements java.io.Serializable中,

通过 public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws IOException

方法进行解析。

假设前端传的json串是这样的: {"name1":"邓沙利文","age":123,"mot":"我是一只小小小小鸟~"} 后对的模型只有name和age属性,以及对应的setter/getter方法;给出一般用到的deserializeFromObject(JsonParser p, DeserializationContext ctxt)方法的

核心逻辑