C＃ASP.NET WebAPIで未処理の例外を処理するための例外フィルターを作成するにはどうすればよいですか？

例外フィルターは、コントローラーメソッドがHttpResponseException例外ではないunhandledexceptionをスローしたときに実行されます。 HttpResponseExceptionタイプは、HTTP応答を返すために特別に設計されているため、特殊なケースです。

例外フィルターは、System.Web.Http.Filters.IExceptionFilterインターフェースを実装します。例外フィルターを作成する最も簡単な方法は、System.Web.Http.Filters.ExceptionFilterAttributeクラスから派生し、OnExceptionメソッドをオーバーライドすることです。

以下は、NotFiniteNumberException例外をHTTPステータスコード 416、要求された範囲が満たされないに変換するフィルターです。 。

ExceptionFilterAttribute −

例

using System;
using System.Net;
using System.Net.Http;
using System.Web.Http.Filters;
namespace DemoWebApplication.Controllers{
   public class ExceptionAttribute : ExceptionFilterAttribute{
      public override void OnException(HttpActionExecutedContext context){
         if (context.Exception is NotFiniteNumberException){
            context.Response = new HttpResponseMessage(HttpStatusCode.RequestedRangeNotSatisfiable);
         }
      }
   }
}

コントローラーActionMethod −

例

using DemoWebApplication.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
namespace DemoWebApplication.Controllers{
   [Exception]
   public class StudentController : ApiController{
      List<Student> students = new List<Student>{
         new Student{
            Id = 1,
            Name = "Mark"
         },
         new Student{
            Id = 2,
            Name = "John"
         }
      };
      public Student Get(int id){
         if(id <= 0){
            throw new NotFiniteNumberException("The Id is not valid");
         }
         var studentForId = students.FirstOrDefault(x => x.Id == id);
         return studentForId;
      }
   }
}

それでは、コントローラーアクションメソッドにid =0を渡して、上記のExceptionAttributeをテストしてみましょう。

ExceptionAttributeは、次のいずれかの方法で登録できます。

• 例外フィルターでアクションを装飾します。

[Exception]
   public IHttpActionResult Get(int id){
   Return Ok();
}

• 例外フィルターでコントローラーを装飾します。

[Exception]
public class StudentController : ApiController{
   public IHttpActionResult Get(int id){
      Return Ok();
   }
}

• WebApiConfig.csに例外をグローバルに登録します。

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