Newtonsoft Json.NET 不序列化 [Obsolete] 属性

Question

有没有办法将 Json.NET 配置为不序列化具有[Obsolete]属性的属性？

例如

public class Foo
{
    public int Id { get; set; }

    [Obsolete]
    public int Age { get; set; }
 }

 var foo = new Foo { Id = 123, Age = 23 };
 var json = JsonConvert.SerializeObject(foo);

在上面的例子中，json 是{"Id":123,"Age":23}

我想要{"Id":123}

Answer 1

是的，您可以使用自定义ContractResolver来排除标记为过时的属性。
这是解析器所需的代码：

public class ExcludeObsoletePropertiesResolver : DefaultContractResolver
{
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        JsonProperty prop = base.CreateProperty(member, memberSerialization);
        if (prop.AttributeProvider.GetAttributes(true).OfType<ObsoleteAttribute>().Any())
        {
            prop.ShouldSerialize = obj => false;
        }
        return prop;
    }
}

然后像这样使用它：

var settings = new JsonSerializerSettings
{
    ContractResolver = new ExcludeObsoletePropertiesResolver()
};
var json = JsonConvert.SerializeObject(foo, settings);

这里的工作演示： https : //dotnetfiddle.net/gIRCD4

Answer 2

您可以使用此处记录的条件序列化： https : //www.newtonsoft.com/json/help/html/ConditionalProperties.htm

如果您可以控制类并希望针对您预先知道的特定属性，那么使用第一种机制会更容易，提供ShouldSerializeAge()方法

但很可能在这种情况下，您似乎需要一些通用的东西，您可以创建一个IContractResolver类，该类使用反射来检查给定的属性是否具有Obselete属性

Answer 3

扩展 Brian Rogers 的回答：在GetSerializableMembers()方法的覆盖中过滤掉要排除的成员要简单/更快，而不是在GetSerializedMembers()返回的每个MemberInfo上调用CreateProperty(MemberInfo member, MemberSerialization memberSerialization) GetSerializedMembers()以避免不必要地调用 CreateProperty 方法，该方法执行大量反射和委托创建。

public class ExcludeObsoletePropertiesResolver : DefaultContractResolver
{
    protected override List<MemberInfo> GetSerializableMembers(Type objectType)
    {
        var members =  base.GetSerializableMembers(objectType);
        members.RemoveAll(m => m.IsDefined(typeof(ObsoleteAttribute), true));
        return members;
    }
}

用法：

var settings = new JsonSerializerSettings
{
    ContractResolver = new ExcludeObsoletePropertiesResolver()
};
var json = JsonConvert.SerializeObject(foo, settings);