使用自定义JsonConverter反序列化时将{}视为null的问题排查

核心问题根源 #

你遇到的问题本质是：当JSON中传入空对象{}时，自定义Converter返回null，但Json.NET后续的属性赋值校验仍触发了空值错误。而传入null时，Json.NET直接跳过Converter处理，自然不会触发错误。

关键排查点与修复步骤 #

1. 修正自定义Converter的空对象处理逻辑 #

确保在ReadJson方法中，处理空JObject时不仅返回null，还要保证JsonReader状态正常。示例代码：

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
    // 处理JSON原生null的情况
    if (reader.TokenType == JsonToken.Null)
        return null;

    var jObject = JObject.Load(reader);
    // 空对象直接返回null
    if (jObject.Count == 0)
        return null;

    // 多态类型判断逻辑
    if (jObject.ContainsKey("text"))
        return jObject.ToObject<MetadataText>(serializer);
    if (jObject.ContainsKey("imageUrl"))
        return jObject.ToObject<MetadataImage>(serializer);

    // 无匹配子类时返回null（或根据需求抛出自定义异常）
    return null;
}

2. 明确标记属性允许为null #

[CanBeNull]是JetBrains代码分析注解，Json.NET不会识别它。需要在Author类的Metadata属性上添加Json.NET专属注解，明确允许空值：

public class Author
{
    [JsonProperty(Required = Required.AllowNull)]
    public Metadata Metadata { get; set; }
    // 其他属性
}

3. 优化序列化配置 #

确保JsonSerializerSettings覆盖所有可能触发空值校验的选项：

var settings = new JsonSerializerSettings
{
    Converters = new List<JsonConverter> { new MetadataConverter() },
    NullValueHandling = NullValueHandling.Ignore,
    MissingMemberHandling = MissingMemberHandling.Ignore,
    Error = (sender, args) =>
    {
        // 捕获并标记错误已处理，避免传播
        args.ErrorContext.Handled = true;
        // 可添加日志记录逻辑
    }
};

4. 排查潜在的内部校验冲突 #

如果以上步骤仍未解决问题，检查以下情况：

• Metadata类或其子类是否被标记为[Required]或其他强制非空的注解
• 是否有全局Json.NET配置覆盖了局部设置
• 确认Metadata是引用类型（避免值类型或可空值类型的误用）

为什么输入null正常、输入{}异常？ #

当JSON是null时，Json.NET会直接将属性赋值为null，不会调用自定义Converter；而当JSON是{}时，Json.NET会触发Converter处理，Converter返回null后，若属性未明确配置允许空值，Json.NET默认的属性校验逻辑会认为“非空JSON对象转换为null”是异常，从而抛出错误。

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