.NET NewtonSoft JSON deserializza la mappa con un nome di proprietà diverso


294

Ho seguito la stringa JSON ricevuta da una parte esterna.

{
   "team":[
      {
         "v1":"",
         "attributes":{
            "eighty_min_score":"",
            "home_or_away":"home",
            "score":"22",
            "team_id":"500"
         }
      },
      {
         "v1":"",
         "attributes":{
            "eighty_min_score":"",
            "home_or_away":"away",
            "score":"30",
            "team_id":"600"
         }
      }
   ]
}

Le mie lezioni di mappatura:

public class Attributes
{
    public string eighty_min_score { get; set; }
    public string home_or_away { get; set; }
    public string score { get; set; }
    public string team_id { get; set; }
}

public class Team
{
    public string v1 { get; set; }
    public Attributes attributes { get; set; }
}

public class RootObject
{
    public List<Team> team { get; set; }
}

La domanda è che non mi piacciono il Attributes nome della classe e i attributes nomi dei campi nella Teamclasse. Invece, voglio che sia nominato TeamScoree anche da rimuovere _dai nomi dei campi e dare nomi propri.

JsonConvert.DeserializeObject<RootObject>(jsonText);

Posso rinominare Attributesin TeamScore, ma se cambio il nome del campo ( attributesnella Teamclasse), non si deserializzerà correttamente e mi darà null. Come posso superare questo?


Risposte:


572

Json.NET ha una JsonPropertyAttributeche ti consente di specificare il nome di una proprietà JSON, quindi il tuo codice dovrebbe essere:

public class TeamScore
{
    [JsonProperty("eighty_min_score")]
    public string EightyMinScore { get; set; }
    [JsonProperty("home_or_away")]
    public string HomeOrAway { get; set; }
    [JsonProperty("score ")]
    public string Score { get; set; }
    [JsonProperty("team_id")]
    public string TeamId { get; set; }
}

public class Team
{
    public string v1 { get; set; }
    [JsonProperty("attributes")]
    public TeamScore TeamScores { get; set; }
}

public class RootObject
{
    public List<Team> Team { get; set; }
}

Documentazione: attributi di serializzazione


2
posso usare due JsonProperty per uno archiviato?
Ali Yousefi,

1
@AliYousefie Non la penso così. Ma la buona domanda sarà: cosa ti aspetti da questo?
outcoldman il

5
ho un'interfaccia, due classi sono utilizzate questa interfaccia, ma i dati del server hanno due nomi di proprietà per due classi, voglio usare due JsonProperty per una proprietà nelle mie interfacce.
Ali Yousefi,

come possiamo assicurarci che la risposta [oggetto deserilizzato] abbia valore per EightyMinScore e non per ottavo_min_score
Gaurravs

Nel mio caso sto inviando RootObject come risposta finale, ma quando lo leggo come json dalla risposta finale, ottanta_min_score viene mostrato con valore e non con EightyMinScore
Gaurravs

115

Se desideri utilizzare la mappatura dinamica e non vuoi ingombrare il tuo modello con attributi, questo approccio ha funzionato per me

Uso:

var settings = new JsonSerializerSettings();
settings.DateFormatString = "YYYY-MM-DD";
settings.ContractResolver = new CustomContractResolver();
this.DataContext = JsonConvert.DeserializeObject<CountResponse>(jsonString, settings);

Logica:

public class CustomContractResolver : DefaultContractResolver
{
    private Dictionary<string, string> PropertyMappings { get; set; }

    public CustomContractResolver()
    {
        this.PropertyMappings = new Dictionary<string, string> 
        {
            {"Meta", "meta"},
            {"LastUpdated", "last_updated"},
            {"Disclaimer", "disclaimer"},
            {"License", "license"},
            {"CountResults", "results"},
            {"Term", "term"},
            {"Count", "count"},
        };
    }

    protected override string ResolvePropertyName(string propertyName)
    {
        string resolvedName = null;
        var resolved = this.PropertyMappings.TryGetValue(propertyName, out resolvedName);
        return (resolved) ? resolvedName : base.ResolvePropertyName(propertyName);
    }
}

1
L'ho semplificato un po 'per il mio scopo, ma questa è una soluzione migliore di "ingombrare il tuo modello / dominio";)
Andreas,

4
Wow. È epico; modo molto più architettonicamente solido di farlo.
David Betz,

