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

时间:2014-09-09 16:18:06

标签: c# json json.net

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忽略特定属性?

2 个答案:

答案 0 :(得分:19)

制作自定义合约解析器:

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

答案 1 :(得分:1)

幸运的是, 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对象,则它们可能不使用您最初提供的“安全”类型。