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


推荐阅读
  • 深入解析SpringMVC核心组件:DispatcherServlet的工作原理
    本文详细探讨了SpringMVC的核心组件——DispatcherServlet的运作机制,旨在帮助有一定Java和Spring基础的开发人员理解HTTP请求是如何被映射到Controller并执行的。文章将解答以下问题:1. HTTP请求如何映射到Controller;2. Controller是如何被执行的。 ... [详细]
  • Explore a common issue encountered when implementing an OAuth 1.0a API, specifically the inability to encode null objects and how to resolve it. ... [详细]
  • 本文详细介绍了如何在Linux系统上安装和配置Smokeping,以实现对网络链路质量的实时监控。通过详细的步骤和必要的依赖包安装,确保用户能够顺利完成部署并优化其网络性能监控。 ... [详细]
  • 本文详细介绍了如何使用 Yii2 的 GridView 组件在列表页面实现数据的直接编辑功能。通过具体的代码示例和步骤,帮助开发者快速掌握这一实用技巧。 ... [详细]
  • 深入解析 Spring Security 用户认证机制
    本文将详细介绍 Spring Security 中用户登录认证的核心流程,重点分析 AbstractAuthenticationProcessingFilter 和 AuthenticationManager 的工作原理。通过理解这些组件的实现,读者可以更好地掌握 Spring Security 的认证机制。 ... [详细]
  • Startup 类配置服务和应用的请求管道。Startup类ASP.NETCore应用使用 Startup 类,按照约定命名为 Startup。 Startup 类:可选择性地包括 ... [详细]
  • 本文介绍了如何使用JavaScript的Fetch API与Express服务器进行交互,涵盖了GET、POST、PUT和DELETE请求的实现,并展示了如何处理JSON响应。 ... [详细]
  • 本文详细介绍 Go+ 编程语言中的上下文处理机制,涵盖其基本概念、关键方法及应用场景。Go+ 是一门结合了 Go 的高效工程开发特性和 Python 数据科学功能的编程语言。 ... [详细]
  • 在前两篇文章中,我们探讨了 ControllerDescriptor 和 ActionDescriptor 这两个描述对象,分别对应控制器和操作方法。本文将基于 MVC3 源码进一步分析 ParameterDescriptor,即用于描述 Action 方法参数的对象,并详细介绍其工作原理。 ... [详细]
  • ASP.NET MVC中Area机制的实现与优化
    本文探讨了在ASP.NET MVC框架中,如何通过Area机制有效地组织和管理大规模应用程序的不同功能模块。通过合理的文件夹结构和命名规则,开发人员可以更高效地管理和扩展项目。 ... [详细]
  • 深入解析 Apache Shiro 安全框架架构
    本文详细介绍了 Apache Shiro,一个强大且灵活的开源安全框架。Shiro 专注于简化身份验证、授权、会话管理和加密等复杂的安全操作,使开发者能够更轻松地保护应用程序。其核心目标是提供易于使用和理解的API,同时确保高度的安全性和灵活性。 ... [详细]
  • Struts与Spring框架的集成指南
    本文详细介绍了如何将Struts和Spring两个流行的Java Web开发框架进行整合,涵盖从环境配置到代码实现的具体步骤。 ... [详细]
  • 本文作者分享了在阿里巴巴获得实习offer的经历,包括五轮面试的详细内容和经验总结。其中四轮为技术面试,一轮为HR面试,涵盖了大量的Java技术和项目实践经验。 ... [详细]
  • Java项目分层架构设计与实践
    本文探讨了Java项目中应用分层的最佳实践,不仅介绍了常见的三层架构(Controller、Service、DAO),还深入分析了各层的职责划分及优化建议。通过合理的分层设计,可以提高代码的可维护性、扩展性和团队协作效率。 ... [详细]
  • ssm框架整合及工程分层1.先创建一个新的project1.1配置pom.xml ... [详细]
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社区 版权所有