当前位置: 首页 > news >正文

学透Spring Boot — 018. 优雅支持多种响应格式

这是我的专栏《学透Spring Boot》的第18篇文章,想要更系统的学习Spring Boot,请访问我的专栏:学透 Spring Boot_postnull咖啡的博客-CSDN博客。

目录

返回不同格式的响应

Spring Boot的内容协商

控制器不用任何修改

启动内容协商配置

访问应用

获取XML格式的响应

添加XML的支持

设置变量名

配置其它的格式

总结


Spring MVC中会根据@GetMapping或者@RequestMapping中的路径,匹配对应的HTTP请求到指定的方法去,这个我们不再累述。

今天我们玩点更特别的。

返回不同格式的响应

有时候,我们希望我们的响应,既可以返回json格式,也可以返回xml格式。

返回什么格式,由我们的参数来决定。

最傻的办法,是在Controller中,解析format参数,然后用XML或者Json解析器把对象转换成json或者XML格式。

这样当然可以,但是有点不够优雅。

Spring Boot的内容协商

好在,Spring Boot已经帮我实现了这样的特性,支持不同格式的响应。

控制器不用任何修改

控制器不用做任何修改,甚至连format参数都不用加。

启动内容协商配置

application.properties

spring.mvc.contentnegotiation.favor-parameter=true

访问应用

然后我们可以带参数获取不同的响应。

http://localhost:8080/buyBike?format=json

返回了json响应

不带format参数,返回的也是json。这是默认格式。

获取XML格式的响应

然后我们再获取xml响应:http://localhost:8080/buyBike?format=xml

非常可惜,情况有点异常。报错了。

查看日志,发现支持的格式中居然没有application/xml.

这是怎么回事呢?

我们debug看看,启动时看看WebMvcConfigurer (Spring MVC配置器)加载了哪些http消息转换器。

要深入了解HTTP消息转换器,请看我上一篇的文章学透Spring Boot — 017. 魔术师—Http消息转换器-CSDN博客

可以看到,SpringBoot只配置了json的转换器。

我们再看看jackson的自动配置类

可以看到,要配置Jackson XML,就classpath下必须有XmlMapper类。

很可惜Spring Boot默认没有引入这个类。

添加XML的支持

为了支持XML的响应,我们需要引入XML相关的依赖。

这时候有了XmlMapper类,我们的Jackson也会去自动配置XML转换器了。

我们重启服务,debug,再看看加载的消息转换器列表。

下图可以看出,Jackson XML的消息转换器已经自动配置并加载了。

再次访问,成功返回xml的响应!!!

设置变量名

其实我们还可以做得在多一点。比如我不喜欢format这个变量,我想改成good

spring.mvc.contentnegotiation.parameter-name=good

完全OK

配置其它的格式

如果我还想配置其它的格式,也是可以的。比如我们前面文章自主研发的格式“hehe/nba”

spring.mvc.contentnegotiation.media-types.hehe-nbc=hehe/nba

访问有问题可能是因为你的格式不在支持的列表中

RequestResponseBodyMethodProcessor : Using 'hehe/nba;charset=UTF-8', given [hehe/nba] and supported [application/json, application/*+json, application/xml;charset=UTF-8, text/xml;charset=UTF-8, application/*+xml;charset=UTF-8, hehe/nba;charset=UTF-8, hehe/nba]

而且我们开发的hehe/nba格式,暂时只处理了Car类。

总结

本文,我们自己通过内容协商,实现了返回多种格式响应的需求,而且不用改动任何业务代码,只需做少量配置即可。另外,我们也通过引入XML的依赖,实现了Spring Boot对Jackson XML的自动配置。

相关文章:

  • 多智能体优秀开发框架
  • Java 中的 CompletableFuture:异步编程的强大工具
  • 网络原理 - HTTP/HTTPS
  • HAL 库设置回调成员函数的一种方法
  • 2-vim编辑器的安装和使用
  • 【爬虫】携程旅游项目数据爬取
  • GPT-4o从语义分割到深度图生成,大模型狂潮下的计算机视觉:技术进步≠替代危机
  • C#UDP协议客户端工具类
  • C#实现存储数据到Redis
  • 运行小程序报错
  • Leetcode 3508. Implement Router
  • Java数据结构的基础用法
  • 嵌入式AI开源生态指南:从框架到应用的全面解析
  • JavaScript学习教程,从入门到精通,JavaScript 基础语法全面指南(5)
  • 2025.4.6总结
  • 低空经济基础设施建设方向与展望
  • 深入详解流形学习中的几何解释
  • 机器学习/深度学习
  • HTML语言的数据可视化
  • deepseek为采用JAVA重构模型运营平台vLLM和SGLang指定的计划
  • 石家庄模板建站系统/国际新闻最新消息2022
  • 网站备案 英文/网站优化seo怎么做
  • 徐州网站建设技术外包/国内免费域名注册网站
  • 东莞营销型网站建设流程/自动点击关键词软件
  • 银川商城网站开发设计/牛奶软文广告营销
  • 网站做博彩广告/企业如何进行宣传和推广