web-dev-qa-db-ja.com

Web APIでカスタムエラーオブジェクトを返す

MVC 4 Web APIフレームワークを使用して作業しているWeb APIがあります。例外がある場合、現在、新しいHttpResponseExceptionをスローしています。すなわち：

if (!Int32.TryParse(id, out userId))
    throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.BadRequest, "Invalid id"));

これは、単に{"message":"Invalid id"}であるオブジェクトをクライアントに返します

より詳細なオブジェクトを返すことで、例外に対するこの応答をさらに制御したいと思います。何かのようなもの

{
 "status":-1,
 "substatus":3,
 "message":"Could not find user"
 }

これをどうやってやるの？エラーオブジェクトをシリアル化し、応答メッセージに設定する最良の方法はありますか？

ModelStateDictionaryも少し調べて、この「ハック」のビットを思いつきましたが、まだきれいな出力ではありません。

var msd = new ModelStateDictionary();
msd.AddModelError("status", "-1");
msd.AddModelError("substatus", "3");
msd.AddModelError("message", "invalid stuff");
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.BadRequest, msd));

編集
カスタムHttpErrorが必要なようです。これはトリックを実行しているように見えますが、今では私のビジネス層から拡張可能にしています...

var error = new HttpError("invalid stuff") {{"status", -1}, {"substatus", 3}};
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.BadRequest, error));
asp.net-mvc-4exception-handlingerror-handlingasp.net-web-api
31
earthling

これでうまくいくと思います：

ビジネスレイヤーのカスタム例外クラスを作成します。

 public class MyException: Exception
 {
    public ResponseStatus Status { get; private set; }
    public ResponseSubStatus SubStatus { get; private set; }
    public new string Message { get; private set; }

    public MyException()
    {}

    public MyException(ResponseStatus status, ResponseSubStatus subStatus, string message)
    {
        Status = status;
        SubStatus = subStatus;
        Message = message;
    }
 }

HttpErrorのインスタンスからMyExceptionを生成する静的メソッドを作成します。ここではリフレクションを使用しているので、MyExceptionにプロパティを追加し、Createを更新せずに常にプロパティを返すことができます。

    public static HttpError Create<T>(MyException exception) where T:Exception
    {
        var properties = exception.GetType().GetProperties(BindingFlags.Instance 
                                                         | BindingFlags.Public 
                                                         | BindingFlags.DeclaredOnly);
        var error = new HttpError();
        foreach (var propertyInfo in properties)
        {
            error.Add(propertyInfo.Name, propertyInfo.GetValue(exception, null));
        }
        return error;
    }

現在、一般的な例外ハンドラのカスタム属性があります。タイプMyExceptionのすべての例外は、ここで処理されます。

public class ExceptionHandlingAttribute : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext context)
    {
        var statusCode = HttpStatusCode.InternalServerError;

        if (context.Exception is MyException)
        {
            statusCode = HttpStatusCode.BadRequest;
            throw new HttpResponseException(context.Request.CreateErrorResponse(statusCode, HttpErrorHelper.Create(context.Exception)));
        }

        if (context.Exception is AuthenticationException)
            statusCode = HttpStatusCode.Forbidden;

        throw new HttpResponseException(context.Request.CreateErrorResponse(statusCode, context.Exception.Message));
    }
}

これについてもう少し遊んでみて、この計画に穴が開いたら更新します。

9
earthling

これらの答えは、必要以上に複雑です。

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.Filters.Add(new HandleApiExceptionAttribute());
        // ...
    }
}

public class HandleApiExceptionAttribute : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext context)
    {
        var request = context.ActionContext.Request;

        var response = new
        {
             //Properties go here...
        };

        context.Response = request.CreateResponse(HttpStatusCode.BadRequest, response);
    }
}

必要なのはそれだけです。また、素晴らしく、簡単な単体テストです。

[Test]
public async void OnException_ShouldBuildProperErrorResponse()
{
    var expected = new 
    {
         //Properties go here...
    };

    //Setup
    var target = new HandleApiExceptionAttribute()

    var contextMock = BuildContextMock();

    //Act
    target.OnException(contextMock);

    dynamic actual = await contextMock.Response.Content.ReadAsAsync<ExpandoObject>();

    Assert.AreEqual(expected.Aproperty, actual.Aproperty);
}

private HttpActionExecutedContext BuildContextMock()
{
    var requestMock = new HttpRequestMessage();
    requestMock.Properties.Add(HttpPropertyKeys.HttpConfigurationKey, new HttpConfiguration());

    return new HttpActionExecutedContext()
    {
        ActionContext = new HttpActionContext
        {
            ControllerContext = new HttpControllerContext
            {
                Request = requestMock
            }

        },
        Exception = new Exception()
    };
}
41
FredM

次の記事をご覧ください。 Web APIの例外とエラーメッセージを制御できるようになります。 Web Api、HttpError、および例外の動作

2
Andy Cohen