.NET Web API如何配置XML格式化器_网络技术_宿州市腾雀网络科技有限公司

.NET Web API如何配置XML格式化器

发布时间 - 2026-02-02 00:00:00 点击率：次

.NET 6+ Web API 默认不支持 XML 响应，因移除了 XmlSerializerOutputFormatter，需手动安装 Microsoft.AspNetCore.Mvc.Formatters.Xml 包并注册该格式化器，且模型须满足无参构造、public 属性等要求。

为什么默认不支持 XML 响应

.NET 6+ 的 Web API 模板默认只注册 SystemTextJsonOutputFormatter，完全移除了对 XML 的自动支持。即使你返回 IActionResult 或启用了 [Produces("application/xml")]，请求带 Accept: application/xml 也会直接 406 Not Acceptable。

添加 XmlSerializerOutputFormatter 的正确方式

必须显式注册基于 XmlSerializer 的格式化器（XmlDataContractSerializer 已被弃用且不推荐用于 Web API）。注意：.NET 5+ 不再内置 XML 支持包，需先安装 NuGet 包：

dotnet add package Microsoft.AspNetCore.Mvc.Formatters.Xml

然后在 Program.cs 中注册：

builder.Services.AddControllers(options =>
{
    options.OutputFormatters.Add(new XmlSerializerOutputFormatter());
    // 可选：禁用默认的 JSON 格式化器（仅需 XML 时）
    // options.OutputFormatters.RemoveType();
});

关键点：

XmlSerializerOutputFormatter 要求模型类有无参构造函数，且属性必须是 public get/set
不支持 record 类型（会抛 InvalidOperationException: Type 'X' cannot be serialized）
若控制器方法返回 Task，确保实际返回值类型可被 XmlSerializer 序列化（如 Ok(MyModel)）

处理 XML 请求（POST/PUT）

仅配置输出格式化器不够——接收 XML 请求体还需注册输入格式化器：

builder.Services.AddControllers(options =>
{
    options.InputFormatters.Add(new XmlSerializerInputFormatter(options));
    options.OutputFormatters.Add(new XmlSerializerOutputFormatter());
});

此时需确保请求头包含 Content-Type: application/xml，且 XML 结构与模型字段名严格匹配（区分大小写，无命名空间更稳妥）。常见失败原因：

XML 根节点名 ≠ 模型类名（XmlRoot 特性可覆盖）
字段名含下划线或驼峰，但 XML 使用短横线（如）→ 需加 [XmlElement("user-name")]
传了空字符串给非 nullable 引用类型字段 → 反序列化失败

调试 406 或空响应的快速检查项

当 XML 响应不生效时，优先验证以下三点：

是否漏装 Microsoft.AspNetCore.Mvc.Formatters.Xml 包？没有它，XmlSerializerOutputFormatter 类型根本不存在
是否在 AddControllers() 后才调用 Build()？顺序错误会导致注册失效
是否误用了 serv ices.AddMvc()（已过时）？.NET 6+ 推荐统一用 AddControllers() + AddEndpointsApiExplorer()
是否在 Startup.Configure() 中忘了调用 app.UseRouting() 和 app.UseEndpoints()？中间件链中断会导致格式化器不触发

XML 格式化器本身不处理缩进或编码声明，生成的 XML 默认无换行、UTF-8 无 BOM。如果需要美化输出，得自己封装 XmlWriterSettings 并继承 XmlSerializerOutputFormatter —— 这部分容易被低估工作量。

# js # json # 编码 # app # microsoft # .net # 为什么 # mvc # 中间件 # 命名空间 # 封装 # 构造函数 # xml # 字符串 # 继承 # 值类型 # 引用类型 # public # Nullable # bom # 不支持 # 移除 # 字段名 # 序列化 # 也会 # 已被 # 下划线 # 这部 # 不存在 # 可选

相关栏目：【网站优化151355 】【网络推广146373 】【网络技术251813 】【 AI营销90571 】

上一篇：1盎司等于多少毫升液体盎司与毫升换算公式【速查】

下一篇：苹果手机官网序列号查询入口在哪_苹果官方序列号查询页面入口

相关栏目网站优化
网络推广
网络技术
AI营销

最新文章 Sublime怎么一键压缩JS代码 Su sublime如何在搜索中使用正则表达式 Sublime如何设置透明窗口效果 Su mysql如何设计商品表结构_mysql css属性背景图不显示怎么办_通过检查路如何使用Golang实现排序_Golan 农历闰月是怎么回事_为合回归年加一月调整塑造《刺客信条》艾吉奥传奇的编剧离开育碧 1英里等于多少公里 1mile和km的换 css grid布局中行和列是如何定义的 PS批量旋转和翻转图片，快速校正图片方向 C# Swagger UI自定义方法 C OPPO手机九宫格和全键盘怎么切换_OP Go语言如何实现用户登录注册_Golan 1节飞行速度多少公里每小时 1节是多少公纸嫁衣8千子树第五章庙门怎么开启庙门 Laravel 多行数据编辑表单中实现逐明日之后如何提升钓鱼等级明日之后提升钓支付宝怎样查年度账单_支付宝年度账单查看 C# 多线程UI更新Dispatcher

上一篇：1盎司等于多少毫升液体盎司与毫升换算公式【速查】

下一篇：苹果手机官网序列号查询入口在哪_苹果官方序列号查询页面入口