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

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

Json.Serialize(MyClass)

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

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

Если вы используете System.Web.Script.Serializationв .NET Framework, вы можете поместить 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-reduc-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); }
    }
}

Ссылка здесь

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

Извините, я решил написать еще один ответ, поскольку ни один из других ответов не является достаточно копируемым.

Если вы не хотите украшать свойства некоторыми атрибутами, или если у вас нет доступа к классу, или если вы хотите решить, что сериализовать во время выполнения и т. Д. И т. Д., Вот как вы это делаете в 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.
Для других целевых платформ установите пакет NuGet System.Text.Json. Пакет поддерживает:

• .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"}