序列化对象时有条件地忽略嵌套属性

Question

我正在努力有条件地序列化一个对象的属性，该属性是另一个对象本身的属性。考虑以下类结构：

public class Message
{
    public string Content { get; set; }
    public IEnumerable<Attachment> Attachments { get; set; }
}

public class Attachment
{
    public string Base64Content { get; set; }
    public string FileName { get; set; }
}

在某些情况下，我想序列化Message类中的所有内容，包括所有Attachment对象及其属性。这可以通过使用一个简单的JsonConvert.SerializeObject(). 如果我总是想忽略该Base64Content属性，我可以在该属性上添加“[JsonIgnore]”属性。但是，在某些情况下我希望Base64Content序列化，而在其他情况下我则不需要。

我想创建一个ContractResolver忽略对象Attachments属性的自定义Message。但当然，这会忽略整个Attachment对象列表，而不仅仅是Base64Content属性。

有没有一种方法可以编写一个ContractResolver类，让我Base64Content在序列化Message对象时忽略该属性？

Answer 1

只需创建一个自定义合约解析器，该解析器会在序列化时排除传递给它的属性，并Base64Content有条件地传递其中的属性。

public class CustomPropertiesContractResolver : DefaultContractResolver
{
    private HashSet<string> _propertySet;

    public CustomPropertiesContractResolver(IEnumerable<string> propertyNames)
    {
        if (propertyNames != null)
        {
            _propertySet = new HashSet<string>(propertyNames, StringComparer.OrdinalIgnoreCase);
        }
    }

    protected override List<MemberInfo> GetSerializableMembers(Type objectType)
    {
        List<MemberInfo> serializableMembers = null;
        var allMembers = base.GetSerializableMembers(objectType);

        if (_propertySet != null && _propertySet.Count > 0)
        {
            serializableMembers = allMembers.Where(m => !_propertySet.Contains(m.Name)).ToList();
        }
        return serializableMembers != null && serializableMembers.Count > 0 ? serializableMembers : allMembers;
    }
}

像这样使用它：

IEnumerable<string> properties = null;
if (condition)
{
    properties = new List<string> { "Base64Content" };
}

var settings = new JsonSerializerSettings()
{
    ContractResolver = new CustomPropertiesContractResolver(properties)
};
var serializedStr = JsonConvert.SerializeObject(messages, settings);