asp.net core 自定义过滤器 注入的几种方式和实现

在 ASP.NET Core 中，过滤器（Filters）是一种在 MVC 应用程序中运行代码的方法，可以在操作（Actions）执行之前或之后运行。过滤器可以应用于控制器（Controllers）或特定的操作方法。过滤器可以用来实现跨切面的逻辑，比如异常处理、授权、缓存、日志等。

有几种类型的过滤器：

• 授权过滤器（Authorization filters）
• 资源过滤器（Resource filters）
• 操作过滤器（Action filters）
• 异常过滤器（Exception filters）
• 结果过滤器（Result filters）

自定义过滤器通常通过实现特定的过滤器接口来创建，如 IAuthorizationFilter, IResourceFilter, IActionFilter, IExceptionFilter, IResultFilter，或者通过继承 Filter 的抽象类，如 ActionFilterAttribute。

过滤器的注入方式：

1. 构造函数注入：在 ASP.NET Core 中，过滤器是通过依赖注入（DI）容器中注册的服务来解析的。这意味着可以在自定义过滤器的构造函数中注入所需的依赖。

示例：

public class MyCustomFilter : IActionFilter
{
    private readonly IMyDependency _myDependency;

    public MyCustomFilter(IMyDependency myDependency)
    {
        _myDependency = myDependency;
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
        // 使用 _myDependency
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        // 其他逻辑
    }
}

注： 这种方式要求过滤器本身也需要通过服务注册添加到 DI 容器：

services.AddScoped<IMyDependency, MyDependency>();
services.AddScoped<MyCustomFilter>();

2. 服务查找：在过滤器内部通过服务定位器模式来解析服务。这通常在无法直接使用构造函数注入的情况下使用，例如使用属性注入或基于属性的过滤器。

示例：

public class MyCustomFilter : IActionFilter
{
    private IMyDependency _myDependency;

    public void OnActionExecuting(ActionExecutingContext context)
    {
        _myDependency = context.HttpContext.RequestServices.GetService<IMyDependency>();
        // 使用 _myDependency
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        // 其他逻辑
    }
}

这种方法虽然方便，但有时会被认为是一个反模式，因为它违反了依赖注入的原则，并且使得依赖关系隐蔽而不是显式的。

3. 通过 TypeFilter 或 ServiceFilter 属性注入：当你希望在过滤器属性中指定组件类型，并通过依赖注入容器来解析依赖时，可以使用 TypeFilter 或 ServiceFilter 属性。这两个属性允许您将服务添加到过滤器，并通过属性的方式应用到控制器或动作方法。

示例 (TypeFilter):

[TypeFilter(typeof(MyCustomFilter))]
public class MyController : Controller
{
    // 控制器动作
}

// 或者在 Action 上：

[TypeFilter(typeof(MyCustomFilter))]
public IActionResult MyAction()
{
    // 动作逻辑
}

示例 (ServiceFilter):

[ServiceFilter(typeof(MyCustomFilter))]
public class MyController : Controller
{
    // 控制器动作
}

// 或者在 Action 上：

[ServiceFilter(typeof(MyCustomFilter))]
public IActionResult MyAction()
{
    // 动作逻辑
}

注意 ServiceFilter 需要过滤器类型已经被注册到依赖注入容器。

4. 使用 AddMvcOptions 或 AddControllers 添加全局过滤器：全局过滤器适用于所有控制器和操作方法。

services.AddControllers(options =>
{
    options.Filters.Add<MyCustomFilter>(); // 添加自定义全局过滤器
});

这些都是 ASP.NET Core 中注入自定义过滤器的常用方法。选择最佳方法主要取决于场景和需求，例如是否需要全局应用过滤器，或者是否希望通过依赖注入来解耦过滤器和它的依赖。