Como excluir propriedade da serialização Json

Eu tenho uma classe DTO que eu serializo

Json.Serialize(MyClass)

Como posso excluir uma propriedade pública dela?

(Tem que ser público, pois eu o uso no meu código em outro lugar)

Se você estiver usando System.Web.Script.Serializationna estrutura .NET, poderá colocar um ScriptIgnoreatributo nos membros que não devem ser serializados. Veja o exemplo retirado daqui :

Considere o seguinte caso (simplificado):

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

Nesse caso, apenas as propriedades Id e Name serão serializadas; portanto, o objeto JSON resultante ficaria assim:

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

PS. Não se esqueça de adicionar uma referência a " System.Web.Extensions" para que isso funcione

Se você estiver usando o atributo Json.Net[JsonIgnore] , simplesmente ignorará o campo / propriedade ao serializar ou desserializar.

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; }
}

Ou você pode usar o atributo DataContract e DataMember para serializar / desserializar seletivamente propriedades / campos.

[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; }
}

Consulte http://james.newtonking.com/archive/2009/10/23/efficient-json-with-json-net-reducing-serialized-json-size para obter mais detalhes

Você pode usar [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); }
    }
}

Referência aqui

Nesse caso, o ID e o nome serão serializados apenas

Desculpe, decidi escrever outra resposta, já que nenhuma das outras respostas é passível de cópia.

Se você não deseja decorar propriedades com alguns atributos, ou se não tem acesso à classe, ou se deseja decidir o que serializar durante o tempo de execução, etc. etc., veja como fazê-lo no Newtonsoft.

//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;
    }
}

Uso

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

Publiquei o código aqui, caso alguém queira adicionar algo

https://github.com/jitbit/JsonIgnoreProps

ATUALIZAÇÃO IMPORTANTE: certifique-se de armazenar em cache o ContractResolverobjeto se você decidir usar esta resposta, caso contrário, o desempenho poderá sofrer.

Se você não está tão interessado em decorar o código com os Atributos como eu, especialmente quando você não pode dizer em tempo de compilação, o que acontecerá aqui é a minha solução.

Usando o serializador 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
        }
    }

Se você estiver usando System.Text.Json, poderá usar [JsonIgnore].
FQ:System.Text.Json.Serialization.JsonIgnoreAttribute

Documentos oficiais da Microsoft: JsonIgnoreAttribute

Como indicado aqui :

A biblioteca é interna como parte da estrutura compartilhada do .NET Core 3.0.
Para outras estruturas de destino, instale o pacote System.Text.Json NuGet. O pacote suporta:

• .NET Standard 2.0 e versões posteriores
• .NET Framework 4.6.1 e versões posteriores
• .NET Core 2.0, 2.1 e 2.2

Você também pode usar o [NonSerialized]atributo

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

Dos documentos da MS :

Indica que um campo de uma classe serializável não deve ser serializado. Essa classe não pode ser herdada.

Se você estiver usando o Unity, por exemplo ( isso não é apenas para o Unity ), isso funcionará comUnityEngine.JsonUtility

using UnityEngine;

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