C# Newtonsoft序列化时，忽略特定属性不参与序列化的常见方法？

Question

在C#开发中，使用Newtonsoft.Json进行对象序列化时，如何忽略特定属性不让其参与序列化是一个常见需求。例如，某些敏感数据或不必要的字段需要排除在JSON输出之外。实现这一功能的常见方法有哪些？ 问题：在项目中，我有一个类包含多个属性，但希望在使用Newtonsoft.Json序列化时忽略其中的某个属性（如Password）。我知道可以通过添加特性来实现，但具体有哪些方法可以做到这一点？这些方法是否存在性能差异或特殊使用场景？如果不想通过修改类定义来实现，是否还有其他替代方案？

Answer 1

1. 基础方法：通过特性控制序列化

在C#中，使用Newtonsoft.Json进行对象序列化时，最常见的忽略特定属性的方法是通过添加特性。以下是一些常用的特性：

• [JsonIgnore]：这是最直接的方式，标记后该属性将被完全忽略。
• [JsonProperty(Ignore = true)]：与[JsonIgnore]类似，但提供更多配置选项。

示例代码如下：

public class User
{
    public string Username { get; set; }

    [JsonIgnore]
    public string Password { get; set; }
}
    

以上方法简单易用，适合大多数场景。但如果需要动态决定是否忽略某些字段，则需要更灵活的解决方案。

2. 高级方法：自定义ContractResolver

如果不想修改类定义，或者需要动态控制哪些字段参与序列化，可以使用自定义的ContractResolver。

示例代码如下：

public class IgnorePropertyResolver : DefaultContractResolver
{
    private readonly HashSet _propertiesToIgnore;

    public IgnorePropertyResolver(IEnumerable propertiesToIgnore)
    {
        _propertiesToIgnore = new HashSet(propertiesToIgnore);
    }

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

// 使用方式
var settings = new JsonSerializerSettings
{
    ContractResolver = new IgnorePropertyResolver(new[] { "Password" })
};
string json = JsonConvert.SerializeObject(user, settings);
    

这种方法无需修改类定义，适用于无法直接修改源码的情况。

3. 特殊场景：基于条件的动态忽略

有时需要根据运行时条件来决定是否忽略某个属性。可以通过实现ISerializationCallback接口或重写ShouldSerializeXXX方法来实现。

方法	适用场景	性能差异
特性（如[JsonIgnore]）	静态忽略字段	性能最优，因为解析器可以直接跳过这些字段。
自定义ContractResolver	动态忽略字段	稍逊于特性方法，但仍然高效。
ShouldSerialize方法	基于条件的动态忽略	可能稍慢，因为每次序列化都会调用此方法。

4. 替代方案：数据传输对象（DTO）模式

如果序列化逻辑复杂，或者需要对多个字段进行特殊处理，建议使用DTO模式。创建一个专门用于序列化的类，只包含需要输出的字段。

例如：

public class UserDto
{
    public string Username { get; set; }
}

// 转换逻辑
var dto = new UserDto { Username = user.Username };
string json = JsonConvert.SerializeObject(dto);
    

这种方式虽然增加了开发成本，但能有效分离业务逻辑和序列化逻辑。

5. 流程图：选择合适的忽略方法

graph TD;
            A[需要忽略字段?] --> B{是否可修改类定义?};
            B -- 是 --> C[使用特性];
            B -- 否 --> D{是否动态决定?};
            D -- 是 --> E[自定义ContractResolver];
            D -- 否 --> F[DTO模式];