是否可以将 Newtonsoft.Json 配置为忽略具有 [ScriptIgnore] 属性的属性

Question

我有一个第三方类（我们称之为Class1），我需要将其序列化为 JSON。如果我尝试按原样执行此操作，我将收到 StackOverflowException 或 JsonSerializationException 消息“检测到类型的自引用循环”。我尝试为JsonConvert 应用以​​下设置，但它并没有帮助我避免StackOverflowException

var settings = new JsonSerializerSettings
{
    TypeNameHandling = TypeNameHandling.None,
    PreserveReferencesHandling = PreserveReferencesHandling.None,
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore
};

在反编译Class1后，我发现Class1的很多属性都标有[ScriptIgnore]属性，这是[JsonIgnore]的类似物，被System.Web.Script.Serialization.JavaScriptSerializer使用，但我需要使用Newtonsoft序列化器。

就Class1 是第三方类而言，我无法将[JsonIgnore] 属性添加到所需的属性中。 我知道我可以开发自己的IContractResolver 实现，并在那里处理有问题的属性，但我想避免这个选项。 也许有一种方法可以配置 Newtonsoft 序列化程序以考虑[ScriptIgnore] 属性以及[JsonIgnore]。并像使用ReferenceLoopHandling 一样进行此配置？

如有任何想法，我将不胜感激。

Answer 1

对此没有配置选项。如果你search on github，ScriptIgnoreAttribute 甚至不会出现在 Json.NET 源代码树中。

即使您不想实现自己的IContractResolver，这也将是直接的解决方案并且非常简单。首先，定义DefaultContractResolver的如下子类如下：

public class ScriptIgnoreContractResolver : DefaultContractResolver
{
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        var property = base.CreateProperty(member, memberSerialization);
        if (!property.Ignored)
        {
            if (property.AttributeProvider.GetAttributes(true).Any(p => p.GetType().FullName == "System.Web.Script.Serialization.ScriptIgnoreAttribute"))
            {
                property.Ignored = true;
            }
        }
        return property;
    }
}

然后序列化如下：

// Define a static member
static readonly IContractResolver myResolver = new ScriptIgnoreContractResolver();

// And use it in your serialization method
var settings = new JsonSerializerSettings
{
    ContractResolver = myResolver,
};
var json = JsonConvert.SerializeObject(rootObject, settings);

您可能想cache the contract resolver for best performance。