如何使用Json.Net将Dictionary序列化为其父对象的一部分

Question

我正在使用Json.Net进行序列化。我有一堂字典课：

public class Test
{
    public string X { get; set; }
    public Dictionary<string, string> Y { get; set; }
}

我可以以某种方式序列化此对象以获得以下JSON 吗

{
    "X" : "value",
    "key1": "value1",
    "key2": "value2"
}

"key1"、"key2"是字典中的键吗？

Answer 1

如果您使用的是Json.Net 5.0.5或更高版本，并且您愿意将字典的类型从Dictionary<string, string>更改为Dictionary<string, object>，那么一种简单的方法就是将[JsonExtensionData]属性添加到您的字典属性中，如下所示：

public class Test
{
    public string X { get; set; }
    [JsonExtensionData]
    public Dictionary<string, object> Y { get; set; }
}

然后，标记字典的键和值将作为父对象的一部分进行序列化。额外的好处是它还可以反序列化：JSON中任何与类成员不匹配的属性都将被放入字典中。

Answer 2

实现JsonConverter派生类：CustomCreationConverter类应用作基类，以创建自定义对象。

转换器的草案版本（错误处理可以根据您的意愿进行改进）：

internal class TestObjectConverter : CustomCreationConverter<Test>
{
    #region Overrides of CustomCreationConverter<Test>
    public override Test Create(Type objectType)
    {
        return new Test
            {
                Y = new Dictionary<string, string>()
            };
    }
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        writer.WriteStartObject();
        // Write properties.
        var propertyInfos = value.GetType().GetProperties();
        foreach (var propertyInfo in propertyInfos)
        {
            // Skip the Y property.
            if (propertyInfo.Name == "Y")
                continue;
            writer.WritePropertyName(propertyInfo.Name);
            var propertyValue = propertyInfo.GetValue(value);
            serializer.Serialize(writer, propertyValue);
        }
        // Write dictionary key-value pairs.
        var test = (Test)value;
        foreach (var kvp in test.Y)
        {
            writer.WritePropertyName(kvp.Key);
            serializer.Serialize(writer, kvp.Value);
        }
        writer.WriteEndObject();
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JObject jsonObject = JObject.Load(reader);
        var jsonProperties = jsonObject.Properties().ToList();
        var outputObject = Create(objectType);
        // Property name => property info dictionary (for fast lookup).
        var propertyNames = objectType.GetProperties().ToDictionary(pi => pi.Name, pi => pi);
        foreach (var jsonProperty in jsonProperties)
        {
            // If such property exists - use it.
            PropertyInfo targetProperty;
            if (propertyNames.TryGetValue(jsonProperty.Name, out targetProperty))
            {
                var propertyValue = jsonProperty.Value.ToObject(targetProperty.PropertyType);
                targetProperty.SetValue(outputObject, propertyValue, null);
            }
            else
            {
                // Otherwise - use the dictionary.
                outputObject.Y.Add(jsonProperty.Name, jsonProperty.Value.ToObject<string>());
            }
        }
        return outputObject;
    }
    public override bool CanWrite
    {
        get { return true; }
    }
    #endregion
}

客户代码：

var test = new Test
    {
        X = "123",
        Y = new Dictionary<string, string>
            {
                { "key1", "value1" },
                { "key2", "value2" },
                { "key3", "value3" },
            }
    };
string json = JsonConvert.SerializeObject(test, Formatting.Indented, new TestObjectConverter());
var deserializedObject = JsonConvert.DeserializeObject<Test>(json);

请注意：字典的属性名称和关键字名称之间可能存在冲突。

Answer 3

您可以创建此转换器，然后将其分配给您的属性。采纳了一些建议的解决方案。

public class DictionaryToJsonObjectConverter : JsonConverter
    {
        public override bool CanConvert(Type objectType)
        {
            return typeof(IDictionary<string, string>).IsAssignableFrom(objectType);
        }
        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            throw new NotImplementedException();
        }
        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
        {
            writer.WriteRawValue(JsonConvert.SerializeObject(value, Formatting.Indented));
        }
    }

然后在你的poco课程中使用它。

public class Poco
{
        [JsonProperty("myid")]
        public string Id{ get; set; }
        [JsonProperty("properties")]
        [JsonConverter(typeof(DictionaryToJsonObjectConverter))]
        public IDictionary<string, string> Properties { get; set; }
    }