使用System.Text.Json将false反序列化为null的通用解决方案

要解决API返回false代替null的问题，我们可以通过自定义JsonConverterFactory实现全局通用的转换逻辑，让System.Text.Json在反序列化时自动把JsonTokenType.False当作null处理，支持所有可空类型、引用类型，无论嵌套层级深浅，兼容net7.0和netstandard2.0。

实现步骤 #

1. 自定义转换器工厂 #

这个工厂会根据目标类型生成对应的转换器，确保对任意类型都生效：

using System;
using System.Text.Json;
using System.Text.Json.Serialization;

public class FalseAsNullConverterFactory : JsonConverterFactory
{
    public override bool CanConvert(Type typeToConvert)
    {
        // 支持可空值类型（T?）和所有引用类型
        return Nullable.GetUnderlyingType(typeToConvert) != null || !typeToConvert.IsValueType;
    }

    public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
    {
        // 获取泛型转换器的类型并创建实例
        Type converterType = typeof(FalseAsNullConverter<>).MakeGenericType(typeToConvert);
        return (JsonConverter)Activator.CreateInstance(converterType)!;
    }
}

2. 实现具体转换器 #

针对泛型类型的转换器，处理false令牌的替换逻辑：

public class FalseAsNullConverter<T> : JsonConverter<T>
{
    public override T? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        // 如果当前令牌是false，返回默认值（可空类型/引用类型的默认值就是null）
        if (reader.TokenType == JsonTokenType.False)
        {
            reader.Read(); // 跳过当前false令牌
            return default;
        }

        // 否则使用默认反序列化逻辑
        return JsonSerializer.Deserialize<T>(ref reader, options);
    }

    public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
    {
        // 序列化时保持默认逻辑，如需特殊处理可在此修改
        JsonSerializer.Serialize(writer, value, options);
    }
}

3. 配置序列化选项并使用 #

在反序列化时，将自定义转换器工厂添加到JsonSerializerOptions中，即可全局生效：

// 修正原示例中的类定义（原代码存在属性名重复问题）
public sealed class JsonDefinition
{
    public string? Property { get; set; }
    public int? Property2 { get; set; }
    public NestedJsonType? Property3 { get; set; }
}

public sealed class NestedJsonType
{
    public SomeType? Property { get; set; }
}

public sealed class SomeType { } // 示例嵌套类型

// 反序列化示例
string json = @"
{
   ""property"": false,
   ""property2"": false,
   ""property3"": {
      ""property"": false
   }
}";

var options = new JsonSerializerOptions();
options.Converters.Add(new FalseAsNullConverterFactory());

JsonDefinition result = JsonSerializer.Deserialize<JsonDefinition>(json, options)!;

// 验证结果：所有对应属性都会被反序列化为null
Console.WriteLine(result.Property == null); // true
Console.WriteLine(result.Property2 == null); // true
Console.WriteLine(result.Property3?.Property == null); // true

兼容性说明 #

• net7.0：直接使用上述代码即可，System.Text.Json版本完全支持相关API。
• netstandard2.0：确保安装System.Text.Json NuGet包（版本≥4.7.2），API兼容无问题。

核心逻辑说明 #

• FalseAsNullConverterFactory的CanConvert方法筛选出需要处理的类型：可空值类型和所有引用类型。
• 转换器的Read方法检测到JsonTokenType.False时，直接返回default(T)，对于可空类型和引用类型来说，default就是null。
• 嵌套类型会自动递归处理，因为默认反序列化逻辑会继续调用对应的转换器，无需额外配置。

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