@RequestParam 和 @RequestBody的区别
一、问题重现
1. 项目简介
使用Postman测试后台接口,后台是使用SpringBoot搭建的SSM项目。
SpringBoot 版本:2.2.6
前后台数据交互格式:json
2. 问题
Postman
请求头,填写token信息,以及指定类型tent-Type
请求体,指定JSON格式,填写JSON格式的数据
后台接口
@ApiOperation("注册生产模型接口API_step1,提交模型基本信息")
@PostMapping(value="models", produces="application/json;charset=UTF-8", consumes = "application/json")
public String registerProductModel_step1(
@RequestParam(value = "model_desc", required = false) String modelDesc,
@RequestParam(value = "region", required = true) String region,
@RequestParam(value = "user", required = true) String user ){
return this.productService.registerProductModelSubmitBasicInfo(modelDesc, region, user).toString();
}
报错
Postman报错核心信息
"message": "Required String parameter 'region' is not present"
后台Console
Resolved [org.springframework.web.bind.MissingServletRequestParameterException: Required String parameter 'region' is not present]
报错信息:必要的String类型的region参数不存在!浏览了很多帖子,在一个问答帖子中,有这样一条评论:“没明确@RequestParam和@RequestBody的区别!”。
二、SpringMVC中的@RequestParam和@RequestBody
1. Http请求报文
2. 结论
@RequestParam:获取非请求体的数据
@RequestBody:获取请求体的json数据
3. 验证
修改上面Postman的请求url,127.0.0.1:8888/product/models修改为
127.0.0.1:8888/product/models ?regionCLINDER
报错信息:
"message": "Required String parameter 'user' is not present"
参数region被注解@RequestParam获取
三、修改
1. 使用@RequestBody注解替换之前的@RequestParam
@ApiOperation("注册生产模型接口API_step1,提交模型基本信息")
@PostMapping(value="models", produces="application/json;charset=UTF-8", consumes = "application/json")
public String registerProductModel_step1(
@RequestBody(required = false) String modelDesc,
@RequestBody String region,
@RequestBody String user){
return this.productService.registerProductModelSubmitBasicInfo(modelDesc, region, user).toString();
}
再次报错,报错核心信息:
"message": "Required request body is missing: public java.lang.String
com.autoepacs.production.api.controller.ProductController.registerProductModel_step1(java.lang.String,java.lang.String,java.lang.String)"
找不到必需的请求体!
2. 一个实体类的对象替换三个参数
@ApiOperation("注册生产模型接口API_step1,提交模型基本信息")
@PostMapping(value="models", produces="application/json;charset=UTF-8", consumes = "application/json")
public String registerProductModel_step1(@RequestBody ReturnModel returnModel) {
return this.productService.registerProductModelSubmitBasicInfo(returnModel).toString();
}
3. 成功
成功响应的响应体,JSON格式
{
"error_code": 200,
"error_msg": "成功",
"log_id": 85150474,
"model_id": 1274452942,
"region": "AIRINLET",
"time": 1588232718615,
"user": "zhaocy"
}
四、总结
@RequestParam用来处理请求头的数据
用来处理请求头Content-Type为application/x-www-form-urlencoded(浏览器的原生form表单)编码的内容。(Http协议中,如果不指定Content-Type,则默认传递的参数就是application/x-www-form-urlencoded类型。)
@RequestBody用来处理请求体的数据(JSON格式的数据)
用来处理请求头Content-Type为 application/json编码的内容,明确的告诉服务器发送的内容是json数据。
在后端的同一个接收方法里,@RequestBody 与@RequestParam()可以同时使用。
一次请求,只有一个RequestBody。
@RequestBody的作用:将请求体中的json数据映射到当前对象中。从设计上来说,SpringMVC一旦获取到请求体后,后续再次获取没有意义。
一次请求,可以有多个RequestParam。
@RequesParam的作用:获取请求头中的参数,获取url中的参数;请求头中的参数和url拼接的参数可以有多个,所以也可以有多个RequesParam。
结论部分参考链接:@requestBody注解的使用(下).