如何告诉Json.NET忽略第三方对象中的属性

本文关键字：对象 属性 第三方 何告诉 Json NET | 更新日期: 2023-09-27 18:21:09

Json.NET文档说，您使用JsonIgnore不序列化类中的某些属性：

public class Account
{
    public string FullName { get; set; }
    public string EmailAddress { get; set; }
    [JsonIgnore]
    public string PasswordHash { get; set; }
}

在用JsonConvert.SerializeObject序列化第三方对象时，如何使Json.NET忽略特定属性？

如何告诉Json.NET忽略第三方对象中的属性

制作一个自定义合同解析程序：

public class ShouldSerializeContractResolver : DefaultContractResolver
{
    public static ShouldSerializeContractResolver Instance { get; } = new ShouldSerializeContractResolver();
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        JsonProperty property = base.CreateProperty(member, memberSerialization);        
        if (typeof(Account).IsAssignableFrom(member.DeclaringType) && member.Name == nameof(Account.PasswordHash))
        {
            property.Ignored = true;
        }
        return property;
    }
}

我如何测试它：

        var account = new Account
        {
            PasswordHash = "XXAABB"
        };
        var settings = new JsonSerializerSettings
        {
            ContractResolver = ShouldSerializeContractResolver.Instance
        };
        var json = JsonConvert.SerializeObject(account, settings);
        Console.WriteLine(json);

幸运的是，Newtonsoft.Json对JsonConvert.SerializeObject（）方法有一个重写，它允许我们提供一个类型，这样生成的Json就不会包含该类型中不存在的属性。因此，为了消除属性，您可以创建一个删除了所有敏感属性的Account类的安全副本，并给它一个不同的名称：

public class AccountJSON
{
    public string FullName { get; set; }
    public string EmailAddress { get; set; }
}

序列化时提供其类型：

var TheAccount = DBContext.Accounts.Find(1);
var TheJSON = Newtonsoft.Json.JsonConvert.SerializeObject(TheAccount, typeof(AccountJSON));

注意：当序列化程序遍历对象时，这可能只适用于一级深度。如果Account对象具有引用更多Account对象的延迟加载属性，则它们可能不会使用您最初提供的"安全"类型。

相关文章：