.NET NewtonSoft JSON десериализует карту с другим именем свойства

294

У меня есть следующая строка JSON, полученная от внешней стороны.

{
   "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"
         }
      }
   ]
}

Мои классы картирования:

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

Вопрос в том, что мне не нравятся Attributes имя класса и attributes имена полей в Teamклассе. Вместо этого я хочу, чтобы он был назван, TeamScoreа также удалял _из имен полей и давал имена собственные.

JsonConvert.DeserializeObject<RootObject>(jsonText);

Я могу переименовать Attributesв TeamScore, но если я изменю имя поля ( attributesв Teamклассе), оно не будет десериализовано должным образом и даст мне null. Как я могу преодолеть это?

JenonD
источник

Ответы:

572

Json.NET имеет, JsonPropertyAttributeчто позволяет вам указать имя свойства JSON, поэтому ваш код должен быть:

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

Документация: атрибуты сериализации

outcoldman
источник
2
Могу ли я использовать два JsonProperty для одного поля?
Али Юсефи
1
@AliYousefie Не думай так. Но хороший вопрос будет, что вы ожидаете получить от этого?
Outcoldman
5
у меня есть интерфейс, два интерфейса используются этот интерфейс, но данные сервера имеют два имени свойства для двух классов, я хочу использовать два JsonProperty для одного свойства в моих интерфейсах.
Али Юсефи
как мы можем быть уверены, что ответ [пустынный объект] будет иметь значение для EightyMinScore, а не восемьдесят_мин_score
Гаурравс
В моем случае я отправляю RootObject как окончательный ответ, но когда я читаю его как json из окончательного ответа, восемьдесят_мин_score показывается со значением, а не с EightyMinScore
Gaurravs
115

Если вы хотите использовать динамическое отображение и не хотите загромождать свою модель атрибутами, этот подход сработал для меня

Использование:

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

Логика:

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
Я немного упростил это для моих целей, но это лучшее решение, чем «загромождай свою модель / домен»;)
Андреас
4
Вот это да. Это эпично; гораздо более архитектурно обоснованный способ сделать это.
Дэвид Бец
1
Возможно, (если вы создадите более одного из них) стоит переместить словарь, найти код в базовом классе для всех сопоставлений свойств и позволить им добавлять свойства, но игнорировать детали того, как происходит сопоставление. Возможно, стоит добавить это в сам Json.Net.
Джеймс Уайт
Это должен быть приемлемый ответ, потому что, как сказал @DavidBetz, это лучший дизайн.
im1dermike
Это решение также работает с вложенными свойствами? Я попытался десериализовать объект с вложенными свойствами, и он не работает.
Ави К.
8

Добавляем в домкрат решение. Мне нужно десериализовать с помощью JsonProperty и Serialize, игнорируя JsonProperty (или наоборот). ReflectionHelper и Attribute Helper - это просто вспомогательные классы, которые получают список свойств или атрибутов для свойства. Я могу включить, если кому-то все равно. Используя приведенный ниже пример, вы можете сериализовать модель представления и получить «Amount», даже если JsonProperty имеет значение «RecurringPrice».

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

Использование:

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

Модель:

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; }
}
Rentering.com
источник
2
Спасибо за ваш IgnoreJsonPropertyResolver, так как я хотел сделать то же самое (игнорировать JsonProperty только при сериализации). К сожалению, ваше решение работает только для атрибутов верхнего уровня, а не для вложенных типов. Правильный способ игнорировать все атрибуты JsonProperty при сериализации - переопределить CreatePropertyв ContractResolver. Там называют базу: var jsonProperty = base.CreateProperty(memberInfo, memberSerialization);а потом устанавливаем jsonProperty.PropertyName = memberInfo.Name;. Наконец return jsonProperty;это все, что вам нужно.
Нейт Кук,
1
что это за помощники?
DeadManN
1
@NateCook Можете ли вы показать мне образец? мне это очень нужно прямо сейчас
deadManN
4

Раскрывая ответ Rentering.com , в сценариях, когда необходимо позаботиться о целом графике многих типов, и вы ищете строго типизированное решение, этот класс может помочь, см. Использование (свободно) ниже. Он работает как черный список или белый список для каждого типа. Тип не может быть и тем и другим ( Gist - также содержит глобальный список игнорирования).

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

Использование:

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

Я использую атрибуты JsonProperty при сериализации, но игнорирую их при десериализации с использованием этого 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;
        }
    }

Метод ContractResolverjust устанавливает каждое свойство обратно на имя свойства класса (упрощенное из решения Шимми). Использование:

var airplane= JsonConvert.DeserializeObject<Airplane>(json, 
    new JsonSerializerSettings { ContractResolver = new IgnoreJsonPropertyContractResolver() });
Jovie
источник