Comment puis-je changer les noms des propriétés lors de la sérialisation avec Json.net ?

Question

J'ai des données dans un objet C# DataSet. Je peux le sérialiser en utilisant un convertisseur Json.net comme ceci

DataSet data = new DataSet();
// do some work here to populate 'data'
string output = JsonConvert.SerializeObject(data);

Cependant, cela utilise les noms de propriétés de data lors de l'impression du fichier .json. Je voudrais changer les noms des propriétés pour qu'ils soient différents (par exemple, remplacer 'foo' par 'bar').

En el Documentation sur Json.net Dans la section "Serializing and Deserializing JSON", sous "Serialization Attributes", il est indiqué que "JsonPropertyAttribute... permet de personnaliser le nom". Mais il n'y a pas d'exemple. Quelqu'un sait-il comment utiliser un JsonPropertyAttribute pour changer le nom de la propriété en quelque chose d'autre ?

( Lien direct vers la documentation )

La documentation de Json.net semble être clairsemée. Si vous avez un bon exemple, j'essaierai de le faire ajouter à la documentation officielle. Merci !

Answer 1

Vous pouvez décorer la propriété que vous souhaitez en contrôlant son nom avec la balise [JsonProperty] qui vous permet de spécifier un nom différent :

using Newtonsoft.Json;
// ...

[JsonProperty(PropertyName = "FooBar")]
public string Foo { get; set; }

Documentation : Attributs de sérialisation

Answer 2

Si vous n'avez pas accès aux classes pour modifier les propriétés, ou si vous ne voulez pas toujours utiliser la même propriété de renommage, le renommage peut également être effectué en créant un résolveur personnalisé.

Par exemple, si vous avez une classe appelée MyCustomObject qui a une propriété appelée LongPropertyName vous pouvez utiliser un résolveur personnalisé comme ceci

public class CustomDataContractResolver : DefaultContractResolver
{
  public static readonly CustomDataContractResolver Instance = new CustomDataContractResolver ();

  protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
  {
    var property = base.CreateProperty(member, memberSerialization);
    if (property.DeclaringType == typeof(MyCustomObject))
    {
      if (property.PropertyName.Equals("LongPropertyName", StringComparison.OrdinalIgnoreCase))
      {
        property.PropertyName = "Short";
      }
    }
    return property;
  }
}

Ensuite, appelez la sérialisation et fournissez le résolveur :

 var result = JsonConvert.SerializeObject(myCustomObjectInstance,
                new JsonSerializerSettings { ContractResolver = CustomDataContractResolver.Instance });

Et le résultat sera raccourci à {"Short" : "prop value"} au lieu de {"LongPropertyName" : "valeur de la propriété"}

Plus d'informations sur les résolveurs personnalisés ici

Answer 3

Il existe encore une autre façon de procéder, qui consiste à utiliser une méthode particulière Stratégie de dénomination qui peuvent être appliqués à une classe ou à une propriété en les décorant de la mention [JSonObject] o [JsonProperty] .

Il existe des stratégies de dénomination prédéfinies comme CamelCaseNamingStrategy mais vous pouvez mettre en œuvre les vôtres.

La mise en œuvre de différentes stratégies de dénomination peut être consultée ici : https://github.com/JamesNK/Newtonsoft.Json/tree/master/Src/Newtonsoft.Json/Serialization