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

C# 文件下载内容协商 C#如何根据Accept头返回不同格式的文件(如JSON/XML)

小浩君_4487

小浩君_4487

发布时间:2026-03-17 06:57:19

|

527人浏览过

|

来源于php中文网

原创

C# Web API 中 Accept 头未生效的根本原因是未启用内容协商或格式器配置不当;需继承 ControllerBase、注册 JSON/XML 格式器、精确匹配 MIME 类型,避免 FileResult 和手动序列化绕过协商流程。

c# 文件下载内容协商 c#如何根据accept头返回不同格式的文件(如json/xml)

Accept 头没被 C# Web API 正确读取

常见现象是客户端发 Accept: application/json,但接口始终返回 XML 或固定格式。根本原因不是头没传过来,而是 ASP.NET Core 默认不启用基于 Accept 的内容协商(Content Negotiation),或者控制器没配置响应格式支持。

实操建议:

  • 确保控制器继承 ControllerBase(不是 Controller),并启用 AddControllersAsServices()(.NET 5+ 可省略)
  • 在 Startup.ConfigureServices 或 Program.cs 中显式注册格式器:
    services.AddControllers(options =><br>    options.ReturnHttpNotAcceptable = true)<br>.AddXmlSerializerFormatters()<br>.AddJsonOptions();
  • Accept 头值必须精确匹配格式器注册的 MIME 类型,比如 application/xml 才触发 XML 序列化,text/xml 不会生效

FileResult 返回文件时 Accept 头失效

用 FileStreamResult、PhysicalFileResult 等直接返回二进制流时,内容协商机制完全绕过——框架不会检查 Accept,也不会重写 Content-Type。这是设计使然,不是 bug。

实操建议:

  • 如果目标是“根据 Accept 返回不同格式的数据”,就别用 FileResult;改用 ActionResult<t></t> + 模型序列化,让框架接管协商流程
  • 若必须返回文件(如导出 Excel/PDF),则 Accept 失效是预期行为;此时应通过查询参数(如 ?format=json)或路由(/api/data.json)显式指定格式
  • 手动设置 Content-Type 时,注意它和 Accept 无关:
    return File(bytes, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");

自定义类型无法被 JSON/XML 同时序列化

模型类里有 [XmlIgnore] 但没配 [JsonIgnore],或用了 XmlRoot 却没加 JsonObject,就会导致一个格式能出,另一个报错或字段丢失。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

实操建议:

  • 优先用跨格式兼容的属性标记:[JsonPropertyName("id")] + [XmlElement("id")],而不是只写其中一个
  • 避免依赖默认命名策略差异:JSON 默认 camelCase,XML 默认 PascalCase;统一用显式命名,或关掉 JSON 的 camelCase:
    options.JsonSerializerOptions.PropertyNamingPolicy = null;
  • 集合类型慎用 IEnumerable<t></t>:XML 序列化器不支持直接序列化接口,需改为 List<t></t> 或加 [XmlArray]

Content-Type 响应头没随 Accept 动态变化

即使协商成功,响应头里 Content-Type 仍是 application/json,哪怕客户端要的是 application/xml。这说明格式器没真正参与输出,或中间件顺序错了。

实操建议:

  • 检查是否误用了 Ok(object) —— 它强制走 JSON;改用 Ok<mymodel>(model)</mymodel> 让泛型推导启用协商
  • 确认没在 action 里手动调用 Json(model) 或 Xml(model),这些方法绕过协商
  • 如果用了 Produces 特性,确保列出所有支持的类型:
    [Produces("application/json", "application/xml")]

内容协商真正起作用的前提,是整个链路都走 MVC 的序列化管道。一旦你手动构造响应体、用 FileStreamResult、或提前调用 Json(),Accept 就只是个 HTTP 头而已,没人会看它。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

豆包大模型

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

PixTV
PixTV Hot

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

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

WorkBuddy

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

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3729

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2468

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1420

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1358

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1436

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2398

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

4000

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

18975

2023.09.22

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

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

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