热门标签 | 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...


推荐阅读
  • Redux入门指南
    本文介绍Redux的基本概念和工作原理,帮助初学者理解如何使用Redux管理应用程序的状态。Redux是一个用于JavaScript应用的状态管理库,特别适用于React项目。 ... [详细]
  • golang常用库:配置文件解析库/管理工具viper使用
    golang常用库:配置文件解析库管理工具-viper使用-一、viper简介viper配置管理解析库,是由大神SteveFrancia开发,他在google领导着golang的 ... [详细]
  • 深入解析SpringMVC核心组件:DispatcherServlet的工作原理
    本文详细探讨了SpringMVC的核心组件——DispatcherServlet的运作机制,旨在帮助有一定Java和Spring基础的开发人员理解HTTP请求是如何被映射到Controller并执行的。文章将解答以下问题:1. HTTP请求如何映射到Controller;2. Controller是如何被执行的。 ... [详细]
  • springMVC JRS303验证 ... [详细]
  • Explore a common issue encountered when implementing an OAuth 1.0a API, specifically the inability to encode null objects and how to resolve it. ... [详细]
  • Java 中 Writer flush()方法,示例 ... [详细]
  • Java 中的 BigDecimal pow()方法,示例 ... [详细]
  • 本文详细介绍了Java中org.eclipse.ui.forms.widgets.ExpandableComposite类的addExpansionListener()方法,并提供了多个实际代码示例,帮助开发者更好地理解和使用该方法。这些示例来源于多个知名开源项目,具有很高的参考价值。 ... [详细]
  • 本文详细介绍了Java编程语言中的核心概念和常见面试问题,包括集合类、数据结构、线程处理、Java虚拟机(JVM)、HTTP协议以及Git操作等方面的内容。通过深入分析每个主题,帮助读者更好地理解Java的关键特性和最佳实践。 ... [详细]
  • XNA 3.0 游戏编程:从 XML 文件加载数据
    本文介绍如何在 XNA 3.0 游戏项目中从 XML 文件加载数据。我们将探讨如何将 XML 数据序列化为二进制文件,并通过内容管道加载到游戏中。此外,还会涉及自定义类型读取器和写入器的实现。 ... [详细]
  • Android LED 数字字体的应用与实现
    本文介绍了一种适用于 Android 应用的 LED 数字字体(digital font),并详细描述了其在 UI 设计中的应用场景及其实现方法。这种字体常用于视频、广告倒计时等场景,能够增强视觉效果。 ... [详细]
  • ssm框架整合及工程分层1.先创建一个新的project1.1配置pom.xml ... [详细]
  • Spring Boot 中静态资源映射详解
    本文深入探讨了 Spring Boot 如何简化 Web 应用中的静态资源管理,包括默认的静态资源映射规则、WebJars 的使用以及静态首页的处理方法。通过本文,您将了解如何高效地管理和引用静态资源。 ... [详细]
  • SpringMVC RestTemplate的几种请求调用(转)
    SpringMVCRestTemplate的几种请求调用(转),Go语言社区,Golang程序员人脉社 ... [详细]
  • 本文档汇总了Python编程的基础与高级面试题目,涵盖语言特性、数据结构、算法以及Web开发等多个方面,旨在帮助开发者全面掌握Python核心知识。 ... [详细]
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社区 版权所有