ASP.NET Web API 应如何返回错误：立即返回还是集体返回？

在 ASP.NET Web API 中返回错误的最佳实践

在处理 ASP.NET Web API 中的错误时，有两个主要方法处理方式：立即返回错误或者累积错误集中返回。本文探讨了每种方法的优缺点，并提供了推荐的最佳实践。

1.立即返回错误

在第一种方法中，使用 HttpResponseExceptions 立即返回错误。这适用于以下情况：

• 错误是致命的：这会阻止 API 继续处理，因为不可能进一步执行。
• 错误具体且可操作：它清楚地表明了问题和可操作的步骤客户端。

示例：

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);
    }
}

2.累积并发回错误

在第二种方法中，错误会累积并在操作结束时集中返回。在以下情况下建议这样做：

• 错误不是致命的：它们不会阻止操作完成，但仍然需要传达给客户端。
• 错误可能很多并且涵盖输入的不同部分：合并它们可以得到全面的错误

示例：

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);
}

最佳实践

虽然两种方法都有其优点，推荐的最佳实践是立即返回错误。这：

• 提供即时反馈：一旦发生错误，客户就会收到通知，以便他们能够及时解决。
• 简化错误处理： 在适当的位置捕获和处理异常，避免了复杂的错误传播
• 提高可维护性：清晰划分的错误处理逻辑使代码更易于理解和维护。

但是，对于非致命错误是更大的验证或处理阶段的一部分，累积错误并将它们集中返回可能会更多

更新

本文随着时间的推移不断更新，包含博客文章的见解和最佳实践的变化：

• 利用 HttpResponseExceptions用于立即错误返回和模型状态错误。
• 在全局异常过滤器中处理服务器级错误，提供适当的 HTTP 状态代码和友好的错误消息。
• 利用 IHttpActionResult 接口和内置类进行一般错误返回，例如 NotFound 和 BadRequest。

以上是ASP.NET Web API 应如何返回错误：立即返回还是集体返回？的详细内容。更多信息请关注PHP中文网其他相关文章！