C# ASP.NET Web APIのフィルターの種類と使い方を徹底解説

ASP.NET Web APIフレームワークでは、リクエスト処理のさまざまな段階に追加のロジックを組み込むために「フィルター」が使用されます。フィルターは、ロギング、認可、キャッシュといった横断的関心事（クロスカッティングコンサーン）を実装するための仕組みであり、アクションメソッドやコントローラーに対して、宣言的またはプログラム的に適用できます。

ここでは、C#のWeb APIで利用できる主なフィルターの種類について詳しく見ていきましょう。

Web APIの主なフィルターの種類

1. 認証フィルター（Authentication Filter）

認証フィルターは、ユーザーの身元情報を検証するために使用されます。このフィルター内には、ユーザーが正当なものであるかどうかを確認するロジックを記述します。

2. 認可フィルター（Authorization Filter）

認可フィルターは、ユーザーのアクセス権限をチェックする役割を担います。フレームワークでは、IAuthorizationFilterインターフェースを実装することで独自の認可フィルターを作成できます。

3. アクションフィルター（Action Filter）

アクションフィルターは、アクションメソッドの実行前後に追加のロジックを差し込むために使われます。OnActionExecutingメソッドで実行前の処理を、OnActionExecutedメソッドで実行後の処理をそれぞれ記述します。

4. 例外フィルター（Exception Filter）

例外フィルターは、コントローラーメソッドがHttpResponseException以外の未処理の例外をスローしたときに実行されます。HttpResponseExceptionはHTTPレスポンスを返すために特別に設計された例外であるため、このフィルターの対象外となります。

5. オーバーライドフィルター（Override Filter）

オーバーライドフィルターは、個々のアクションメソッドに対して他のフィルターの動作をカスタマイズするために使用されます。たとえば、コントローラーレベルでフィルターを適用していても、特定のアクションメソッドではそのフィルターを無効化したいといったケースで、オーバーライド版のフィルターを活用できます。

フィルターを適用できる3つのレベル

フィルターは一般的に、以下の3つのレベルで適用されます。

• コントローラーレベル
• アクションメソッドレベル
• グローバルレベル（WebApiConfig.cs）

認可フィルターの実装例

それでは、認可フィルターの実装例とその動作を確認してみましょう。

using System.Web.Http;
namespace DemoWebApplication.Controllers{
    public class DemoController : ApiController{
        [Authorize]
        public IHttpActionResult Get(){
            return Ok();
        }
    }
}

上記のコードでは、アクションメソッドに[Authorize]属性を付与しています。そのため、このアクションメソッドへアクセスするには、ベアラートークン、APIキー、OAuthなどの適切な認可情報が必要になります。認可されていない状態でアクセスすると、以下のように401 Unauthorizedレスポンスが返されます。