.NET Framework Web API的Application_Error无法捕获异常排查

我正在使用.NET Framework Web API项目，在global.asax.cs文件中编写了如下代码：

protected void Application_Error(object sender, EventArgs e)
{
    var ctx = HttpContext.Current;

    var exception = ctx.Server.GetLastError(); // get exception
    // log exception

    Context.Response.ContentType = "application/json";
    Context.Response.StatusCode = 500;

    // if debug return detailed exception else generic like below

    Context.Response.Write("Internal server error");
}

我在web.config中启用了自定义错误：

<customErrors mode="On"  />

并在控制器端点中抛出异常：

throw new Exception("test");

但在浏览器中看到的结果是：

{
"Message": "An error has occurred."
}

我预期的结果是Application_Error方法中写入的内容：Context.Response.Write("Internal server error");，显然哪里出现了问题，请问我遗漏了什么？

这是因为Web API自带一套独立的异常处理机制，它会优先拦截控制器中抛出的异常，返回框架默认的错误响应，导致你的Application_Error代码无法生效。

要让Application_Error接管Web API的异常处理，需要完成以下两步：

1. 移除Web API默认异常处理逻辑
   在WebApiConfig.cs的Register方法中，清除默认的异常处理器：

config.Services.RemoveAll(typeof(IExceptionHandler));

2. 在Application_Error中终止异常传递
   在你的Application_Error方法末尾添加代码，确保ASP.NET不再继续处理该异常，避免响应被覆盖：

// 清除异常，阻止后续处理流程
Server.ClearError();
// 强制结束响应，确保自定义内容发送到客户端
Context.Response.End();

修改后的Application_Error完整代码：

protected void Application_Error(object sender, EventArgs e)
{
    var ctx = HttpContext.Current;

    var exception = ctx.Server.GetLastError(); 
    // log exception

    Context.Response.ContentType = "application/json";
    Context.Response.StatusCode = 500;

    // if debug return detailed exception else generic like below
    Context.Response.Write("Internal server error");

    Server.ClearError();
    Context.Response.End();
}

补充：如果不需要依赖Application_Error的全局处理，也可以为Web API单独实现ExceptionFilterAttribute，这是Web API官方推荐的异常处理方式。

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