讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring MVC 中怎么配置内容协商实现多格式数据返回

夜磊大大_5491

夜磊大大_5491

发布时间:2026-08-08 16:46:26

|

199人浏览过

|

来源于php中文网

原创

Spring MVC 通过内容协商机制自动返回多格式数据,依赖配置application.properties、引入对应消息转换器依赖(如Jackson XML/YAML)、Controller保持简洁,必要时可自定义ContentNegotiationManager。

spring mvc 中怎么配置内容协商实现多格式数据返回

Spring MVC 实现多格式数据返回,核心靠内容协商(Content Negotiation)机制自动匹配客户端期望的格式,不需要在 Controller 中手动判断或转换。关键在于让框架“知道”它能提供哪些格式,并“读懂”客户端想要哪一种。

启用并配置内容协商策略

Spring Boot 默认已启用内容协商,但行为细节需明确配置。主要控制点在 application.properties 或 application.yml 中:

  • 开启路径扩展名支持:允许通过 /api/users.json 或 /api/users.xml 直接指定格式
    spring.mvc.contentnegotiation.favor-path-extension=true
  • 开启参数方式支持:允许用 ?format=json 或 ?format=xml
    spring.mvc.contentnegotiation.favor-parameter=true
    (注意:默认参数名是 format,可自定义,如 spring.mvc.contentnegotiation.parameter-name=output)
  • 是否忽略 Accept 请求头:设为 false(默认),确保尊重客户端发来的 Accept: application/xml 等头信息
  • 设置默认媒体类型:当所有协商方式都失败时返回的格式
    spring.mvc.contentnegotiation.default-content-type=application/json

引入对应的消息转换器依赖

仅配置协商策略还不够——Spring 必须有能把 Java 对象转成 XML/JSON/YAML 的“工具”。这些工具由 HttpMessageConverter 实现,它们随依赖自动注册:

  • JSON 支持:引入 spring-boot-starter-web 即自带 Jackson2ObjectMapperBuilder 和 MappingJackson2HttpMessageConverter
  • XML 支持:必须额外添加 Jackson XML 依赖:
    <dependency><br>  <groupId>com.fasterxml.jackson.dataformat</groupId><br>  <artifactId>jackson-dataformat-xml</artifactId><br></dependency>
  • YAML 支持:加 jackson-dataformat-yaml 依赖,并确保 spring-boot-starter-web 版本 ≥ 2.6.x;还需配置 spring.http.converters.preferred-json-mapper=jackson 避免冲突

Controller 保持简洁,无需改动

只要方法标注 @ResponseBody(或类上用 @RestController),返回普通 POJO 或集合即可。Spring 自动选择合适的 HttpMessageConverter:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
@GetMapping("/users")
public List<User> listUsers() {
    return userService.findAll();
}

调用示例:

  • GET /users.json → 返回 JSON
  • GET /users.xml → 返回 XML(前提是 XML 依赖已就位)
  • GET /users?format=xml → 同样返回 XML
  • GET /users + Accept: application/xml → 也返回 XML

必要时自定义协商逻辑

若默认规则不满足业务(比如移动端强制走 JSON、管理后台优先 XML),可通过 Java Config 定制 ContentNegotiationManager:

  • 禁用某类协商方式(如彻底关闭路径扩展,只认 Accept 头)
  • 调整媒体类型权重顺序(例如把 application/vnd.api+json 排在标准 JSON 前)
  • 注册自定义 ContentNegotiationStrategy,从请求中提取租户 ID 决定格式

这类定制通常写在实现 WebMvcConfigurer 的配置类里,重写 configureContentNegotiation 方法。

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2411

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

437

2026.01.26

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

40

2026.10.08

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

140

2026.09.30

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

120

2026.09.30

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

100

2026.09.30

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

100

2026.09.30

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

120

2026.09.29

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

320

2026.09.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn