web-dev-qa-db-ja.com

Json Serializationからプロパティを除外する方法

私はシリアル化するDTOクラスを持っています

Json.Serialize(MyClass)

publicプロパティを除外するにはどうすればいいですか？

（私のコードのどこかで使用しているので、それは公開されている必要があります）

c#json
198
Elad Benda

.NETフレームワークでSystem.Web.Script.Serializationを使用している場合、シリアル化してはいけないメンバーに ScriptIgnore 属性を設定できます。 ここ から取った例を参照してください。

次の（単純化された）ケースを考えてください。

public class User {
    public int Id { get; set; }
    public string Name { get; set; }
    [ScriptIgnore]
    public bool IsComplete
    {
        get { return Id > 0 && !string.IsNullOrEmpty(Name); }
    } 
}

この場合、IdプロパティとNameプロパティのみがシリアル化されるため、結果のJSONオブジェクトは次のようになります。

{ Id: 3, Name: 'Test User' }

PS。これを機能させるために "System.Web.Extensions"への参照を追加することを忘れないでください

127
Pavel Krymets

Json.Netを使用している場合、属性[JsonIgnore]はシリアライズまたはデシリアライズ中にフィールド/プロパティを単に無視します。

public class Car
{
  // included in JSON
  public string Model { get; set; }
  public DateTime Year { get; set; }
  public List<string> Features { get; set; }

  // ignored
  [JsonIgnore]
  public DateTime LastModified { get; set; }
}

あるいは、DataContractおよびDataMember属性を使用して、プロパティ/フィールドを選択的にシリアル化/逆シリアル化することもできます。

[DataContract]
public class Computer
{
  // included in JSON
  [DataMember]
  public string Name { get; set; }
  [DataMember]
  public decimal SalePrice { get; set; }

  // ignored
  public string Manufacture { get; set; }
  public int StockCount { get; set; }
  public decimal WholeSalePrice { get; set; }
  public DateTime NextShipmentDate { get; set; }
}

詳しくは http://james.newtonking.com/archive/2009/10/23/efficient-json-with-json-net-reducing-serialized-json-size を参照してください。

290
JC Raja

[ScriptIgnore]を使うことができます：

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    [ScriptIgnore]
    public bool IsComplete
    {
        get { return Id > 0 && !string.IsNullOrEmpty(Name); }
    }
}

参考資料 こちら

この場合、IDと名前はシリアライズされるだけです

30
Arion

私がそうであるようにあなたがコードでAttributesでコードを飾ることにそれほど熱心でないなら、ここで起こることがコンパイル時に言うことができないときespは私の解決策です。

Javascriptシリアライザの使い方

    public static class JsonSerializerExtensions
    {
        public static string ToJsonString(this object target,bool ignoreNulls = true)
        {
            var javaScriptSerializer = new JavaScriptSerializer();
            if(ignoreNulls)
            {
                javaScriptSerializer.RegisterConverters(new[] { new PropertyExclusionConverter(target.GetType(), true) });
            }
            return javaScriptSerializer.Serialize(target);
        }

        public static string ToJsonString(this object target, Dictionary<Type, List<string>> ignore, bool ignoreNulls = true)
        {
            var javaScriptSerializer = new JavaScriptSerializer();
            foreach (var key in ignore.Keys)
            {
                javaScriptSerializer.RegisterConverters(new[] { new PropertyExclusionConverter(key, ignore[key], ignoreNulls) });
            }
            return javaScriptSerializer.Serialize(target);
        }
    }


public class PropertyExclusionConverter : JavaScriptConverter
    {
        private readonly List<string> propertiesToIgnore;
        private readonly Type type;
        private readonly bool ignoreNulls;

        public PropertyExclusionConverter(Type type, List<string> propertiesToIgnore, bool ignoreNulls)
        {
            this.ignoreNulls = ignoreNulls;
            this.type = type;
            this.propertiesToIgnore = propertiesToIgnore ?? new List<string>();
        }

        public PropertyExclusionConverter(Type type, bool ignoreNulls)
            : this(type, null, ignoreNulls){}

        public override IEnumerable<Type> SupportedTypes
        {
            get { return new ReadOnlyCollection<Type>(new List<Type>(new[] { this.type })); }
        }

        public override IDictionary<string, object> Serialize(object obj, JavaScriptSerializer serializer)
        {
            var result = new Dictionary<string, object>();
            if (obj == null)
            {
                return result;
            }
            var properties = obj.GetType().GetProperties();
            foreach (var propertyInfo in properties)
            {
                if (!this.propertiesToIgnore.Contains(propertyInfo.Name))
                {
                    if(this.ignoreNulls && propertyInfo.GetValue(obj, null) == null)
                    {
                         continue;
                    }
                    result.Add(propertyInfo.Name, propertyInfo.GetValue(obj, null));
                }
            }
            return result;
        }

        public override object Deserialize(IDictionary<string, object> dictionary, Type type, JavaScriptSerializer serializer)
        {
            throw new NotImplementedException(); //Converter is currently only used for ignoring properties on serialization
        }
    }
12
Thulani Chivandikwa