ASP.NET Web API 中的立即错误处理与累积错误处理：哪种方法最好？

ASP.NET Web API 中错误处理的最佳实践

出现了有关 ASP.NET Web API 中处理错误的最佳方法的问题。遇到错误应该立即返回，还是应该累积并集中返回？

立即错误处理

在此方法中，错误以 HttpResponseException 对象的形式抛出，立即停止进一步处理。例如：

public void Post(Customer customer)
{
    if (string.IsNullOrEmpty(customer.Name))
    {
        throw new HttpResponseException("Customer Name cannot be empty", HttpStatusCode.BadRequest); 
    }
    if (customer.Accounts.Count == 0)
    {
         throw new HttpResponseException("Customer does not have any account", HttpStatusCode.BadRequest); 
    }
}

立即错误处理的优点：

• 简单的实现
• 错误会立即传达给客户端
• 防止不必要的处理

立即错误处理的缺点：

• 可能导致同一请求抛出多个异常
• 需要自定义每个异常的错误处理

累积错误处理

在这种方法中，错误被收集到一个列表中并作为 HttpResponseException 对象集体返回。例如：

public void Post(Customer customer)
{
    List<string> errors = new List<string>();
    if (string.IsNullOrEmpty(customer.Name))
    {
        errors.Add("Customer Name cannot be empty"); 
    }
    if (customer.Accounts.Count == 0)
    {
         errors.Add("Customer does not have any account"); 
    }
    var responseMessage = new HttpResponseMessage<List<string>>(errors, HttpStatusCode.BadRequest);
    throw new HttpResponseException(responseMessage);
}

累积错误处理的优点：

• 提供所有错误的完整列表
• 允许自定义错误集中处理位置

累积错误处理的缺点：

• 实现起来可能更复杂
• 可能会延迟客户端接收错误信息
• 较大误差需要额外带宽列表

建议

立即错误处理和累积错误处理之间的选择取决于应用程序的要求。对于简单的场景，立即处理错误就足够了。对于更复杂的场景，累积错误处理可能更合适。

更新

自从回答这个问题以来，有几篇博客文章讨论了这个主题，包括：

• https://weblogs.asp.net/fredriknormen/asp-net-web-api-exception-handling
• https://learn.microsoft.com/ archive/blogs/youssefm/error-handling-in-asp-net-webapi

最近实践

当前的错误处理实践包括：

• 一般错误的立即响应：使用 HttpResponseException 报告典型错误，例如未找到或无效参数。
• 服务器错误的累积响应：允许异常冒泡至全局异常过滤器，记录错误并提供友好消息。
• 自定义 IHttpActionResult 类： 在 System.Web.Http.Results 命名空间中使用内置或自定义类（例如例如，NotFoundWithMessageResult) 返回特定的错误消息。

以上是ASP.NET Web API 中的立即错误处理与累积错误处理：哪种方法最好？的详细内容。更多信息请关注PHP中文网其他相关文章！