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

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，而在其他情况下则不希望。

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

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

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