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

私は名前を変更することが可能AttributesTeamScore、私は(フィールド名を変更した場合attributesにはTeam、クラス)、それが適切にデシリアライズと私を与えませんnull。どうすればこれを克服できますか?


回答:


572

Json.NETにJsonPropertyAttributeJSONプロパティの名前を指定できるがあるので、コードは次のようになります。

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

ドキュメント:シリアル化属性


2
1つのファイルに2つのJsonPropertyを使用できますか?
Ali Yousefi、2015年

1
@AliYousefieそう思わないでください。しかし、良い質問は、あなたはそれから何を得ると期待していますか?
outcoldman、2015

5
私はインターフェイスを持っていますが、このインターフェイスには2つのクラスが使用されていますが、サーバーデータには2つのクラスに2つのプロパティ名があります。インターフェイスの1つのプロパティに2つのJsonPropertyを使用します。
Ali Yousefi 2016

応答[非直列化オブジェクト]に、eighty_min_scoreではなくEightyMinScoreの値があることを確認するにはどうすればよいですか
Gaurravs

私の場合、RootObjectを最終応答として送信していますが、最終応答からjsonとして読み取ると、eighty_min_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
私の目的のために少し単純化しましたが、これは「モデル/ドメインを整理する」よりも優れたソリューションです;)
Andreas

4
ワオ。それは壮大です。それを実行するための、よりアーキテクチャ的に健全な方法。
David Betz

1
(これらを複数作成する場合)ディクショナリを移動する価値があるかもしれません。すべてのプロパティマッピングの基本クラスまでコードを検索し、プロパティの追加を許可しますが、マッピングの発生方法の詳細は無視します。それをJson.Net自体に追加するだけの価値があるかもしれません。
James White

@DavidBetzが言ったように、これは最良の設計であるため、これは許容できる答えになるはずです。
im1dermike

このソリューションはネストされたプロパティでも機能しますか?ネストされたプロパティを持つオブジェクトを逆シリアル化しようとしましたが、機能しません。
Avi K.16年

8

Jacksソリューションに追加します。JsonPropertyを無視して、JsonPropertyとSerializeを使用して逆シリアル化する必要があります(またはその逆)。ReflectionHelperおよびAttribute Helperは、プロパティのリストまたはプロパティの属性を取得するヘルパークラスです。誰かが実際に気にかけている場合は含めることができます。以下の例を使用すると、JsonPropertyが「RecurringPrice」であっても、viewmodelをシリアル化して「Amount」を取得できます。

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

2
IgnoreJsonPropertyResolverに感謝します。私が同じことをしようとしていたためです(シリアル化でのみJsonPropertyを無視してください)。残念ながら、このソリューションはトップレベルの属性でのみ機能し、ネストされたタイプでは機能しません。シリアル化時にすべてのJsonProperty属性を無視する適切な方法CreatePropertyは、ContractResolverでオーバーライドすることです。そこでbase:var jsonProperty = base.CreateProperty(memberInfo, memberSerialization);を呼び出し、次にsetを設定しjsonProperty.PropertyName = memberInfo.Name;ます。最後に、return jsonProperty;それで十分です。
ネイトクック

1
これらのヘルパーは何ですか?
deadManN 2016

1
@NateCookにサンプルを見せてもらえますか?私は今それをひどく必要としています
deadManN

4

Rentering.comの回答を展開すると、多くのタイプのグラフ全体が処理されるシナリオで、強く型付けされたソリューションを探している場合、このクラスが役立ちます。以下の使用法(流暢)を参照してください。タイプごとにブラックリストまたはホワイトリストとして動作します。タイプを両方にすることはできません(要旨 -グローバル無視リストも含まれます)。

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

ContractResolverちょうど(シミーの溶液から簡体字)クラスのプロパティ名にすべてのプロパティバックを設定します。使用法:

var airplane= JsonConvert.DeserializeObject<Airplane>(json, 
    new JsonSerializerSettings { ContractResolver = new IgnoreJsonPropertyContractResolver() });
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.