无法使用System.Text.Json反序列化DateTime、Guid或枚举

问题概述

在使用 System.Text.Json 进行 JSON 反序列化时，可能会遇到无法正确处理 DateTime、Guid 或枚举类型的情况。这些问题通常是由于默认的反序列化行为不满足特定需求导致的。

基础概念

反序列化：将 JSON 数据转换为 .NET 对象的过程。
DateTime：表示日期和时间的结构体。
Guid：表示全局唯一标识符的结构体。
枚举：一种用户定义的数据类型，包含一组命名的常量。

类型与应用场景

DateTime：用于处理日期和时间数据，常见于日志记录、日程管理、数据分析等场景。
Guid：用于生成全局唯一标识符，常见于数据库主键、分布式系统中的唯一标识等场景。
枚举：用于定义一组固定的常量，常见于状态码、配置选项等场景。

问题原因及解决方法

1. DateTime 反序列化问题

问题原因：默认情况下，System.Text.Json 可能无法正确解析某些日期时间格式。

解决方法：

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

public class MyClass
{
    [JsonConverter(typeof(JsonStringConverter<DateTime>))]
    public DateTime MyDateTime { get; set; }
}

public class JsonStringConverter<T> : JsonConverter<T>
{
    public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        if (reader.TokenType == JsonTokenType.String)
        {
            return JsonSerializer.Deserialize<T>(reader.GetString(), options);
        }
        throw new JsonException();
    }

    public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(JsonSerializer.Serialize(value, options));
    }
}

2. Guid 反序列化问题

问题原因：默认情况下，System.Text.Json 可能无法正确解析某些 Guid 格式。

解决方法：

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

public class MyClass
{
    [JsonConverter(typeof(JsonStringConverter<Guid>))]
    public Guid MyGuid { get; set; }
}

public class JsonStringConverter<T> : JsonConverter<T>
{
    public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        if (reader.TokenType == JsonTokenType.String)
        {
            return JsonSerializer.Deserialize<T>(reader.GetString(), options);
        }
        throw new JsonException();
    }

    public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(JsonSerializer.Serialize(value, options));
    }
}

3. 枚举反序列化问题

问题原因：默认情况下，System.Text.Json 可能无法正确解析枚举值。

解决方法：

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

public enum MyEnum
{
    Value1,
    Value2
}

public class MyClass
{
    [JsonConverter(typeof(JsonStringConverter<MyEnum>))]
    public MyEnum MyEnumValue { get; set; }
}

public class JsonStringConverter<T> : JsonConverter<T>
{
    public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        if (reader.TokenType == JsonTokenType.String)
        {
            return JsonSerializer.Deserialize<T>(reader.GetString(), options);
        }
        throw new JsonException();
    }

    public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(JsonSerializer.Serialize(value, options));
    }
}