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

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

目录

返回不同格式的响应

[Spring Boot的内容协商](#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的自动配置。

相关推荐
用户608308929047几秒前
Spring Boot自定义注解
spring boot
你可以叫我仔哥呀4 分钟前
Java程序员学从0学AI(七)
java·开发语言·人工智能·ai·spring ai
阿宙ppppp10 分钟前
yoloV5的环境安装
后端·图像识别
杨DaB23 分钟前
【SpringMVC】MVC中Controller的配置 、RestFul的使用、页面重定向和转发
java·笔记·后端·学习·spring·mvc·restful
linyb极客之路27 分钟前
干货来袭!5 分钟学会快速实现责任链,效率直接拉满!
java
创码小奇客31 分钟前
保姆级 Talos 超参数优化实战指南:从入门到封神
java·后端·架构
程序媛李李李李李蕾37 分钟前
你不能直接用现成的吗?整个前端做笔记管理工具真是折腾人
javascript·vue.js·后端
青云交38 分钟前
Java 大视界 -- Java 大数据在智能安防入侵检测系统中的多源数据融合与误报率降低策略(369)
java·大数据·入侵检测·智能安防·多源数据融合·误报率降低·视频语义理解
易元1 小时前
设计模式-访问者模式
前端·后端·设计模式
我会冲击波1 小时前
告别手写注释!变量命名、注释IDEA插件更新了,AI帮你搞定一切代码注释
java·intellij idea