Web API 配置旧版XmlSerializer替代DataContractXmlSerializer及XML请求异常解决
配置不生效的核心原因
- 经典ASP.NET Web API的XmlFormatter默认采用DataContractSerializer时,会自动将
application/xml纳入支持的媒体类型列表;切换到UseXmlSerializer = true时,受内置严格类型校验逻辑影响,若返回类型不兼容旧版XmlSerializer的要求,格式化器会直接判定自身无法处理该类型,媒体类型协商时自动跳过,最终回退到JSON格式化器返回结果。 - Swagger UI的响应类型下拉选项,是通过遍历已注册的格式化器,逐类型校验
CanWriteType的返回结果生成的;只要XmlFormatter对任意API的返回类型判定为不可写,就会自动过滤掉该格式化器对应的所有媒体类型选项,包括application/xml。 - 直接向
SupportedMediaTypes列表添加条目不生效的本质原因不是媒体类型未添加,而是XmlFormatter的类型校验逻辑直接把整个格式化器标记为不可用,和媒体类型列表无关。
正确配置步骤
- 统一从当前请求上下文传入的
HttpConfiguration实例获取格式化器,禁止跨实例(比如直接操作GlobalConfiguration静态实例)赋值,避免配置和运行时实例不匹配:
public static class WebApiConfig { public static void Register(HttpConfiguration config) { // 从传入的配置实例获取XML格式化器 var xmlFormatter = config.Formatters.XmlFormatter; // 开启旧版XmlSerializer支持 xmlFormatter.UseXmlSerializer = true; // 显式补全媒体类型支持(避免受不同框架版本默认行为差异影响) xmlFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/xml")); xmlFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/xml")); } }
- 全量排查DTO类型的兼容性
旧版XmlSerializer对类型的约束远严格于DataContractSerializer,必须满足以下要求才能被正常识别:- 类型存在公开无参构造函数
- 所有需要序列化的属性为公开可读写,无只读、私有setter限制
- 不存在循环引用、无法序列化的接口/抽象类成员
校验方法:配置完成后,在Register方法末尾追加测试逻辑,确认核心DTO的可写性:
若返回// 替换为项目中的实际业务类型 bool canWriteSampleDto = xmlFormatter.CanWriteType(typeof(你的核心DTO类型));false,根据校验报错修正DTO结构,直到返回true为止。 - Swagger选项修复
完成类型兼容性校验后,Swagger会自动识别XmlFormatter支持的媒体类型;若仍未显示XML选项,可在Swagger注册流程中手动建立媒体类型映射,跳过自动推断逻辑:public static void Register(HttpConfiguration config) { // 前置的XmlFormatter配置完成后 config.EnableSwagger(swagger => { // 手动绑定XML媒体类型到XmlFormatter swagger.MapType(typeof(XmlMediaTypeFormatter), () => "application/xml"); }).EnableSwaggerUi(); }
注意:不要在
Application_Start中直接修改GlobalConfiguration.Configuration.Formatters的属性后,再调用GlobalConfiguration.Configure执行WebApiConfig.Register,这种写法会导致配置实例被两次初始化覆盖,出现配置丢失。
注意:开启UseXmlSerializer后,所有DataContract相关的特性(如[DataContract]、[DataMember])会失效,序列化规则完全遵循旧版XmlSerializer的逻辑,不要在DTO上同时混用两类序列化标记。
内容的提问来源于stack exchange,提问作者Jeff Dege
相关产品推荐
相关产品推荐

