.Net Core 2.0返回BadRequestObjectResult引发Json序列化循环引用异常

这个问题的核心在于直接将Exception对象传递给BadRequest()方法时，JSON序列化器无法处理Exception内部的循环引用结构，而本地与Azure App Service的环境差异让这个问题只在部署后暴露出来。

为什么本地正常，Azure出问题？ #

本地调试时，Exception对象的某些深层属性（比如targetSite.module.assembly）可能因为调试环境的特性没有被完整初始化，序列化器不需要处理这些循环引用的节点；而在Azure生产环境中，Exception的完整调用链和属性被完整填充，触发了Newtonsoft.Json的循环引用检测，导致序列化失败并抛出JsonSerializationException。

如何解决？ #

这里有几个可行的方案，按推荐程度排序：

1. 使用自定义错误DTO（最佳实践）

永远不要直接序列化Exception对象——它包含大量服务器内部的敏感信息（比如程序集、模块路径），而且结构复杂容易引发序列化问题。应该创建一个只包含必要错误信息的DTO：

// 定义错误响应模型
public class ApiErrorResponse
{
    public string ErrorMessage { get; set; }
    public string? ErrorDetails { get; set; } // 可选，仅在调试环境返回
}

// 控制器中使用
catch (Exception ex)
{
    var errorResponse = new ApiErrorResponse
    {
        ErrorMessage = "请求参数无效，请检查输入",
        // 仅在开发环境返回详细错误，生产环境建议隐藏
        ErrorDetails = Environment.IsDevelopment() ? ex.Message : null
    };
    return BadRequest(errorResponse);
}

这种方式既避免了序列化问题，也符合API安全规范，不会泄露服务器内部细节。

2. 配置Newtonsoft.Json忽略循环引用

如果你确实需要返回Exception的更多信息（仅限调试场景），可以修改JSON序列化配置，让Newtonsoft.Json忽略循环引用：

// .NET 6+ 在Program.cs中配置
builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
    });

⚠️ 注意：生产环境不推荐这种做法，因为会返回大量不必要的内部信息，存在安全风险。

3. 检查Azure与本地的.NET版本一致性

确保Azure App Service使用的.NET版本和本地开发环境完全一致，不同版本的ASP.NET Core可能在JSON序列化行为上有细微差异，导致本地正常的代码在部署后出问题。

内容的提问来源于stack exchange，提问作者Daniel Rahamim