是否可以将自定义错误页面与 MVC 站点一起使用，但不能在 Web API 中使用？

Posted 2023-02-24

【中文标题】是否可以将自定义错误页面与 MVC 站点一起使用，但不能在 Web API 中使用？

【英文标题】：Is it possible to use custom error pages with MVC site but not Web API?

【发布时间】：2013-09-22 10:15:25

【问题描述】：

我有一个带有 /api 文件夹的 MVC 项目，其中包含我的 Web API 控制器。我想要以下东西：

我的 MVC 站点在发生错误时提供自定义错误页面 用于提供默认错误响应的我的 Web API（包含异常和堆栈跟踪的 json/xml）

在我的 MVC 站点的 web.config 中，我有一个 httpErrors 节点，并将 errorMode 设置为“自定义”，以便在 404s/500s/etc 时我可以有很好的错误页面。在浏览 MVC 站点期间发生：

<httpErrors errorMode="Custom" existingResponse="Replace">
  <remove statusCode="404" subStatusCode="-1" />
  <remove statusCode="500" subStatusCode="-1" />
  <remove statusCode="403" subStatusCode="-1" />
  <error prefixLanguageFilePath="" statusCode="404" path="Content\notfound.htm" responseMode="File" />
  <error statusCode="500" path="/Errors" responseMode="ExecuteURL" />
  <error statusCode="403" path="/Errors/Http403" responseMode="ExecuteURL" /></httpErrors>

但是，使用该配置，API 将在发生错误时提供自定义错误页面，而不是带有异常/堆栈跟踪的 json/xml（这是所需的行为）。

有没有办法将自定义错误配置为仅适用于我的 MVC 站点而不适用于 Web API？该博客说没有 (http://blog.kristandyson.com/2012/11/iis-httperrors-aspnet-web-api-fully.html)，但我想知道自该博客发布以来是否有其他人找到解决方法。

我想如果没有，我可以为我的 Web API 项目创建一个单独的项目/程序集。这将允许我分别为 MVC 和 Web API 配置 httpErrors，但我不想创建另一个项目，所以我还有另一个 web.config 需要配置。

【参考方案1】：

好吧，在让这个问题腌制近一年之后，我又试了一次。这是让我得到我想要的东西的 web.config 魔法：

<!-- inside of <configuration> to allow error
    responses from requests to /api through -->
<location path="api">
    <system.webServer>
      <validation validateIntegratedModeConfiguration="false" />
      <httpErrors errorMode="DetailedLocalOnly" existingResponse="PassThrough" >
        <clear/>
      </httpErrors>
    </system.webServer>
</location>

<!-- original httpErrors, inside of <location path="." inheritInChildApplications="false">
 to serve custom error pages when the MVC site returns an error code -->
<httpErrors errorMode="Custom" existingResponse="Replace">
      <remove statusCode="400" subStatusCode="-1" />
      <remove statusCode="404" subStatusCode="-1" />
      <remove statusCode="500" subStatusCode="-1" />
      <remove statusCode="403" subStatusCode="-1" />
      <error statusCode="400" prefixLanguageFilePath="" path="Content\notfound.htm" responseMode="File"/>
      <error prefixLanguageFilePath="" statusCode="404" path="Content\notfound.htm" responseMode="File" />
      <error statusCode="500" path="/errors" responseMode="ExecuteURL" />
      <error statusCode="403" path="/errors/http403" responseMode="ExecuteURL" />
    </httpErrors>

这里发生的事情的症结在于<location> 节点允许您覆盖在不太具体的路径上所做的设置。因此，虽然我们为 path="." 设置了 errorMode="Custom"，但我们使用 <location path="api"> 节点和其中的 httpErrors 配置覆盖了我们的 Web API 路径。

我以前见过节点，但直到现在我才意识到这是它们的目的。这篇文章更详细地介绍了 IIS/.NET 的配置继承模型，我发现它非常有用：http://weblogs.asp.net/jongalloway/10-things-asp-net-developers-should-know-about-web-config-inheritance-and-overrides

【讨论】：

非常感谢 - 我一直在努力解决这个问题，只是没有想到这个简单的好解决方案！

它只适用于我本地机器上的IIS Express。例如，您是否尝试在 IIS 8 上运行它？它有效吗？ IIS 8+ 似乎忽略了 覆盖的配置。

这在 IIS 7.5 中对我有用。感谢您提供此解决方案！

这终于是让一切按需要工作的解决方案了。

有人用属性路由试过这个吗？它似乎不适用于我的项目。我的 ApiControllers 放在 Controllers\Api 下，我的 web.config 中有这个：``` ``

【参考方案2】：

我还没有对此进行测试，但是如何编写代码来处理您的 MVC 应用程序错误，就像这里显示的 http://thirteendaysaweek.com/2012/09/25/custom-error-page-with-asp-net-mvc-4/ ？

他的代码表明他在应用程序级别 (Global.asax) 执行此操作，但我想您也可以以同样的方式在较低级别捕获异常，一种方法用于 MVC，另一种用于 Web API。

【讨论】：

处理 MVC 应用程序错误不是我想要做的，也不是这个问题的目的。我希望能够从我的 Web API 返回错误代码（例如，当客户端错误地向 API 发出请求时返回 400）并且不让 .NET 重定向到自定义错误页面。相反，当我的 MVC 站点（托管 Web API）上出现 404/500/etc 时，我想提供自定义错误页面。我希望同时拥有这两种行为，并将 MVC/Web API 托管在同一个站点中。解决方案在我下面的答案中。

【参考方案3】：

什么对我有用：

<httpErrors existingResponse="Auto" defaultResponseMode="Redirect" errorMode="Custom">
  <remove statusCode="403" subStatusCode="-1" />
  <error statusCode="403" subStatusCode="-1" responseMode="Redirect" path="<!--path here-->" />
  <remove statusCode="404" subStatusCode="-1" />
  <error statusCode="404" subStatusCode="-1" responseMode="Redirect" path="<!--path here-->" />
  <remove statusCode="500" subStatusCode="-1" />
  <error statusCode="500" subStatusCode="-1" responseMode="Redirect" path="<!--path here-->" />
</httpErrors>

似乎只需设置 existingResponse="Auto" 就可以完成这项工作。