asp.net-mvc – 最佳实践:在web api控制器中处理错误和异常的方法?

我正在开发一个项目,并且非常依赖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调用后,我检查响应是否为true / false,显示错误或成功消息。

问题:

现在发生了什么事情是我在我的动作中开始得到异常,并且动作保持返回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; }
}

这种变化将是一个重大的变化,将是时间和资源消耗,所以我认为更好地对此有第二/第三/第四意见。

请对此有一些想法。

更新:

Mark Jones开始有little help,我已经想出了这个

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

有什么想法吗?

解决方法

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

有很多方法来处理你的问题。
最简单和最干净的解决方案可能是使用ActionFilter来处理异常,具体如下:

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-handling.aspx

他提供了一个很好的Web API异常处理技术概述。

相关文章

这篇文章主要讲解了“WPF如何实现带筛选功能的DataGrid”,文...
本篇内容介绍了“基于WPF如何实现3D画廊动画效果”的有关知识...
Some samples are below for ASP.Net web form controls:(fr...
问题描述: 对于未定义为 System.String 的列,唯一有效的值...
最近用到了CalendarExtender,结果不知道为什么发生了错位,...
ASP.NET 2.0 page lifecyle ASP.NET 2.0 event sequence cha...