欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

@RequestBody 及 @RequestParam详解

程序员文章站 2022-03-19 23:45:01
...

客户端请求消息

介绍之前,我们首先简单看一下http请求,下面是客户端发送一个请求到服务器的请求消息包括以下格式:

@RequestBody 及 @RequestParam详解

主要包含请求行、请求头、请求体三个部分。

  • 请求行:以一个方法符号开头,以空格分开,后面跟着请求的URI和协议的版本
  • 请求头:紧接着请求行(即第一行)之后的部分,用来说明服务器要使用的附加信息
  • 请求体:请求体即请求数据,可以添加任意的其他数据发送给服务器

@RequestBody

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的),GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交。

同时使用@RequestBody 可以从前端向后端传递一个对象,下面是SpringMVC文档中的介绍

@RequestBody 及 @RequestParam详解

显然,通过使用@RequestBody可以将前端传递的JSON格式字符串通过HttpMessageConverter反序列化,在后端将其转化成为我们想要的对象形式。

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

  1. 后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即:@RequestBody后面的类)时,会根据json字符串中的key来匹配对应实体类的属性,如果匹配一致且json中的该key对应的值符合(或可转换为),具体可参考下面的代码逻辑
  2. json字符串中,如果value为"“的话,后端对应属性如果是String类型的,那么接受到的就是”",如果是后端属性的类型是Integer、Double等类型,那么接收到的就是null。
  3. json字符串中,如果value为null的话,后端对应收到的就是null。
  4. 如果某个参数没有value的话,在传json字符串给后端时,要么干脆就不把该字段写到json字符串中;要么写value时, 必须有值,null 或""都行。千万不可有下图所示写法

@RequestBody 及 @RequestParam详解

根据不同的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)方法的核心逻辑:

@RequestBody 及 @RequestParam详解

@RequestParam

如官网中所示的那样,@RequestParam直接用于读取请求中带的参数(form表单所提交的参数或者或者http请求中所带的参数)
@RequestBody 及 @RequestParam详解

SpringMVC 代码如下:

    @RequestMapping(value = "/list.myTest", method = {RequestMethod.POST, RequestMethod.GET})
    @ResponseBody
    public String edit(@RequestParam int id, String jsonData){
        try{

            ActivityTmpEntity activityTmpEntity = new ActivityTmpEntity();
            activityTmpEntity.setJsonData(jsonData);
            activityTmpEntity.setId((long)id);
            System.out.println(activityTmpEntity);
            activityTmpService.edit(activityTmpEntity);
            return "success";

        } catch (Exception e){
            return "error ";
        }
    }

如上代码所示,方法edit要求参数 idjsonData

1、在Request 请求中加入参数如下:
Get http://localhost:8080/actTemplate/list.myTest?id=16&jsonData=测试1

@RequestBody 及 @RequestParam详解

请求成功!

2、在Post请求的form表单中加入数据
@RequestBody 及 @RequestParam详解

请求成功!!!

但是RquestParam需要注意一下两点:

  1. 如果参数前写了@RequestParam(xxx),那么前端必须有对应的xxx名字才行(不管其是否有值,当然可以通过设置该注解的required属性来调节是否必须传),如果没有xxx名的话,那么请求会出错,报400。
  2. 如果参数前不写@RequestParam(xxx)的话,那么就前端可以有可以没有对应的xxx名字才行,如果有xxx名的话,那么就会自动匹配;没有的话,请求也能正确发送。

@RequestBody与@RequestParam()可以同时使用,@RequestBody最多只能有一个,而@RequestParam()可以有多个。

参考https://blog.csdn.net/justry_deng/article/details/80972817#commentBox