爆款云主机2核4G限时秒杀,88元/年起!
查看详情

活动

天翼云最新优惠活动,涵盖免费试用,产品折扣等,助您降本增效!
热门活动
  • 618智算钜惠季 爆款云主机2核4G限时秒杀,88元/年起!
  • 免费体验DeepSeek,上天翼云息壤 NEW 新老用户均可免费体验2500万Tokens,限时两周
  • 云上钜惠 HOT 爆款云主机全场特惠,更有万元锦鲤券等你来领!
  • 算力套餐 HOT 让算力触手可及
  • 天翼云脑AOne NEW 连接、保护、办公,All-in-One!
  • 中小企业应用上云专场 产品组合下单即享折上9折起,助力企业快速上云
  • 息壤高校钜惠活动 NEW 天翼云息壤杯高校AI大赛,数款产品享受线上订购超值特惠
  • 天翼云电脑专场 HOT 移动办公新选择,爆款4核8G畅享1年3.5折起,快来抢购!
  • 天翼云奖励推广计划 加入成为云推官,推荐新用户注册下单得现金奖励
免费活动
  • 免费试用中心 HOT 多款云产品免费试用,快来开启云上之旅
  • 天翼云用户体验官 NEW 您的洞察,重塑科技边界

智算服务

打造统一的产品能力,实现算网调度、训练推理、技术架构、资源管理一体化智算服务
智算云(DeepSeek专区)
科研助手
  • 算力商城
  • 应用商城
  • 开发机
  • 并行计算
算力互联调度平台
  • 应用市场
  • 算力市场
  • 算力调度推荐
一站式智算服务平台
  • 模型广场
  • 体验中心
  • 服务接入
智算一体机
  • 智算一体机
大模型
  • DeepSeek-R1-昇腾版(671B)
  • DeepSeek-R1-英伟达版(671B)
  • DeepSeek-V3-昇腾版(671B)
  • DeepSeek-R1-Distill-Llama-70B
  • DeepSeek-R1-Distill-Qwen-32B
  • Qwen2-72B-Instruct
  • StableDiffusion-V2.1
  • TeleChat-12B

应用商城

天翼云精选行业优秀合作伙伴及千余款商品,提供一站式云上应用服务
进入甄选商城进入云市场创新解决方案
办公协同
  • WPS云文档
  • 安全邮箱
  • EMM手机管家
  • 智能商业平台
财务管理
  • 工资条
  • 税务风控云
企业应用
  • 翼信息化运维服务
  • 翼视频云归档解决方案
工业能源
  • 智慧工厂_生产流程管理解决方案
  • 智慧工地
建站工具
  • SSL证书
  • 新域名服务
网络工具
  • 翼云加速
灾备迁移
  • 云管家2.0
  • 翼备份
资源管理
  • 全栈混合云敏捷版(软件)
  • 全栈混合云敏捷版(一体机)
行业应用
  • 翼电子教室
  • 翼智慧显示一体化解决方案

合作伙伴

天翼云携手合作伙伴,共创云上生态,合作共赢
天翼云生态合作中心
  • 天翼云生态合作中心
天翼云渠道合作伙伴
  • 天翼云代理渠道合作伙伴
天翼云服务合作伙伴
  • 天翼云集成商交付能力认证
天翼云应用合作伙伴
  • 天翼云云市场合作伙伴
  • 天翼云甄选商城合作伙伴
天翼云技术合作伙伴
  • 天翼云OpenAPI中心
  • 天翼云EasyCoding平台
天翼云培训认证
  • 天翼云学堂
  • 天翼云市场商学院
天翼云合作计划
  • 云汇计划
天翼云东升计划
  • 适配中心
  • 东升计划
  • 适配互认证

开发者

开发者相关功能入口汇聚
技术社区
  • 专栏文章
  • 互动问答
  • 技术视频
资源与工具
  • OpenAPI中心
开放能力
  • EasyCoding敏捷开发平台
培训与认证
  • 天翼云学堂
  • 天翼云认证
魔乐社区
  • 魔乐社区

支持与服务

为您提供全方位支持与服务,全流程技术保障,助您轻松上云,安全无忧
文档与工具
  • 文档中心
  • 新手上云
  • 自助服务
  • OpenAPI中心
定价
  • 价格计算器
  • 定价策略
基础服务
  • 售前咨询
  • 在线支持
  • 在线支持
  • 工单服务
  • 建议与反馈
  • 用户体验官
  • 服务保障
  • 客户公告
  • 会员中心
