Comment sérialiser un Dictionnaire dans le cadre de son objet parent à l'aide de Json.Net

Je suis en utilisant Json.Net pour la sérialisation.
J'ai une classe avec un Dictionnaire:

public class Test
{
    public string X { get; set; }

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

Je peux en quelque sorte sérialiser cet objet pour récupérer le JSON suivants

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

où "key1", "key2" sont des clés dans le Dictionnaire?

InformationsquelleAutor Nataly | 2013-02-15
  1. 48

    Si vous utilisez Json.Net 5.0.5 ou tard, et vous êtes prêt à changer le type de votre dictionnaire de Dictionary<string, string> à Dictionary<string, object>, puis un moyen facile d'accomplir ce que vous voulez est d'ajouter la [JsonExtensionData] attribut à votre dictionnaire de la propriété comme ceci:

    public class Test
{
    public string X { get; set; }

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

    Les clés et les valeurs de l'marqué dictionnaire pourront ensuite être sérialisé en tant que partie de l'objet parent. Le bonus est qu'il fonctionne sur la désérialisation ainsi: toutes les propriétés dans le JSON qui ne correspondent pas aux membres de la classe sera placé dans le dictionnaire.

    • Juste une pensée à ce sujet : pourquoi Dictionary<string, object> ou Dictionary<string, JToken> ? Je voulais utiliser Dictionary<string, string>, donc un type très simple, mais j'obtiens une erreur
    • Parce que le "JsonExtensionData" fonctionnalité est conçue pour être un fourre-tout pour rien dans le JSON pour lesquels il n'existe pas de propriétés correspondante dans la classe cible. "Rien" signifie, éventuellement, des nombres, des booléens, des tableaux ou des objets enfants, rien de ce qui va dans un Dictionary<string, string>. Donc, vous avez à utiliser Dictionary<string, object> ou Dictionary<string, JToken>, même si votre JSON contient uniquement des valeurs de chaîne. C'est juste la façon dont il fonctionne. Si vous voulez quelque chose d'autre, vous aurez besoin d'utiliser un JsonConverter à la place.
    • Ce n'est pas de travail pour moi. Le résultat-je obtenir ressemble à ça {[variables, [ { "var": "x", "value": "W" }, { "var": "y", "value": "2" } ]]} Ma propriété ressemble à ça [JsonProperty("variables")] [JsonExtensionData] public IDictionary<string, object> Variables = new Dictionary<string, object>();
    InformationsquelleAutor Brian Rogers
  2. 8

    Mettre en œuvre JsonConverterclasse dérivée: la CustomCreationConverter classe doit être utilisée comme classe de base pour créer un objet personnalisé.

    Projet de version du convertisseur (erreur de manipulation peut être améliorée, comme vous le souhaitez):

    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
}

    Code Client:

    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);

    Veuillez noter: il y a un risque de collision entre les noms de propriété et les principaux noms du dictionnaire.

    • Je vous remercie. Seulement un ajout: je pense que le mieux d'obtenir les propriétés de JsonContract (JsonObjectContract)serializer.ContractResolver.ResolveContract(typeof(Test)). L'utilisation de cette façon peut obtenir JsonPropertyAttribute valeurs.
    InformationsquelleAutor Sergey Brunov
  3. 2

    Vous pouvez créer ce convertisseur, puis l'affecter à votre propriété. A pris des morceaux de des solutions proposées.

    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));
}
}

    Ensuite l'utiliser dans votre classe poco.

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