Json.NET 序列化时限制最大深度

Question

我们将 ASP.NET WebAPI 与实体框架一起使用（延迟加载），并使用 Json.NET 将数据序列化为 JSON，然后再将数据返回到客户端。

我们正在经历内存使用量的间歇性突然峰值，我们怀疑这可能源于 Json.NET 在序列化数据时无法识别引用循环（因为实体框架可能正在使用代理类进行一些延迟加载 voodoo，这在 Json.NET 的雷达下）。

我以为我会限制 Json.NET 允许序列化数据的深度（至少当发生这种情况时我们会得到一个合理的异常，以便我们可以在数据模型中修复它），但我很快发现 JsonSerializerSettings 的 MaxDepth 属性仅在 DE序列化对象时启动。

序列化时是否有任何已知的方法可以对 Json.NET 施加限制？

Answer 1

我想不

出一种开箱即用的方法 Json.NET，因为（正如您正确观察到的那样）序列化时会忽略MaxDepth。 您可以做的是将JsonTextWriter子类化并自己进行检查：

public class MaxDepthJsonTextWriter : JsonTextWriter
{
    public int? MaxDepth { get; set; }
    public int MaxObservedDepth { get; private set; }
    public MaxDepthJsonTextWriter(TextWriter writer, JsonSerializerSettings settings)
        : base(writer)
    {
        this.MaxDepth = (settings == null ? null : settings.MaxDepth);
        this.MaxObservedDepth = 0;
    }
    public MaxDepthJsonTextWriter(TextWriter writer, int? maxDepth)
        : base(writer)
    {
        this.MaxDepth = maxDepth;
    }
    public override void WriteStartArray()
    {
        base.WriteStartArray();
        CheckDepth();
    }
    public override void WriteStartConstructor(string name)
    {
        base.WriteStartConstructor(name);
        CheckDepth();
    }
    public override void WriteStartObject()
    {
        base.WriteStartObject();
        CheckDepth();
    }
    private void CheckDepth()
    {
        MaxObservedDepth = Math.Max(MaxObservedDepth, Top);
        if (Top > MaxDepth)
            throw new JsonSerializationException(string.Format("Depth {0} Exceeds MaxDepth {1} at path "{2}"", Top, MaxDepth, Path));
    }
}

然后，要手动生成 JSON 字符串，您可以像这样使用它：

var settings = new JsonSerializerSettings { MaxDepth = 10 };
string json;
try
{
    using (var writer = new StringWriter())
    {
        using (var jsonWriter = new MaxDepthJsonTextWriter(writer, settings))
        {
            JsonSerializer.Create(settings).Serialize(jsonWriter, myClass);
            // Log the MaxObservedDepth here, if you want to.
        }
        json = writer.ToString();
    }
    Debug.WriteLine(json);
}
catch (Exception ex)
{
    Debug.WriteLine(ex);
    throw;
}

演示小提琴在这里。

由于您的标签包含 web-api，如果您想在 Web API 调用中执行此检查，您可以按照 Rick Stralh 的说明为 JSON 创建自定义MediaTypeFormatter：在 Web API 中使用备用 ASP.NET JSON 序列化程序;然后在生成 json 字符串时使用上述 OnWriteToStreamAsync 方法中的代码。