json.netにカスタム属性を追加

Question

JSON.NETには、[JsonIgnore]と[JsonProperty]のようなプロパティ属性が付属しています。

シリアル化が実行されたときに実行されるカスタムカスタムアイテムを作成したいとします。 [JsonIgnoreSerialize]または[JsonIgnoreDeserialize]

これを含めるようにフレームワークを拡張するにはどうすればよいですか？

Answer 1

目的はシリアル化ではなく非シリアル化でプロパティを無視することですので、ContractResolverを使用できます。

次のクラスはキャンプケースのJsonフィールドにシリアル化されていることを確認するために、CamelCasePropertyNamesContractResolverに基づいています。あなたがそれを望まないなら、代わりにDefaultContractResolverから継承させることができます。

また、自分自身は文字列の名前に基づいていますが、プロパティ名を比較する代わりに、カスタム属性で修飾されているかどうかを簡単に確認できます。次のように

public class CamelCaseIgnoringPropertyJsonResolver<T> : CamelCasePropertyNamesContractResolver 
{   
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization) 
    { 
     // list the properties to ignore 
     var propertiesToIgnore = type.GetProperties() 
       .Where(x => x.GetCustomAttributes().OfType<T>().Any()); 

     // Build the properties list 
     var properties = base.CreateProperties(type, memberSerialization); 

     // only serialize properties that are not ignored 
     properties = properties 
      .Where(p => propertiesToIgnore.All(info => info.Name != p.UnderlyingName)) 
      .ToList(); 

     return properties; 
    } 
} 

その後、あなたはそれを使用することができます。

static private string SerializeMyObject(object myObject) 
    { 
     var settings = new JsonSerializerSettings 
     { 
      ContractResolver = new CamelCaseIgnoringPropertyJsonResolver<JsonIgnoreSerializeAttribute>() 
     }; 

     var json = JsonConvert.SerializeObject(myObject, settings); 
     return json; 
    } 

最後に、カスタム属性は、任意のタイプのものとすることができるが、例を一致させるために：

internal class JsonIgnoreSerializeAttribute : Attribute 
{ 
} 

アプローチがありますテストされ、ネストされたオブジェクトでも動作します。あなたは

このような

public class MyContractResolver<T> : Newtonsoft.Json.Serialization.DefaultContractResolver 
             where T : Attribute 
{ 
    Type _AttributeToIgnore = null; 

    public MyContractResolver() 
    { 
     _AttributeToIgnore = typeof(T); 
    } 

    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization) 
    { 
     var list = type.GetProperties() 
        .Where(x => !x.GetCustomAttributes().Any(a => a.GetType() == _AttributeToIgnore)) 
        .Select(p => new JsonProperty() 
        { 
         PropertyName = p.Name, 
         PropertyType = p.PropertyType, 
         Readable = true, 
         Writable = true, 
         ValueProvider = base.CreateMemberValueProvider(p) 
        }).ToList(); 

     return list; 
    } 
} 

カスタム契約リゾルバを書くことができます

Answer 2

あなたは

var json = JsonConvert.SerializeObject(
      obj, 
      new JsonSerializerSettings() { 
       ContractResolver = new MyContractResolver<JsonIgnoreSerialize>() 
      }); 

var obj = JsonConvert.DeserializeObject<SomeType>(
      json, 
      new JsonSerializerSettings() { 
       ContractResolver = new MyContractResolver<JsonIgnoreDeserialize>() 
      });