在 ASP.NET 5 中处理 JSON 循环引用异常

Question

所以我在 ASP.NET 5 中使用 Web API。在某些时候我的应用程序停止工作，只显示“Bad Gateway”IIS 错误页面（我在 IIS Express 中按 F5 运行它）。我花了一段时间才弄清楚问题所在 - 我将循环引用引入到我的 Web API 方法返回的一个类中，如下所示：

public class CircularParent
{
    public CircularChild Data;

    public CircularParent()
    {
        Data = new CircularChild(this);
    }
}

public class CircularChild
{
    public CircularParent Owner { get; set; }

    public CircularChild(CircularParent owner)
    {
        Owner = owner;
    }
}

结果是JsonSerializationException。我的问题不是如何解决它，而是将来如何处理这种情况。我该如何处理这样的异常？或者至少如何记录它或只是看到它记录在某个地方？ UseDeveloperExceptionPage() 没有帮助。 UseExceptionHandler(errorApp => errorApp.Run(...)) 也无济于事，执行不会进入 errorApp.Run()。调试器不会因异常而中断。我从 IIS 中得到的只是信息量不大的“坏网关”页面。

Answer 1

这可能是一种迂回的方式，但我做了一个 db first 迁移，它分配了虚拟属性，虽然它工作它会导致循环引用。我通过添加解决了这个问题

[JsonIgnore] 

（在我的例子中是 Newtonsoft）到所有虚拟属性，它运行良好。

Answer 2

对于 ASP.NET Core 2.2，使用 Startup.cs 中的 Configure 方法

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    JsonConvert.DefaultSettings = () => new JsonSerializerSettings
    {
        ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
    };
}

Answer 3

对于 ASP.NET Core：

var mvc = services.AddMvc(options =>
{
   //mvc options
});

mvc.AddJsonOptions(options =>
{
    options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
});

Answer 4

尝试将最新版本8.0.1-beta3中的Newtonsoft.Json添加到package.json中的依赖项并使用

services.AddMvc()
    .AddJsonOptions(options => {
        options.SerializerSettings.ReferenceLoopHandling =
            Newtonsoft.Json.ReferenceLoopHandling.Ignore;
    });

更多详情请见the issue。