1
Potrebbe essere utile (se si crea più di uno di questi) spostare il dizionario, cercare il codice in una classe base per tutti i mapping delle proprietà e consentire loro di aggiungere proprietà, ma ignorare i dettagli di come avviene il mapping. Potrebbe valere la pena aggiungerlo a Json.Net stesso.
James White il

Questa dovrebbe essere la risposta accettabile perché, come diceva @DavidBetz, è il miglior design.
im1dermike,

Questa soluzione funziona anche con proprietà nidificate? Ho provato a deserializzare un oggetto con proprietà nidificate e non funziona.
Avi K.,

8

Aggiunta alla soluzione Jacks. Devo deserializzare usando JsonProperty e Serialize mentre ignoro JsonProperty (o viceversa). ReflectionHelper e Attribute Helper sono solo classi di supporto che ottengono un elenco di proprietà o attributi per una proprietà. Posso includere se a qualcuno importa davvero. Utilizzando l'esempio seguente è possibile serializzare il modello di visualizzazione e ottenere "Importo" anche se JsonProperty è "Prezzo ricorrente".

    /// <summary>
    /// Ignore the Json Property attribute. This is usefule when you want to serialize or deserialize differently and not 
    /// let the JsonProperty control everything.
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public class IgnoreJsonPropertyResolver<T> : DefaultContractResolver
    {
        private Dictionary<string, string> PropertyMappings { get; set; }

        public IgnoreJsonPropertyResolver()
        {
            this.PropertyMappings = new Dictionary<string, string>();
            var properties = ReflectionHelper<T>.GetGetProperties(false)();
            foreach (var propertyInfo in properties)
            {
                var jsonProperty = AttributeHelper.GetAttribute<JsonPropertyAttribute>(propertyInfo);
                if (jsonProperty != null)
                {
                    PropertyMappings.Add(jsonProperty.PropertyName, propertyInfo.Name);
                }
            }
        }

        protected override string ResolvePropertyName(string propertyName)
        {
            string resolvedName = null;
            var resolved = this.PropertyMappings.TryGetValue(propertyName, out resolvedName);
            return (resolved) ? resolvedName : base.ResolvePropertyName(propertyName);
        }
    }

Uso:

        var settings = new JsonSerializerSettings();
        settings.DateFormatString = "YYYY-MM-DD";
        settings.ContractResolver = new IgnoreJsonPropertyResolver<PlanViewModel>();
        var model = new PlanViewModel() {Amount = 100};
        var strModel = JsonConvert.SerializeObject(model,settings);

Modello:

public class PlanViewModel
{

    /// <summary>
    ///     The customer is charged an amount over an interval for the subscription.
    /// </summary>
    [JsonProperty(PropertyName = "RecurringPrice")]
    public double Amount { get; set; }

    /// <summary>
    ///     Indicates the number of intervals between each billing. If interval=2, the customer would be billed every two
    ///     months or years depending on the value for interval_unit.
    /// </summary>
    public int Interval { get; set; } = 1;

    /// <summary>
    ///     Number of free trial days that can be granted when a customer is subscribed to this plan.
    /// </summary>
    public int TrialPeriod { get; set; } = 30;

    /// <summary>
    /// This indicates a one-time fee charged upfront while creating a subscription for this plan.
    /// </summary>
    [JsonProperty(PropertyName = "SetupFee")]
    public double SetupAmount { get; set; } = 0;


    /// <summary>
    /// String representing the type id, usually a lookup value, for the record.
    /// </summary>
    [JsonProperty(PropertyName = "TypeId")]
    public string Type { get; set; }

    /// <summary>
    /// Billing Frequency
    /// </summary>
    [JsonProperty(PropertyName = "BillingFrequency")]
    public string Period { get; set; }


    /// <summary>
    /// String representing the type id, usually a lookup value, for the record.
    /// </summary>
    [JsonProperty(PropertyName = "PlanUseType")]
    public string Purpose { get; set; }
}

2
Grazie per IgnoreJsonPropertyResolver, poiché stavo cercando di fare la stessa cosa (ignorare JsonProperty solo sulla serializzazione). Sfortunatamente la tua soluzione funziona solo per attributi di livello superiore e non per tipi nidificati. Il modo corretto di ignorare tutti gli attributi JsonProperty durante la serializzazione è quello di eseguire CreatePropertyl' override in ContractResolver. Lì chiama la base: var jsonProperty = base.CreateProperty(memberInfo, memberSerialization);e poi imposta jsonProperty.PropertyName = memberInfo.Name;. Finalmente return jsonProperty;è tutto ciò di cui hai bisogno.
Nate Cook,

