.NET Core中REST API多类型JSON的优雅反序列化方案咨询

嘿，我完全懂你这种纠结——现有的两种处理方式要么依赖字段默认值（万一用户ID真的是0就凉了），要么靠字符串检索（万一用户某个字段里刚好有"error"字眼就会误判），确实都不够优雅。这里有几个更简洁可靠的方案，你可以参考下：

方案1：用JSON DOM先解析再判断（最直观可靠） #

直接把JSON解析成DOM对象，检查是否存在特定的错误字段，再决定反序列化到对应的类型。这种方式比字符串Contains精准得多，因为是检查属性是否存在，而不是子串匹配。

以System.Text.Json为例：

using var jsonDoc = JsonDocument.Parse(json);
var root = jsonDoc.RootElement;

if (root.TryGetProperty("error", out _))
{
    var error = root.Deserialize<ApiException>();
    // 处理错误逻辑
}
else
{
    var user = root.Deserialize<User>();
    // 处理用户逻辑
}

如果用Newtonsoft.Json（Json.NET）：

var jObject = JObject.Parse(json);

if (jObject.ContainsKey("error"))
{
    var error = jObject.ToObject<ApiException>();
}
else
{
    var user = jObject.ToObject<User>();
}

方案2：自定义多态反序列化转换器（一次反序列化搞定） #

如果不想每次都写判断逻辑，可以自定义一个转换器，让序列化库自动根据JSON内容判断要反序列化到哪个类型。这样只需要反序列化一次，后续直接用类型判断即可。

还是以Newtonsoft.Json为例：
首先定义一个基类让两个类型继承：

public abstract class ApiResponse { }
public class User : ApiResponse 
{ 
    public int UserId { get; set; }
    // 其他用户字段...
}
public class ApiException : ApiResponse 
{ 
    public string Error { get; set; }
    // 其他错误字段...
}

然后写自定义转换器：

public class ApiResponseConverter : JsonConverter<ApiResponse>
{
    public override ApiResponse ReadJson(JsonReader reader, Type objectType, ApiResponse existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        var jObject = JObject.Load(reader);
        // 根据是否存在error字段判断类型
        return jObject.ContainsKey("error") 
            ? jObject.ToObject<ApiException>(serializer) 
            : jObject.ToObject<User>(serializer);
    }

    public override void WriteJson(JsonWriter writer, ApiResponse value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }
}

使用的时候只需要：

var settings = new JsonSerializerSettings();
settings.Converters.Add(new ApiResponseConverter());

var response = JsonConvert.DeserializeObject<ApiResponse>(json, settings);

if (response is User user)
{
    // 处理用户
}
else if (response is ApiException error)
{
    // 处理错误
}

方案3：尝试反序列化+捕获异常（慎用） #

这种方式代码最简洁，但要注意异常的性能开销，如果API返回错误的频率不高，可以偶尔用：

User user = null;
ApiException error = null;

try
{
    user = JsonConvert.DeserializeObject<User>(json);
}
catch (JsonSerializationException)
{
    error = JsonConvert.DeserializeObject<ApiException>(json);
}

if (user != null)
{
    // 处理用户
}
else if (error != null)
{
    // 处理错误
}

不过这种方式不推荐在高频场景使用，因为异常抛出和捕获的成本比较高。

对比原有方案的优势 #

• 避免了方式一中依赖UserId == 0的潜在bug（比如合法用户ID确实为0的情况）
• 避免了方式二中字符串Contains的误判风险（比如用户的Bio字段里有"error"字样）
• 代码更简洁，逻辑更清晰

内容的提问来源于stack exchange，提问作者user3953989