使用 System.Text.Json 时，如何处理 Dictionary 中 Key 为自定义类型的问题

在使用 System.Text.Json 进行 JSON 序列化和反序列化操作时，我们会遇到一个问题：如何处理字典中的 Key 为自定义类型的问题。

背景说明

例如，我们有如下代码：

 

// 定义一个自定义类型
public class CustomType
{
    public int Id { get; set; }

    public string Name { get; set; }

    // 获取字符串表示的 Key
    public string Key => $"{Id}_{Name}";
}

// 定义一个 Dictionary<CustomType, string> 类型的对象
Dictionary<CustomType, string> dictionary = new Dictionary<CustomType, string>
{
    { new CustomType { Id = 1, Name = "one" }, "one" },
    { new CustomType { Id = 2, Name = "two" }, "two" }
};

// 序列化字典
string json = JsonSerializer.Serialize(dictionary);

// 反序列化字典
Dictionary<CustomType, string> dictionary2 = JsonSerializer.Deserialize<Dictionary<CustomType, string>>(json);

在上述代码中，我们定义了一个自定义类型 CustomType，并使用这个类型作为 Dictionary 的 Key 类型。

接下来，我们使用 JsonSerializer.Serialize 方法将字典序列化为 JSON 字符串，并使用 JsonSerializer.Deserialize 方法将 JSON 字符串反序列化为字典。

但是，在上述代码中，我们会发现，序列化字典时，字典中的 Key 会被序列化为一个 JSON 对象，而不是我们想要的字符串。

同样的，在反序列化 JSON 字符串时，JSON 对象中的 Key 会被反序列化为一个 CustomType 类型的对象，而不是我们想要的字符串。

这时，我们就需要使用一个自定义的 JSON 转换器来解决这个问题。

代码示例

首先，我们定义一个继承自 JsonConverter 的类型 CustomTypeConverter，该类型实现了 Read、Write、ReadAsPropertyName、WriteAsPropertyName 方法：

 

public class CustomTypeConverter : JsonConverter<CustomType>
{
    public override CustomType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        // Deserialize object
        return JsonSerializer.Deserialize<CustomType>(ref reader, options);
    }

    public override void Write(Utf8JsonWriter writer, CustomType value, JsonSerializerOptions options)
    {
        // Serialize object
        JsonSerializer.Serialize(writer, value, options);
    }

    public override CustomType ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        // Read key as string
        var stringValue = reader.GetString();

        // Parse string to CustomType
        return ParseCustomType(stringValue);
    }

    public override void WriteAsPropertyName(Utf8JsonWriter writer, CustomType value, JsonSerializerOptions options)
    {
        // Write key as string
        writer.WritePropertyName(value.Key);
    }

    private CustomType ParseCustomType(string value)
    {
        // Parse string to CustomType
        var parts = value.Split("_");
        var id = int.Parse(parts[0]);
        var name = parts[1];

        return new CustomType
        {
            Id = id,
            Name = name
        };
    }
}

在上述代码中，我们将 CustomType 类型的 Key 属性作为字典的 Key，在序列化操作中，将 Key 属性序列化为字符串，并在反序列化操作中，将字符串反序列化为 Key 属性。

接下来，我们使用这个自定义的 JSON 转换器来序列化和反序列化字典：

 

// 定义一个自定义类型
public class CustomType
{
    public int Id { get; set; }

    public string Name { get; set; }

    // 获取字符串表示的 Key
    public string Key => $"{Id}_{Name}";
}

// 定义一个 Dictionary<CustomType, string> 类型的对象
Dictionary<CustomType, string> dictionary = new Dictionary<CustomType, string>
{
    { new CustomType { Id = 1, Name = "one" }, "one" },
    { new CustomType { Id = 2, Name = "two" }, "two" }
};

// 创建 JsonSerializerOptions 对象
var options = new JsonSerializerOptions();

// 添加自定义的 JSON 转换器
options.
Converters.Add(new CustomTypeConverter());

// 序列化字典
string jsonString = JsonSerializer.Serialize(dictionary, options);

// 反序列化 JSON 字符串
var result = JsonSerializer.Deserialize<Dictionary<CustomType, string>>(jsonString, options);

在上述代码中，我们将 CustomType 类型的 Key 属性作为字典的 Key，在序列化操作中，将 Key 属性序列化为字符串，并在反序列化操作中，将字符串反序列化为 Key 属性。

使用建议

在使用 System.Text.Json 进行序列化和反序列化操作时，如果要处理字典中 Key 为自定义类型的问题，可以通过定义一个自定义的 JSON 转换器来解决。

在定义自定义的 JSON 转换器时，需要注意以下几点：

1. 类型需要继承自 JsonConverter 类型。
2. 类型需要实现 Read、Write、ReadAsPropertyName、WriteAsPropertyName 方法。
3. 在 Read 方法中，需要将 JSON 字符串反序列化为 T 类型。
4. 在 Write 方法中，需要将 T 类型序列化为 JSON 字符串。
5. 在 ReadAsPropertyName 方法中，需要将 JSON 字符串反序列化为字典的 Key 属性。
6. 在 WriteAsPropertyName 方法中，需要将字典的 Key 属性序列化为 JSON 字符串。

总结

本文通过一个实例，介绍了如何使用 System.Text.Json 进行序列化和反序列化操作时，处理字典中 Key 为自定义类型的问题。

在定义自定义的 JSON 转换器时，需要注意类型需要继承自 JsonConverter 类型，并实现 Read、Write、ReadAsPropertyName、WriteAsPropertyName 方法。

参考资料

• System.Text.Json
• How to serialize and deserialize a dictionary with a custom key type

本文采用 Chat OpenAI 辅助注水浇筑而成，如有雷同，完全有可能。

• 本文作者： newbe36524
• 本文链接： https://www.newbe.pro/ChatAI/How-serialize-custom-type-as-dictionary-key-in-system-text-json /
• 版权声明： 本博客所有文章除特别声明外，均采用 BY-NC-SA 许可协议。转载请注明出处！