Web API 2同时支持JSON与XML返回异常：DataContract配置后JSON序列化失败

这是Web API里非常典型的序列化冲突场景：你为了搞定XML序列化时的循环引用错误，给复杂数据类加上了DataContract(IsReference = true)特性，结果XML正常了，但JSON序列化却失效了——而简单DTO类不受影响，核心原因是默认情况下Web API会根据DataContract特性切换JSON序列化器，导致循环引用处理逻辑冲突。

解决方案1：分开配置XML与JSON的序列化规则 #

在传统ASP.NET Web API的WebApiConfig.cs中，分别对两种格式的序列化器做单独配置，让它们各自处理循环引用：

• 针对XML，保留DataContractSerializer并启用引用保留：

public static void Register(HttpConfiguration config)
{
    // 配置XML序列化器
    config.Formatters.XmlFormatter.UseXmlSerializer = false;
    var xmlSerializerSettings = config.Formatters.XmlFormatter.SerializerSettings as DataContractSerializerSettings;
    if (xmlSerializerSettings != null)
    {
        xmlSerializerSettings.PreserveObjectReferences = true;
    }

    // 配置JSON序列化器（强制使用Newtonsoft.Json，忽略DataContract影响）
    config.Formatters.JsonFormatter.UseDataContractJsonSerializer = false;
    config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;
    config.Formatters.JsonFormatter.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects;
}

解决方案2：给复杂类添加双序列化特性 #

直接在你的复杂数据类上，同时标注XML和JSON的引用支持特性，让两个序列化器都能正确识别循环引用规则：

using System.Runtime.Serialization;
using Newtonsoft.Json;

[DataContract(IsReference = true)] // 供XML序列化使用
[JsonObject(IsReference = true)]    // 供JSON序列化使用
public class YourComplexEntity
{
    [DataMember]
    public int EntityId { get; set; }

    [DataMember]
    public YourComplexEntity ParentEntity { get; set; }

    // 其他复杂关联属性...
}

这样XML序列化会遵循DataContract的设置，JSON序列化会遵循JsonObject的设置，两者互不干扰，简单DTO因为没有循环引用，自然也能正常工作。

解决方案3：ASP.NET Core环境下的配置 #

如果是ASP.NET Core Web API，配置逻辑放在Program.cs中，同样分开处理两种格式：

var builder = WebApplication.CreateBuilder(args);

// 添加控制器并配置序列化选项
builder.Services.AddControllers()
    // 配置XML序列化
    .AddXmlDataContractSerializerFormatters(options =>
    {
        options.DataContractSerializerSettings.PreserveObjectReferences = true;
    })
    // 配置JSON序列化（使用Newtonsoft.Json）
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;
        options.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.Objects;
    });

var app = builder.Build();

// 其他中间件配置...
app.Run();

问题根源补充 #

为什么加了DataContract(IsReference = true)会影响JSON？因为传统Web API默认逻辑是：如果类带有DataContract特性，会自动切换JSON序列化器为DataContractJsonSerializer，而这个序列化器对循环引用的支持非常有限，远不如Newtonsoft.Json灵活。而简单DTO没有循环引用，所以即使使用DataContractJsonSerializer也能正常序列化，不会暴露问题。

内容的提问来源于stack exchange，提问作者Ravindra Kumar Challagandla