@RestController 返回数据格式 总结

本文总结了基于@RestController的返回数据格式匹配规则,包括前端请求Header的Accept参数指定和后端@RequestMapping的produces参数限制。内容涉及Accept头的q参数、*/*通配符以及数据格式转换器的顺序。当匹配规则不兼容时,可能会导致406错误。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

以下总结基于本人手敲实验结论,如有不对,欢迎留言讨论指正

本文以application/xml,application/json两种数据格式为例说明

以下两点为基础

1.前端请求Header的Accept参数指定返回数据格式(最明确的优先匹配)   

当你有如下Accept头:

①Accept:text/html,application/xml,application/json

      将按照如下顺序进行produces的匹配 ①text/html ②application/xml ③application/json

②Accept:application/xml;q=0.5,application/json;q=0.9,text/html

      将按照如下顺序进行produces的匹配 ①text/html ②application/json ③application/xml

      q参数为媒体类型的质量因子,越大则优先权越高(从0到1)

③Accept:*/*,text/*,text/html

      将按照如下顺序进行produces的匹配 ①text/html ②text/* ③*/*

即匹配规则为:最明确的优先匹配

 

2.后端RequestMapping(包括PostMapping,GetMapping等)的produces参数对数据格式进行限制(参数值的顺序决定了优先级)

 

总结:

① 期望数据格式的依赖包必须齐全,不齐全将发生406错误;

JSON是:

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.6.0</version>
</dependency>

XML是:

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    <version>2.6.0</version>
</dependency>

② 基础1和基础2不兼容(没有重合的目标),返回的数据格式照基础1,发生406错误,如下图情况

③ 基础1和基础2多个目标重合,由基础1的匹配规则决定

④ 基础1缺省,由基础2的参数值顺序决定

⑤ 基础1基础2都缺省,依赖包都齐全的情况下(单一依赖包没测),数据格式由List<HttpMessageConverter<?>>的转换器顺序决定,谁在前面就转成谁;转换器顺序可以通过手动注入调整,在不手动注入的情况下,MappingJackson2HttpMessageConverter在前,所以,在完全缺省又没有手动注入转换器的情况下,默认转成json

 

匹配规则引用:https://blog.youkuaiyun.com/lzwglory/article/details/17252099

在此对作者表示感谢~

 

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值