热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

深入理解@RequestBody及其应用

本文深入探讨了@RequestBody注解的使用场景及核心逻辑,包括其与@RequestParam的区别和结合使用的方法。文章前半部分介绍了基础知识,后半部分则详细分析了源码和重要结论。

提示:强烈建议阅读本文关于@RequestBody核心逻辑的源码分析及六个关键结论!前半部分内容为基础知识,可根据需要跳过。

声明:本文基于Spring Boot框架进行讲解。

基础知识概览:

@RequestBody主要用于接收前端通过POST方法发送的JSON数据(请求体中的数据)。GET请求由于没有请求体,因此不能使用@RequestBody接收数据。在同一接收方法中,@RequestBody和@RequestParam可以同时使用,但@RequestBody只能出现一次,而@RequestParam可以多次出现。

注意:每个请求仅有一个RequestBody,但可以有多个RequestParam。当同时使用@RequestParam和@RequestBody时,RequestParam可以接收普通元素、数组、集合、对象等。如果参数位于请求体中,需用@RequestBody接收;若不在请求体中,则用@RequestParam接收或省略注解。

如果参数前有@RequestParam注解,前端必须提供相应的名称(无论是否有值),否则请求将返回400错误。若未使用@RequestParam注解,前端可以提供也可以不提供相应名称,存在时自动匹配,不存在时请求仍可成功。

当后端参数为对象且使用@RequestBody修饰时,前端传递的JSON数据需满足以下条件:

  • 后端将HTTP输入流中的数据映射到目标类时,依据JSON中的键匹配实体类属性。如果键值对符合或可转换为目标类型,将调用setter方法赋值。
  • JSON中的值为空字符串时,后端对应属性为String类型则接收空字符串,为Integer、Double等数值类型则接收null。
  • JSON中的值为null时,后端接收到的也是null。
  • 若某参数无值,应确保JSON中不包含该字段,或确保其值为null或空字符串。

示例详解:

首先展示两个用于示例的实体类:User和Team。

@RequestBody直接接收前端传来的JSON数据示例:

后端Controller代码示例:

使用Postman进行测试:

@RequestBody接收简单对象示例:

后端Controller代码示例:

使用Postman进行测试:

@RequestBody接收复杂对象示例:

后端Controller代码示例:

使用Postman进行测试:

@RequestBody与@RequestParam同时使用示例:

后端Controller代码示例:

使用Postman进行测试:

@RequestBody接收请求体中的JSON数据,不加注解接收URL中的数据并组装为对象示例:

后端Controller代码示例:

使用Postman进行测试:

注意:如果后端方法参数前有@RequestParam注解,前端必须提供相应的字段,否则会报400错误;若无此注解,前端可选提供字段。

@RequestBody与前端JSON数据的匹配规则:

声明:根据不同的Content-Type,Spring MVC会选择不同的HttpMessageConverter实现进行数据转换。本文讨论的是前端以application/json类型传递JSON数据,后端使用@RequestBody接收的情况。

解析JSON数据的大致流程为:HTTP请求体信息被封装进UTF8StreamJsonParser中,然后通过BeanDeserializer类中的deserializeFromObject方法进行解析。

核心逻辑分析示例:

假设前端传递的JSON字符串为{"name1":"邓沙利文","age":123,"mot":"我是一只小小小小鸟~"},后端模型只有name和age属性。以下是deserializeFromObject方法的核心逻辑示例:

小技巧:指定模型属性对应的JSON键:

这里简要介绍如何使用@JsonAlias和@JsonProperty注解来指定模型属性对应的JSON键。更多细节请参考相关文档。

Controller中的测试类示例:

模型属性示例:

使用Postman进行测试:

全面结论:

结论①:@JsonAlias注解允许JSON中的特定键转换为模型的特定属性,但模型转JSON时,键名保持与属性名一致。

结论②:@JsonProperty注解不仅允许JSON中的特定键转换为模型的特定属性,而且模型转JSON时,键名也会转换为指定的名称。

结论③:@JsonAlias注解依赖于setter和getter方法,而@JsonProperty注解不依赖。

结论④:在不使用上述注解的情况下,默认键名与属性名匹配时大小写敏感。

