序列化 KeyValuePair<TKey, TValue> 在 C# 中将属性类型转换为 JSON

Question

我正在尝试在 C# 中序列化一个 KeyValuePair 属性，如下所示：

[JsonDisplayName("custom")]
public  KeyValuePair<string,string> Custom { get; set; }

通过将属性设置为 JSON：

MyClass.Custom = new KeyValuePair<string, string>("destination", destination);

但我得到的输出看起来像这样：

"custom":{"Key":"destination","Value":"Paris"}

相反，我想要：

"custom":{"destination":"Paris"}

有什么想法吗？ 我正在使用 Compact Framework 和 Visual Studio 2008，所以我不想使用任何外部库。 非常感谢您的帮助。

更新：我必须使用我公司的 Model 类，它有一个 SetCustom 方法，如果我使用字典，则会引发异常。

Answer 1

您可以使用字典而不是键值对

public class A
{
    [JsonProperty("custom")]
    public Dictionary<string, string> Custom
    {
        get;
        set;
    }
}
public class Program
{
    public static void Main()
    {
        A custom = new A();
        custom.Custom = new Dictionary<string, string>(){
            {"destination1", "foo"},
            {"destination2", "bar"},
        };
        Console.WriteLine(JsonConvert.SerializeObject(custom));
    }
}

这将产生

{"custom":{"destination1":"foo","destination2":"bar"}}

或者，如果您想坚持使用KeyValuePair ，则需要创建自己的转换器

public class A
{
    [JsonProperty("custom")]
    public KeyValuePair<string, string> Custom
    {
        get;
        set;
    }
}

class KeyValueStringPairConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        KeyValuePair<string, string> item = (KeyValuePair<string, string>)value;
        writer.WriteStartObject();
        writer.WritePropertyName(item.Key);
        writer.WriteValue(item.Value);
        writer.WriteEndObject();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof (KeyValuePair<string, string>);
    }
}

public class Program
{
    public static void Main()
    {
        A custom = new A();
        JsonSerializerSettings settings = new JsonSerializerSettings{Converters = new[]{new KeyValueStringPairConverter()}};
        custom.Custom = new KeyValuePair<string, string>("destination", "foo");
        Console.WriteLine(JsonConvert.SerializeObject(custom, settings));
    }
}

Answer 2

不要忘记从 NuGet Newtonsoft.Json 下载

class Program
{
    static void Main(string[] args)
    {
        String [,] arr = new String[1,2];
        arr[0,0] = "Hello";
        arr[0,1] = "World";

        Console.WriteLine(JsonConvert.SerializeObject(arr));
        Console.ReadKey(true);
        //[["Hello","World"]]
    }
}

Answer 3

我和OP有同样的问题，鲍勃的回答对我有用。 只是想分享一下，如果您在 .NET Core / .NET 5+ 中使用 System.Text.Json.Serialization 而不是 Newtonsoft.Json，则最终代码会有所不同。

public class StringKeyValuePairConverter : JsonConverter<KeyValuePair<string, string>>
{
    public override KeyValuePair<string, string> Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        throw new NotImplementedException();
    }

    public override void Write(Utf8JsonWriter writer, KeyValuePair<string, string> value, JsonSerializerOptions options)
    {
        writer.WriteStartObject();
        writer.WritePropertyName(value.Key);
        writer.WriteStringValue(value.Value);
        writer.WriteEndObject();
    }
}

它几乎是相同的，除了value是强类型的，消除了强制转换的需要，并且使用WriteStringValue （或适当的特定于类型的变体）代替WriteValue 。