使用 System.Text.Json 時，如何處理 Dictionary 中 Key 為自定義型別的問題

Newbe36524發表於2022-12-16
JSON型別

在使用 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 方法。

參考資料

本文采用 Chat OpenAI 輔助注水澆築而成，如有雷同，完全有可能。

相關文章