结论⑤:若JSON中有多个相同键,转换为模型时,最后一个键的值会被保留。

结论⑥:后端@RequestBody注解对应的类在将HTTP输入流中的数据映射到目标类时,会根据JSON中的键匹配实体类属性,并调用setter方法赋值。

如有不当之处,欢迎指正

代码托管链接:https://github.com/JustryDeng...RequestBody...


推荐阅读
  • 使用 ModelAttribute 实现页面数据自动填充
    本文介绍了如何利用 Spring MVC 中的 ModelAttribute 注解,在页面跳转后自动填充表单数据。主要探讨了两种实现方法及其背后的原理。 ... [详细]
  • 本文介绍了如何处理在使用 aiohttp 进行 HTTPS 请求时遇到的 SSL 证书验证错误,包括忽略证书验证和使用自定义证书的方法。 ... [详细]
  • 本文详细介绍了C++标准模板库(STL)中各容器的功能特性,并深入探讨了不同容器操作函数的异常安全性。 ... [详细]
  • 本文通过一个具体的用户管理项目,详细介绍如何使用Spring MVC框架进行开发。从用户实体类的设计到控制器的实现,再到视图层的展示,全面解析Spring MVC的核心功能与实现细节。 ... [详细]
  • MVC框架下使用DataGrid实现时间筛选与枚举填充
    本文介绍如何在ASP.NET MVC项目中利用DataGrid组件增强搜索功能,具体包括使用jQuery UI的DatePicker插件添加时间筛选条件,并通过枚举数据填充下拉列表。 ... [详细]
  • 使用MonkeyTalk实现Android自动化测试的Agent配置
    本文详细介绍了在MonkeyTalk框架下设置Android Agent的具体步骤,包括如何将Android项目转换为AspectJ项目,以及如何正确配置和集成MonkeyTalk的Agent库。 ... [详细]
  • 本文探讨了在iOS应用中实现类似Android Snack Bar功能的方法,并特别关注如何确保Snack Bar正确显示在键盘下方。 ... [详细]
  • SQL注入实验:SqliLabs第38至45关解析
    本文深入探讨了SqliLabs项目中的第38至45关,重点讲解了堆叠注入(Stacked Queries)的应用技巧及防御策略。通过实际案例分析,帮助读者理解如何利用和防范此类SQL注入攻击。 ... [详细]
  • 本文档详细介绍了Robot Framework的基础知识、安装配置方法及其实用技巧。从环境搭建到编写第一个测试用例,涵盖了一系列实用的操作指南和最佳实践。 ... [详细]
  • 本文介绍了如何在三台CentOS 7.5虚拟机上通过Docker部署RabbitMQ集群,包括环境准备、容器创建、集群配置及故障处理等内容。 ... [详细]
  • 本文详细探讨了在Windows Server 2003环境下遇到MySQL连接失败(错误代码10061)的解决方案,包括通过卸载特定的Windows更新和调整系统注册表设置的方法。 ... [详细]
  • 首先说一下,这是我在CSDN上的第一个文章,其实这个账号早在几年前就申请了,不过当时只是为了下载一个资源,而且也不怎么懂信息技术相关的领域,后来就再也没怎么动过,直到今天我才开始使用这个账号 ... [详细]
  • 本文探讨了缓存系统中的两个关键问题——缓存穿透与缓存失效时的雪崩效应,以及这些问题的解决方案。此外,文章还介绍了数据处理、数据库拆分策略、缓存优化、拆分策略、应用架构演进及通信协议的选择等内容。 ... [详细]
  • 本文旨在为初学者提供一个详细的指南,从零开始学习如何使用 ASP.NET MVC5 和 Entity Framework 6 (EF6) 搭建项目。通过逐步指导,帮助读者理解 MVC 架构的核心概念,并掌握基本的操作方法。 ... [详细]
  • 20款必备PS插件免费大放送,附详细安装指南
    对于众多关注小资源并学习PS的用户来说,每次分享设计素材都会收到大量反馈。为了更好地满足大家的需求,今天我们特别推出了20款必备的PS插件大合集,并附有详细的安装指南,确保每位用户都能轻松上手,提升设计效率。 ... [详细]
author-avatar
_______王晓
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有