20

我正在做一个项目，并且我的所有客户端操作都严重依赖 web api，无论是帐户详细信息更新、添加新详细信息、修改所有内容都已使用 ASP.NET Web Api 和 Backbone.js 完成

当前场景：

在当前的方案中，我从我的 web api 控制器返回一个布尔值，以指示操作是否成功。

例子 ：

[ActionName("UpdateAccountDetails")]
public bool PostAccountDetails(SomeModel model)
{
    bool updateStatus = _customService.UpdateAccountDetails(model);
    return updateStatus;
}

因此，在对此操作进行 ajax 调用后，我会检查响应的真/假并显示错误或成功消息。

问题 ：

现在发生的事情是我开始在我的操作中遇到异常，并且操作一直返回 false，并且显示了错误消息。但我找不到为什么？

所以我想知道是否有每个人都遵循的标准 api 响应结构？

我最初提出了这个想法，让每个 web api 操作都返回这个类

public class OperationStatus
{
    public bool Result { get; set; } // true/false
    public string Status { get; set; } // success/failure/warning
    public List<string> WarningMessages { get; set; }
    public List<string> ErrorMessages { get; set; }
    public string OtherDetails { get; set; }
}

此更改将是一项重大更改，并且会耗费时间和资源，因此我认为最好对此有第二/第三/第四意见。

请对此提出一些想法。

更新 ：

在马克琼斯的一些帮助下，我想出了这个

[ActionName("UpdateAccountDetails")]
public HttpResponseMessage PostAccountDetails(SomeModel model)
{
    bool updateStatus;
    string errorMessage;
    try{
        updateStatus = _customService.UpdateAccountDetails(model);
        if(updateStatus)
        {
            return Request.CreateResponse(HttpStatusCode.OK);
        }
        return Request.CreateResponse(HttpStatusCode.InternalServerError);
    }
    catch(Exception exception)
    {
        errorMessage = exception.Message;
        return Request.CreateResponse(HttpStatusCode.InternalServerError, errorMessage);
    }

    return updateStatus;
}

对此有什么想法吗？

4

2 回答 2

26

您应该避免在控制器的操作中使用 try/catch。

有很多方法可以处理您的问题。最简单和最干净的解决方案可能是使用 anActionFilter来处理异常，类似于：

public class ExceptionAttribute : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext context)
    {
        Debug.WriteLine(context.Exception);

        throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.InternalServerError)
        {
            Content = new StringContent("An error occurred!"),
            ReasonPhrase = "Deadly Exception"
        });
    }
}

然后你可以用 . 装饰你的动作[ExceptionAttribute]。当然，您可以扩展它以针对不同类型的异常（业务异常、数据异常、IO 异常等）表现出不同的行为，并基于此返回不同的状态码和反馈。

我建议你阅读Fredrik Normen的一篇优秀文章- “ASP.NET Web API 异常处理” http://weblogs.asp.net/fredriknormen/archive/2012/06/11/asp-net-web-api-exception-处理.aspx。

他对 Web API 的异常处理技术进行了很好的概述。

于 2012-12-19T15:29:50.083 回答
4

我不会返回HttpResponseMessage ，而是保持 API 相同，并且在捕获异常时仅抛出HttpResponseException 。像这样的东西：

throw new HttpResponseException(
    new HttpResponseMessage(HttpStatusCode.InternalServerError) 
       { ReasonPhrase = errorMessage });

这样您就不会更改 API 的定义，它也可以与您的 GET 操作一起使用，您可以在其中返回一些必须序列化的对象。如果您使用 JQuery ajax 方法来发送请求，那么您的错误处理程序将捕获它，您可以检索errorThrown参数中的文本消息并相应地处理它。

于 2012-12-19T14:17:39.337 回答