Як виключити властивість з Json Serialization

У мене клас DTO, який я серіалізую

Json.Serialize(MyClass)

Як я можу виключити публічну власність цього?

(Це повинно бути загальнодоступним, оскільки я використовую його у своєму коді де-небудь ще)

Якщо ви використовуєте System.Web.Script.Serializationв .NET рамках, ви можете розмістити 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", щоб це працювало

Якщо ви використовуєте атрибут 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

Ви можете використовувати [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 і тоді ім'я будуть лише серіалізовані

Вибачте, що я вирішив написати ще одну відповідь, оскільки жодна з інших відповідей не є достатньо копіювальною.

Якщо ви не хочете прикрашати властивості деякими атрибутами, або у вас немає доступу до класу, або якщо ви хочете вирішити, що серіалізувати під час виконання, і т. Д. Тощо, ось як це зробити в Newtonsoft.Json

//short helper class to ignore some properties from serialization
public class IgnorePropertiesResolver : DefaultContractResolver
{
    private IEnumerable<string> _propsToIgnore;
    public IgnorePropertiesResolver(IEnumerable<string> propNamesToIgnore)
    {
        _propsToIgnore = propNamesToIgnore;
    }
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        JsonProperty property = base.CreateProperty(member, memberSerialization);
        property.ShouldSerialize = (x) => { return !_propsToIgnore.Contains(property.PropertyName); };
        return property;
    }
}

Використання

JsonConvert.SerializeObject(YourObject, new JsonSerializerSettings()
    { ContractResolver = new IgnorePropertiesResolver(new[] { "Prop1", "Prop2" }) };);

Я опублікував тут код на випадок, якщо хтось хоче щось додати

https://github.com/jitbit/JsonIgnoreProps

ВАЖЛИВО ОНОВЛЕННЯ: переконайтесь, що ви кешуєте ContractResolverоб’єкт, якщо ви вирішили використовувати цю відповідь, інакше може постраждати продуктивність.

Якщо ви не так зацікавлені в тому, щоб прикрашати код атрибутами, як я, особливо, коли ви не можете сказати під час компіляції, що буде тут, це моє рішення.

Використання серіалізатора 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
        }
    }

Якщо ви використовуєте, System.Text.Jsonто ви можете використовувати [JsonIgnore].
FQ:System.Text.Json.Serialization.JsonIgnoreAttribute

Офіційні документи Microsoft: JsonIgnoreAttribute

Як зазначено тут :

Бібліотека вбудована як частина загальної структури .NET Core 3.0.
Для інших цільових рамок встановіть пакет System.Text.Json NuGet. Пакет підтримує:

• .NET Standard 2.0 та новіших версій
• .NET Framework 4.6.1 та новіших версій
• .NET Core 2.0, 2.1 та 2.2

Ви також можете використовувати [NonSerialized]атрибут

[Serializable]
public struct MySerializableStruct
{
    [NonSerialized]
    public string hiddenField;
    public string normalField;
}

З документів MS :

Вказує, що поле класу, що серіалізується, не повинно бути серіалізованим. Цей клас не може бути успадкований.

Якщо ви, наприклад, використовуєте Unity ( це не тільки для Unity ), це працюєUnityEngine.JsonUtility

using UnityEngine;

MySerializableStruct mss = new MySerializableStruct 
{ 
    hiddenField = "foo", 
    normalField = "bar" 
};
Debug.Log(JsonUtility.ToJson(mss)); // result: {"normalField":"bar"}