筛选器（过滤器）

冰冰在努力

于 2024-09-06 16:08:03 发布

阅读量664

点赞数 24

分类专栏：企业级技术文章标签： c# asp.net 架构 .net 学习

本文链接：https://blog.csdn.net/m0_65963001/article/details/141962249

版权

企业级技术专栏收录该内容

17 篇文章 0 订阅

订阅专栏

一、什么是筛选器？

筛选器（又名过滤器或拦截器）是ASP.NET Core中用于在请求处理管道的特定阶段前后执行自定义代码的一种机制。它实现了一种面向切面编程（AOP）的方式，可以在控制器的动作方法（Action）执行之前或之后，甚至在返回结果之前或之后进行操作。
通俗解释：想象你有一个Web API，当客户端发送请求时，你希望在执行请求前后做一些额外的工作，比如记录日志、验证用户权限、处理错误等。筛选器正是用来帮助你在这些关键点插入代码的工具。
在这里插入图片描述

二、筛选器的应用场景

筛选器可以应用于许多场景，如：

错误处理：在请求过程中捕捉异常并记录日志或返回自定义错误响应。
缓存处理：在请求执行之前检查是否有缓存的响应，以减少服务器负担。
授权处理：在请求到达控制器之前验证用户的权限。
日志记录：记录每个请求的详细信息，包括请求参数和响应结果。
事务处理：在操作数据库时，确保操作在一个事务中进行，如果操作失败，可以回滚。

三、筛选器的类型

筛选器有几种不同的类型，每种类型适用于特定的场景：

授权筛选器：在请求处理管道的最开始运行，用于验证用户是否有权限访问特定资源。如果权限验证失败，筛选器可以终止请求并返回错误响应。

示例接口：IAuthorizationFilter，IAsyncAuthorizationFilter
资源筛选器：在授权后执行，可以用来在进一步处理请求之前执行一些逻辑，比如缓存处理。

示例接口：IResourceFilter，IAsyncResourceFilter
操作筛选器：在控制器的动作方法（Action）执行前后运行，可以用来操作请求参数或返回结果。

示例接口：IActionFilter，IAsyncActionFilter
异常筛选器：用于处理未捕获的异常，在异常发生时提供全局处理策略。

示例接口：IExceptionFilter，IAsyncExceptionFilter
结果筛选器：在操作结果（如视图或JSON响应）生成前后运行，用于修改或处理操作结果。

示例接口：IResultFilter，IAsyncResultFilter
Razor Pages筛选器：专用于Razor Pages项目，类似于操作筛选器，但只适用于页面处理程序方法。

示例接口：IPageFilter，IAsyncPageFilter

四、筛选器的类型

你可以通过以下几种方式在ASP.NET Core中使用筛选器：

1. 在Startup.cs中全局注册

你可以在Startup.cs文件中通过服务配置来全局注册筛选器，使其适用于所有控制器或页面。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews(options =>
    {
        options.Filters.Add(new MyCustomFilter()); // 全局注册
    });
}

2. 特性方式

通过在控制器或动作方法上应用特性（Attribute），你可以局部应用筛选器。这种方式通常用于针对特定的控制器或动作方法。

[MyCustomFilter] // 仅对该控制器或方法有效
public class MyController : Controller
{
    public IActionResult Index()
    {
        // Action 方法代码
    }
}

3. 通过依赖注入（DI）使用ServiceFilter或TypeFilter

ServiceFilter：允许你通过依赖注入来使用筛选器。你需要先在Startup.cs中注册筛选器，然后在控制器中使用[ServiceFilter]特性。

services.AddScoped<MyCustomFilter>(); // 注册服务

public class MyController : Controller
{
    [ServiceFilter(typeof(MyCustomFilter))]
    public IActionResult Index()
    {
        // Action 方法代码
    }
}

TypeFilter：与ServiceFilter类似，但允许你传递额外的参数给筛选器的构造函数。

public class MyController : Controller
{
    [TypeFilter(typeof(MyCustomFilter), Arguments = new object[] { "parameter1", 123 })]
    public IActionResult Index()
    {
        // Action 方法代码
    }
}

五、筛选器的类型筛选器的执行顺序

不同类型的筛选器按以下顺序执行：

授权筛选器
资源筛选器
操作筛选器
异常筛选器
结果筛选器

如果需要控制相同类型筛选器的执行顺序，可以实现IOrderedFilter接口，并设置Order属性，数值越高优先执行。

六、筛选器的类型筛选器的依赖注入

筛选器支持构造函数依赖注入服务，这使得它们可以更好地与ASP.NET Core的依赖注入系统集成。在使用依赖注入时，你需要在Startup.cs中注册你的筛选器类：

public void ConfigureServices(IServiceCollection services)
{
    services.AddScoped<MyCustomFilter>();
}