Как исключить свойство из сериализации Json

Question

Как исключить свойство из сериализации Json

У меня есть класс DTO, который я Сериализую

Json.Serialize(MyClass)

Как я могу исключить a общественные собственность это?

(он должен быть публичным, так как я использую его в своем коде где-то еще)

598 4

c#json

4 ответов:

Comments

Ничего не найдено.

Pavel Krymets · Accepted Answer · 2015-10-21 12:49:21

вы можете поставить 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" для этого работа

JC Raja · Accepted Answer · 2014-08-29 13:24:54

Если вы используете 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 для более подробной информации

Arion · Accepted Answer · 2012-04-16 09:37:35

можно использовать [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); }
    }
}
ссылка здесь

в этом случае идентификатор, а затем имя будут только сериализованы

Thulani Chivandikwa · Accepted Answer · 2015-07-29 10:01:02

Если вы не так заинтересованы в том, чтобы украсить код атрибутами, как я, 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
        }
    }