.NET Core 過濾器詳解

在 .NET Core 中，過濾器是一種很重要的機制，它可以在請求管道的不同階段中加入代碼，對請求進行處理以及做出響應。 該過濾器是用於解決攔截，驗證，記錄日誌，緩存和處理異常等問題。

一、過濾器的分類

1.1 Authorization Filter

授權過濾器可以幫助你控制哪個用戶可以訪問你的應用程序，並在滿足某些條件時將用戶轉到指定的授權頁面。一個授權過濾器是系統中第一個運行的過濾器。

public class CustomAuthorizeAttribute : AuthorizeAttribute, IAuthorizationFilter
{
  public void OnAuthorization(AuthorizationFilterContext context)
  {
      var hasAccess = CheckAccess(context.HttpContext.User.Identity.Name);
      if (!hasAccess)
      {
          context.Result = new RedirectToRouteResult(
            new RouteValueDictionary(
              new { controller = "Home", action = "AccessDenied" }));
      }
  }
}

1.2 Action Filter

Action Filter 是過濾器中最常用的類型之一。它可以在 Action 執行前後處理請求，對請求進行攔截，在路由和模型綁定之後、執行 Action 之前和之後執行代碼。

public class CustomActionFilterAttribute : Attribute, IActionFilter
{
  public void OnActionExecuting(ActionExecutingContext filterContext)
  {
      // logic before action executes
  }

  public void OnActionExecuted(ActionExecutedContext filterContext)
  {
      // logic after action executes
  }
}

1.3 Exception Filter

異常過濾器用於捕獲和處理應用程序中拋出的異常。如果未處理異常，則應用程序將終止。異常過濾器可以在異常處理程序之前攔截異常。

public class CustomExceptionFilterAttribute : Attribute, IExceptionFilter
{
  public void OnException(ExceptionContext context)
  {
      // Log the exception
      // Send error information to stakeholders
  }
}

1.4 Result Filter

結果過濾器處理在執行 Action 後生成的結果，例如，它可以修改從 Action 返回的視圖結果或在返回結果之前記錄一些信息。

public class CustomResultFilterAttribute : Attribute, IResultFilter
{
  public void OnResultExecuting(ResultExecutingContext context)
  {
      // logic before result executes
  }

  public void OnResultExecuted(ResultExecutedContext context)
  {
      // logic after result executes
  }
}

二、過濾器的應用

2.1 過濾器的順序執行

在 ASP.NET Core 應用程序中，過濾器的執行順序非常重要。如果多個過濾器存在，它們將按照預定義的順序應用。 ASP.NET Core 中的過濾器共有3個順序：

• Authorization Filter
• Resource Filter
• Action/Result Filter

2.2 全局過濾器

全局過濾器是在應用程序的全局範圍內應用的過濾器。 它們在 Startup.cs 文件中設置，並在應用程序啟動時配置。 當您需要在應用程序的所有請求和響應之間共享任何數據時，全局過濾器非常有用。

services.AddMvc(config =>
{
    config.Filters.Add(new CustomActionFilterAttribute());
    config.Filters.Add(new CustomResultFilterAttribute());
});

上面的示例演示了如何在全局註冊自定義 Action Filter 和 Result Filter。

三、過濾器的擴展

3.1 自定義參數

過濾器參數可以讓您輕鬆自定義和創建自己的過濾器。 您可以在過濾器參數中傳遞自定義信息以執行請求處理操作。

public class SampleFilterAttribute : Attribute, IResourceFilter
{
    private readonly string _parameter;

    public SampleFilterAttribute(string parameter)
    {
        _parameter = parameter;
    }

    public void OnResourceExecuted(ResourceExecutedContext context)
    {
        // Perform logic after execution of action
    }

    public void OnResourceExecuting(ResourceExecutingContext context)
    {
        // Perform logic before execution of action

        if (_parameter == "test")
        {
            // perform operation
        }
    }
}

3.2 過濾器依賴注入

在自定義過濾器中使用依賴注入是非常常見的組件框架實踐。 在 ASP.NET Core 中，您可以使用依賴注入容器將依賴項注入到過濾器中。

public interface ICustomService
{
    string GetOperationResult();
}

public class CustomService : ICustomService
{
    public string GetOperationResult()
    {
        return "Service operation completed.";
    }
}

public class SampleFilter : IAuthorizationFilter
{
    private readonly ICustomService _customService;

    public SampleFilter(ICustomService customService)
    {
        _customService = customService;
    }

    public void OnAuthorization(AuthorizationFilterContext context)
    {
        var result = _customService.GetOperationResult();
        // Perform custom authorization logic based on custom service
    }
}

四、總結

.NET Core 過濾器是一個強大的工具，可以對 ASP.NET Core 應用程序進行授權、驗證、異常處理、日誌記錄和緩存處理等。本文對過濾器的四種類型進行了介紹，包括 Authorization Filter、Action Filter、Exception Filter 和 Result Filter。同時也介紹了過濾器的應用、擴展以及依賴注入的相關知識。