c# - 如何从 Json 序列化中排除属性

Question

我有一个我序列化的 DTO 类

Json.Serialize(MyClass)

我怎样才能排除它的公共财产？

（它必须是公开的，因为我在其他地方的代码中使用它）

Answer 1

如果您使用 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

Answer 2

如果您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”的引用以使其正常工作

Answer 3

抱歉，我决定写另一个答案，因为其他答案都不够可复制粘贴。

如果您不想使用某些属性来装饰属性，或者您无权访问该类，或者您想决定在运行时序列化什么等等等等。这就是您在 Newtonsoft.Json 中的操作方式

//short helper class to ignore some properties from serialization
public class IgnorePropertiesResolver : DefaultContractResolver
{
    private readonly HashSet<string> ignoreProps;
    public IgnorePropertiesResolver(IEnumerable<string> propNamesToIgnore)
    {
        this.ignoreProps = new HashSet<string>(propNamesToIgnore);
    }

    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        JsonProperty property = base.CreateProperty(member, memberSerialization);
        if (this.ignoreProps.Contains(property.PropertyName))
        {
            property.ShouldSerialize = _ => false;
        }
        return property;
    }
}

用法

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

ContractResolver注意：如果您决定使用此答案，请确保缓存对象，否则性能可能会受到影响。

我已经在这里发布了代码，以防有人想添加任何东西

https://github.com/jitbit/JsonIgnoreProps

Answer 4

您可以使用[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 和名称只会被序列化

Answer 5

如果您不像我那样热衷于使用属性来装饰代码，尤其是当您无法在编译时知道这里会发生什么时，这就是我的解决方案。

使用 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
        }
    }

Answer 6

如果您正在使用，System.Text.Json那么您可以使用[JsonIgnore].
问答：System.Text.Json.Serialization.JsonIgnoreAttribute

微软官方文档：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

Answer 7

你也可以使用[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"}

Answer 8

为 dotnet core 添加 System.Text.Json 版本

对于编译时间，请按照上述答案中的建议添加 [JsonIgnore]。

对于运行时，需要将 JsonConverter 添加到选项中。

首先，为要排除的类型创建一个 JsonConverter，例如ICollection<LabMethod>下面

public class LabMethodConverter : JsonConverter<ICollection<LabMethod>>
{
    public override ICollection<LabMethod> Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        //deserialize JSON into a ICollection<LabMethod>
        return null;
    }

    public override void Write(Utf8JsonWriter writer, ICollection<LabMethod> value, JsonSerializerOptions options)
    {
        //serialize a ICollection<LabMethod> object
        writer.WriteNullValue();
    }
}

然后在序列化 Json 时添加到选项

var options = new JsonSerializerOptions();
options.Converters.Add(new LabMethodConverter());
var new_obj = Json(new { rows = slice, total = count }, options);