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

Question

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

c#asp.netasp.net-web-apiexception

30

你能否澄清Web API错误管理的最佳实践是什么？实际上，我不知道在我的Api请求中使用try catch是否是一个好习惯。

public Vb.Order PostOrderItem(Vb.Order order)
{
    if (OAuth.isValid(Request.Headers.GetValues("Token").Single()) != true)
    {
        HttpResponseMessage httpResponseMessage = new HttpResponseMessage(HttpStatusCode.Unauthorized);
        throw new HttpResponseException(httpResponseMessage);
    }
    if (!ModelState.IsValid)
    {
        HttpResponseMessage httpResponseMessage = new HttpResponseMessage(HttpStatusCode.BadRequest);
        throw new HttpResponseException(httpResponseMessage);
    }

    try
    {
        return Vb.Document.Generate(order);
    }
    catch (Exception ex)
    {
        logger.Error(ex);
        HttpResponseMessage httpResponseMessage = new HttpResponseMessage(HttpStatusCode.BadRequest);
        httpResponseMessage.Content = new StringContent(ex.Message);
        throw new HttpResponseException(httpResponseMessage);
    }

}

我有这样一种感觉，使用try catch来处理服务器端代码并不是一个好的实践，因为我只是记录了异常并重新抛出它。

- Bastien Vandamme

3个回答

26

请参考这个链接ASP.NET Web API 中的异常处理 - 一次指导之旅，其中有4个级别的异常处理流程：

第一级 - HttpResponseException
第二级 - 异常过滤器
第三级 - 日志记录
第四级 - 异常处理程序

Web API 在异常处理方面提供了极大的灵活性。总结一下：

在操作级别上使用HttpResponseException或快捷方法处理未处理的异常。

使用异常过滤器来处理多个操作和控制器上的特定未处理异常。

使用 ExceptionLogger 记录任何未处理的异常。

使用异常处理程序（每个应用程序一个）来处理任何应用程序范围内的未处理异常。

- Phuc Thai

0

有许多方法，每一种方法都在逻辑对象图中向上迈进一步；

本文列出了它们所有的方法； http://www.codeproject.com/Articles/850062/Exception-handling-in-ASP-NET-MVC-methods-explaine

我发现使用较高级别的方法可以避免重复代码，这很有用。

- Milney

2

这是关于MVC的，不是Web API。 - Bastien Vandamme

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Nkosi · Accepted Answer

Web API中的错误处理被视为横跨多个方面的关注点，应该放置在管道的其他位置，这样开发人员就不需要专注于横跨多个方面的关注点。

您应该阅读ASP.NET Web API中的异常处理

如果Web API控制器引发未捕获的异常会发生什么？默认情况下，大多数异常将转换为带有状态代码500的HTTP响应，即“内部服务器错误”。

另外还有ASP.NET Web API 2中的全局错误处理

尽可能使您的控制器保持简洁。像您原来的代码一样进行错误处理只会导致代码重复和开发人员需知道的不必要问题。开发人员应专注于核心关注点，而不是横跨多个方面的关注点。通过只关注核心问题，上述代码将如下所示：

[MyAuthentication]
[MyValidateModel]
public Vb.Order PostOrderItem(Vb.Order order)
{    
    return Vb.Document.Generate(order);
}

为什么这么瘦？

因为：

if (OAuth.isValid(Request.Headers.GetValues("Token").Single()) != true)
{
    HttpResponseMessage httpResponseMessage = new HttpResponseMessage(HttpStatusCode.Unauthorized);
    throw new HttpResponseException(httpResponseMessage);
}

可以移动到ASP.NET Web API 2身份验证过滤器中，可以在控制器/操作本地应用或全局返回相关响应。

ASP.NET Web API中的模型验证就像这样。

if (!ModelState.IsValid)
{
    HttpResponseMessage httpResponseMessage = new HttpResponseMessage(HttpStatusCode.BadRequest);
    throw new HttpResponseException(httpResponseMessage);
}

也可以移到过滤器中，例如: .

public class MyValidateModelAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (!actionContext.ModelState.IsValid)
        {
            actionContext.Response = actionContext.Request.CreateErrorResponse(
                HttpStatusCode.BadRequest, actionContext.ModelState);
        }
    }
}