1
cosa sono questi aiutanti?
deadManN

1
@NateCook puoi mostrarmi un campione? ne ho
davvero

4

Espandendo la risposta di Rentering.com , negli scenari in cui è necessario occuparsi di un intero grafico di molti tipi e stai cercando una soluzione fortemente tipizzata, questa classe può aiutarti, vedi l'uso (fluente) di seguito. Funziona come una lista nera o una lista bianca per tipo. Un tipo non può essere entrambi ( Gist - contiene anche un elenco globale di ignorare).

public class PropertyFilterResolver : DefaultContractResolver
{
  const string _Err = "A type can be either in the include list or the ignore list.";
  Dictionary<Type, IEnumerable<string>> _IgnorePropertiesMap = new Dictionary<Type, IEnumerable<string>>();
  Dictionary<Type, IEnumerable<string>> _IncludePropertiesMap = new Dictionary<Type, IEnumerable<string>>();
  public PropertyFilterResolver SetIgnoredProperties<T>(params Expression<Func<T, object>>[] propertyAccessors)
  {
    if (propertyAccessors == null) return this;

    if (_IncludePropertiesMap.ContainsKey(typeof(T))) throw new ArgumentException(_Err);

    var properties = propertyAccessors.Select(GetPropertyName);
    _IgnorePropertiesMap[typeof(T)] = properties.ToArray();
    return this;
  }

  public PropertyFilterResolver SetIncludedProperties<T>(params Expression<Func<T, object>>[] propertyAccessors)
  {
    if (propertyAccessors == null)
      return this;

    if (_IgnorePropertiesMap.ContainsKey(typeof(T))) throw new ArgumentException(_Err);

    var properties = propertyAccessors.Select(GetPropertyName);
    _IncludePropertiesMap[typeof(T)] = properties.ToArray();
    return this;
  }

  protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
  {
    var properties = base.CreateProperties(type, memberSerialization);

    var isIgnoreList = _IgnorePropertiesMap.TryGetValue(type, out IEnumerable<string> map);
    if (!isIgnoreList && !_IncludePropertiesMap.TryGetValue(type, out map))
      return properties;

    Func<JsonProperty, bool> predicate = jp => map.Contains(jp.PropertyName) == !isIgnoreList;
    return properties.Where(predicate).ToArray();
  }

  string GetPropertyName<TSource, TProperty>(
  Expression<Func<TSource, TProperty>> propertyLambda)
  {
    if (!(propertyLambda.Body is MemberExpression member))
      throw new ArgumentException($"Expression '{propertyLambda}' refers to a method, not a property.");

    if (!(member.Member is PropertyInfo propInfo))
      throw new ArgumentException($"Expression '{propertyLambda}' refers to a field, not a property.");

    var type = typeof(TSource);
    if (!type.GetTypeInfo().IsAssignableFrom(propInfo.DeclaringType.GetTypeInfo()))
      throw new ArgumentException($"Expresion '{propertyLambda}' refers to a property that is not from type '{type}'.");

    return propInfo.Name;
  }
}

Uso:

var resolver = new PropertyFilterResolver()
  .SetIncludedProperties<User>(
    u => u.Id, 
    u => u.UnitId)
  .SetIgnoredProperties<Person>(
    r => r.Responders)
  .SetIncludedProperties<Blog>(
    b => b.Id)
  .Ignore(nameof(IChangeTracking.IsChanged)); //see gist

0

Sto usando gli attributi JsonProperty durante la serializzazione ma li ignoro quando deserializzo usando questo ContractResolver:

public class IgnoreJsonPropertyContractResolver: DefaultContractResolver
    {
        protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
        {
            var properties = base.CreateProperties(type, memberSerialization);
            foreach (var p in properties) { p.PropertyName = p.UnderlyingName; }
            return properties;
        }
    }

Il ContractResolvercomando ripristina ogni proprietà sul nome della proprietà della classe (semplificata dalla soluzione di Shimmy). Uso:

var airplane= JsonConvert.DeserializeObject<Airplane>(json, 
    new JsonSerializerSettings { ContractResolver = new IgnoreJsonPropertyContractResolver() });
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.