增值服务
  • 红心服务
  • 首保服务
  • 客户支持计划
  • 专家技术服务
  • 备案管家

了解天翼云

天翼云秉承央企使命,致力于成为数字经济主力军,投身科技强国伟大事业,为用户提供安全、普惠云服务
品牌介绍
  • 关于天翼云
  • 智算云
  • 天翼云4.0
  • 新闻资讯
  • 天翼云APP
基础设施
  • 全球基础设施
  • 信任中心
最佳实践
  • 精选案例
  • 超级探访
  • 云杂志
  • 分析师和白皮书
  • 天翼云·创新直播间
市场活动
  • 2025智能云生态大会
  • 2024智算云生态大会
  • 2023云生态大会
  • 2022云生态大会
  • 天翼云中国行
天翼云
  • 活动
  • 智算服务
  • 产品
  • 解决方案
  • 应用商城
  • 合作伙伴
  • 开发者
  • 支持与服务
  • 了解天翼云
      • 文档
      • 控制中心
      • 备案
      • 管理中心

      结合参数接收响应转换原理讲解SpringBoot常用注解

      首页 知识中心 软件开发 文章详情页

      结合参数接收响应转换原理讲解SpringBoot常用注解

      2023-06-14 09:11:31 阅读次数:103

      Spring,SpringBoot,web

      一、常用注解回顾

      1.1 @RequestBody与@ResponseBody

      
      //注意并不要求@RequestBody与@ResponseBody成对使用。
      public @ResponseBody  AjaxResponse saveArticle(@RequestBody ArticleVO article)
      
      

      如上代码所示:

      • @RequestBody修饰请求参数,注解用于接收HTTP的body,默认是使用JSON的格式
      • @ResponseBody修饰返回值,注解用于在HTTP的body中携带响应数据,默认是使用JSON的格式。如果不加该注解,spring响应字符串类型,是跳转到模板页面或jsp页面的开发模式。说白了:加上这个注解你开发的是一个数据接口,不加这个注解你开发的是一个页面跳转控制器。

      那么我们有一个问题:如果我们想接收或XML数据该怎么办?我们想响应excel的数据格式该怎么办?我们后文来回答这个问题。

      1.2. @RequestMapping注解

      @RequestMapping注解是所有常用注解中,最有看点的一个注解,用于标注HTTP服务端点。它的很多属性对于丰富我们的应用开发方式方法,都有很重要的作用。如:

      • value: 应用请求端点,最核心的属性,用于标志请求处理方法的唯一性;
      • method: HTTP协议的method类型, 如:GET、POST、PUT、DELETE等;
      • consumes: HTTP协议请求内容的数据类型(Content-Type),例如application/json, text/html;
      • produces: HTTP协议响应内容的数据类型。下文会详细讲解。
      • params: HTTP请求中必须包含某些参数值的时候,才允许被注解标注的方法处理请求。
      • headers: HTTP请求中必须包含某些指定的header值,才允许被注解标注的方法处理请求。
      
      @RequestMapping(value = "/article", method = POST)
      @PostMapping(value = "/article")
      
      

      上面代码中两种写法起到的是一样的效果,也就是PostMapping等同于@RequestMapping的method等于POST。同理:@GetMapping、@PutMapping、@DeleteMapping也都是简写的方式。

      1.3. @RestController与@Controller

      @Controller注解是开发中最常使用的注解,它的作用有两层含义:

      • 一是告诉Spring,被该注解标注的类是一个Spring的Bean,需要被注入到Spring的上下文环境中。
      • 二是该类里面所有被RequestMapping标注的注解都是HTTP服务端点。

      @RestController相当于 @Controller和@ResponseBody结合。它有两层含义:

      • 一是作为Controller的作用,将控制器类注入到Spring上下文环境,该类RequestMapping标注方法为HTTP服务端点。
      • 二是作为ResponseBody的作用,请求响应默认使用的序列化方式是JSON,而不是跳转到jsp或模板页面。

      1.4. @PathVariable 与@RequestParam

      PathVariable用于URI上的{参数},如下方法用于删除一篇文章,其中id为文章id。如:我们的请求URL为“/article/1”,那么将匹配DeleteMapping并且PathVariable接收参数id=1。而RequestParam用于接收普通表单方式或者ajax模拟表单提交的参数数据。

      @DeleteMapping("/article/{id}")
      public @ResponseBody AjaxResponse deleteArticle(@PathVariable Long id) {
      
      @PostMapping("/article")
      public @ResponseBody AjaxResponse deleteArticle(@RequestParam Long id) {
      

      二、接收复杂嵌套对象参数

      有一些朋友可能还无法理解RequestBody注解存在的真正意义,表单数据提交用RequestParam就好了,为什么还要搞出来一个RequestBody注解呢?RequestBody注解的真正意义在于能够使用对象或者嵌套对象接收前端数据。

      结合参数接收响应转换原理讲解SpringBoot常用注解

      仔细看上面的代码,是一个paramData对象里面包含了一个bestFriend对象。这种数据结构使用RequestParam就无法接收了,RequestParam只能接收平面的、一对一的参数。像上文中这种数据结构的参数,就需要我们在java服务端定义两个类,一个类是ParamData,一个类是BestFriend.

      public class ParamData {
          private String name;
          private int id;
          private String phone;
          private BestFriend bestFriend;
          
          public static class BestFriend {
              private String address;
              private String sex;
          }
      }
      
      • 注意上面代码中省略了GET、SET方法等必要的java plain model元素。
      • 注意成员变量名称一定要和JSON属性名称对应上。
      • 注意接收不同类型的参数,使用不同的成员变量类型

      完成以上动作,我们就可以使用@RequestBody ParamData paramData,一次性的接收以上所有的复杂嵌套对象参数了,参数对象的所有属性都将被赋值。

      三、Http数据转换的原理

      大家现在使用JSON都比较普遍了,其方便易用、表达能力强,是绝大部分数据接口式应用的首选。那么如何响应其他的类型的数据?其中的判别原理又是什么?下面就来给大家介绍一下:

      结合参数接收响应转换原理讲解SpringBoot常用注解

      • 当一个HTTP请求到达时是一个InputStream,通过HttpMessageConverter转换为java对象,从而进行参数接收。
      • 当对一个HTTP请求进行响应时,我们首先输出的是一个java对象,然后由HttpMessageConverter转换为OutputStream输出。

      当我们在Spring Boot应用中集成了jackson的类库之后,如下的一些HttpMessageConverter将会被加载。

      实现类 功能说明
      StringHttpMessageConverter 将请求信息转为字符串
      FormHttpMessageConverter 将表单数据读取到MultiValueMap中
      XmlAwareFormHttpMessageConverter 扩展与FormHttpMessageConverter,如果部分表单属性是XML数据,可用该转换器进行读取
      ResourceHttpMessageConverter 读写org.springframework.core.io.Resource对象
      BufferedImageHttpMessageConverter 读写BufferedImage对象
      ByteArrayHttpMessageConverter 读写二进制数据
      SourceHttpMessageConverter 读写java.xml.transform.Source类型的对象
      MarshallingHttpMessageConverter 通过Spring的org.springframework,xml.Marshaller和Unmarshaller读写XML消息
      Jaxb2RootElementHttpMessageConverter 通过JAXB2读写XML消息,将请求消息转换为标注的XmlRootElement和XmlType连接的类中
      MappingJacksonHttpMessageConverter 利用Jackson开源包的ObjectMapper读写JSON数据
      RssChannelHttpMessageConverter 读写RSS种子消息
      AtomFeedHttpMessageConverter 和RssChannelHttpMessageConverter能够读写RSS种子消息

      根据HTTP协议的Accept和Content-Type属性,以及参数数据类型来判别使用哪一种HttpMessageConverter。当使用RequestBody或ResponseBody时,再结合前端发送的Accept数据类型,会自动判定优先使用MappingJacksonHttpMessageConverter作为数据转换器。但是,不仅JSON可以表达对象数据类型,XML也可以。如果我们希望使用XML格式该怎么告知Spring呢,那就要使用到produces属性了。

      @GetMapping(value ="/demo",produces = MediaType.APPLICATION_XML_VALUE)
      

      这里我们明确的告知了返回的数据类型是xml,就会使用Jaxb2RootElementHttpMessageConverter作为默认的数据转换器。当然实现XML数据响应比JSON还会更复杂一些,还需要结合@XmlRootElement、@XmlElement等注解实体类来使用。同理consumes属性你是不是也会用了呢。

      四、自定义HttpMessageConverter

      其实绝大多数的数据格式都不需要我们自定义HttpMessageConverter,都有第三方类库可以帮助我们实现(包括下文代码中的Excel格式)。但有的时候,有些数据的输出格式并没有类似于Jackson这种类库帮助我们处理,需要我们自定义数据格式。该怎么做?下面代码只是帮助我们理解的一个例子,不要用于生产:

      @Service
      public class TeamToXlsConverter extends AbstractHttpMessageConverter<Team> {
      
          private static final MediaType EXCEL_TYPE = MediaType.valueOf("application/vnd.ms-excel");
      
          TeamToXlsConverter() {
              super(EXCEL_TYPE);
          }
      
          @Override
          protected Team readInternal(final Class<? extends Team> clazz, final HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
              return null;
          }
      
          @Override
          protected boolean supports(final Class<?> clazz) {
              return (Team.class == clazz);
          }
      
          @Override
          protected void writeInternal(final Team team, final HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
              try (final Workbook workbook = new HSSFWorkbook()) {
                  final Sheet sheet = workbook.createSheet();
                  int rowNo = 0;
                  for (final TeamMember member : team.getMembers()) {
                      final Row row = sheet.createRow(rowNo++);
                      row.createCell(0)
                         .setCellValue(member.getName());
                  }
                  workbook.write(outputMessage.getBody());
              }
          }
      }
      
      
      • 实现AbstractHttpMessageConverter接口
      • 指定该转换器是针对哪种数据格式的?如上文代码中的"application/vnd.ms-excel"
      • 指定该转换器针对那些对象数据类型?如上文代码中的supports函数
      • 使用writeInternal对数据进行输出处理,上例中是输出为Excel格式。
      版权声明:本文内容来自第三方投稿或授权转载,原文地址:https://www.cnblogs.com/zimug/p/11886850.html,作者:字母哥博客,版权归原作者所有。本网站转在其作品的目的在于传递更多信息,不拥有版权,亦不承担相应法律责任。如因作品内容、版权等问题需要同本网站联系,请发邮件至ctyunbbs@chinatelecom.cn沟通。

      上一篇:SpringMVC属性域【请求域、会话域、应用域】

      下一篇:Spring-data-jpa介绍

      相关文章

      2025-05-16 09:15:10

      52.介绍AOP有几种实现方式

      52.介绍AOP有几种实现方式

      2025-05-16 09:15:10
      gt , lt , Spring
      2025-05-14 10:02:58

      java项目多端数据同步解决方案

      多端数据同步是指在多个设备(例如桌面应用、移动应用、Web应用)之间保持数据的一致性。

      2025-05-14 10:02:58
      java , Spring , WebSocket , 同步 , 数据 , 版本号
      2025-05-12 10:19:12

      springboot学习(2)

      springboot学习(2)

      2025-05-12 10:19:12
      Java , main , springboot , web , 启动 , 方法 , 浏览器
      2025-05-09 08:50:35

      SpringBoot学习(1)

      Spring Boot是Spring提供的一个子项目,用于快速构建Spring应用程序。

      2025-05-09 08:50:35
      Spring , 依赖 , 应用程序 , 部署 , 配置 , 配置文件
      2025-05-09 08:20:32

      系统架构——Spring Framework

      Spring Framework 是 Spring 生态圈中最基础的项目。其它所有的项目的都是在它的基础上运行使用。

      2025-05-09 08:20:32
      AOP , Data , Spring , 学习 , 模块
      2025-05-06 09:19:51

      springboot系列教程(三十二):SpringBoot 教程之处理异步请求

      springboot系列教程(三十二):SpringBoot 教程之处理异步请求

      2025-05-06 09:19:51
      Spring , 异步 , 方法 , 返回值
      2025-05-06 09:19:12

      Spring多线程事务 能否保证事务的一致性(同时提交、同时回滚)?

      Spring的事务信息是存在ThreadLocal中的Connection, 所以一个线程永远只能有一个事务

      2025-05-06 09:19:12
      Spring , 事务 , 多线程 , 线程
      2025-04-22 09:28:19

      61. Spring事务传播行为实现原理

      61. Spring事务传播行为实现原理

      2025-04-22 09:28:19
      Spring , ThreadLocal , 事务
      2025-04-22 09:27:28

      SpringBoot 自定义TaskExecutor线程池执行异步操作

      SpringBoot 自定义TaskExecutor线程池执行异步操作

      2025-04-22 09:27:28
      SpringBoot , 异步 , 线程 , 自定义
      2025-04-18 07:10:30

      深入解析 Spring Security —— 打造高效安全的权限管理体系

      Spring Security 是一个专注于认证与授权的安全框架,致力于保护 Web 应用程序的资源安全。通过高度灵活的配置和模块化的设计,它能够满足各种复杂的安全需求。

      2025-04-18 07:10:30
      Security , Spring , 权限 , 用户 , 角色 , 认证 , 配置
      查看更多
      推荐标签

      作者介绍

      天翼云小翼
      天翼云用户

      文章

      33561

      阅读量

      5240454

      查看更多

      最新文章

      52.介绍AOP有几种实现方式

      2025-05-16 09:15:10

      java项目多端数据同步解决方案

      2025-05-14 10:02:58

      springboot学习(2)

      2025-05-12 10:19:12

      系统架构——Spring Framework

      2025-05-09 08:20:32

      springboot系列教程(三十二):SpringBoot 教程之处理异步请求

      2025-05-06 09:19:51

      Spring多线程事务 能否保证事务的一致性(同时提交、同时回滚)?

      2025-05-06 09:19:12

      查看更多

      热门文章

      SpringBoot 单元测试(三十六)

      2024-09-25 10:14:09

      Ajax提交数据SpringBoot后台报错“HttpMessageNotReadableException: JSON parse error: Cannot construct instance“

      2023-06-13 08:29:06

      AOP 中 获取常见的各种参数方法合集

      2023-05-15 10:01:00

      使用Spring的AOP时报错“ClassCastException: com.sun.proxy.$Proxy5 cannot be cast to com.demo.aop.Target“

      2023-06-14 09:12:07

      Ajax续

      2023-07-11 08:55:43

      Spring-AOP

      2023-05-25 14:43:25

      查看更多

      热门标签

      java Java python 编程开发 代码 开发语言 算法 线程 Python html 数组 C++ 元素 javascript c++
      查看更多

      相关产品

      弹性云主机

      随时自助获取、弹性伸缩的云服务器资源

      天翼云电脑(公众版)

      便捷、安全、高效的云电脑服务

      对象存储

      高品质、低成本的云上存储服务

      云硬盘

      为云上计算资源提供持久性块存储

      查看更多

      随机文章

      Spring Security Oauth2 RedisTokenStore 类图

      org.springframework.cache.interceptor.SimpleKey cannot be cast to java.lang.String

      SpringBoot 单元测试(三十六)

      Spring AOP简介

      利用Spring Boot实现微服务的灰度发布策略

      探索Java的新边疆:Quarkus与响应式编程

      • 7*24小时售后
      • 无忧退款
      • 免费备案
      • 专家服务
      售前咨询热线
      400-810-9889转1
      关注天翼云
      • 旗舰店
      • 天翼云APP
      • 天翼云微信公众号
      服务与支持
      • 备案中心
      • 售前咨询
      • 智能客服
      • 自助服务
      • 工单管理
      • 客户公告
      • 涉诈举报
      账户管理
      • 管理中心
      • 订单管理
      • 余额管理
      • 发票管理
      • 充值汇款
      • 续费管理
      快速入口
      • 天翼云旗舰店
      • 文档中心
      • 最新活动
      • 免费试用
      • 信任中心
      • 天翼云学堂
      云网生态
      • 甄选商城
      • 渠道合作
      • 云市场合作
      了解天翼云
      • 关于天翼云
      • 天翼云APP
      • 服务案例
      • 新闻资讯
      • 联系我们
      热门产品
      • 云电脑
      • 弹性云主机
      • 云电脑政企版
      • 天翼云手机
      • 云数据库
      • 对象存储
      • 云硬盘
      • Web应用防火墙
      • 服务器安全卫士
      • CDN加速
      热门推荐
      • 云服务备份
      • 边缘安全加速平台
      • 全站加速
      • 安全加速
      • 云服务器
      • 云主机
      • 智能边缘云
      • 应用编排服务
      • 微服务引擎
      • 共享流量包
      更多推荐
      • web应用防火墙
      • 密钥管理
      • 等保咨询
      • 安全专区
      • 应用运维管理
      • 云日志服务
      • 文档数据库服务
      • 云搜索服务
      • 数据湖探索
      • 数据仓库服务
      友情链接
      • 中国电信集团
      • 189邮箱
      • 天翼企业云盘
      • 天翼云盘
      ©2025 天翼云科技有限公司版权所有 增值电信业务经营许可证A2.B1.B2-20090001
      公司地址:北京市东城区青龙胡同甲1号、3号2幢2层205-32室
      • 用户协议
      • 隐私政策
      • 个人信息保护
      • 法律声明
      备案 京公网安备11010802043424号 京ICP备 2021034386号