.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。同时也介绍了过滤器的应用、扩展以及依赖注入的相关知识。