ASP.NET Core中的资源筛选器是什么?如何创建?

资源筛选器是ASP.NET Core中最早执行的过滤器,作用于MVC请求管道,可用于缓存、授权、日志等全局任务,通过实现IResourceFilter接口或继承Attribute类创建,支持依赖注入,适用于需在控制器前后执行且与MVC上下文交互的场景。

asp.net core中的资源筛选器是什么?如何创建?

资源筛选器,简单来说,就是ASP.NET Core请求管道中的一道关卡,让你有机会在请求处理的早期介入,执行一些全局性的任务,比如缓存、授权,甚至可以短路请求直接返回响应。它比授权过滤器更早执行,比其他类型的过滤器作用域更广。

资源筛选器是ASP.NET Core中一种强大的请求处理管道组件,它允许你在请求到达控制器之前或之后执行代码。这使得资源筛选器非常适合处理横切关注点,例如缓存、授权和日志记录。

资源筛选器与其他过滤器的区别

资源筛选器和其他过滤器(如授权过滤器、操作过滤器、异常过滤器和结果过滤器)的主要区别在于它们的执行顺序和作用域。

执行顺序: 资源筛选器是第一个执行的过滤器,在授权过滤器之前。这意味着资源筛选器可以影响授权过程,例如通过检查缓存并短路请求。作用域: 资源筛选器的作用域比其他过滤器更广。它们可以影响整个请求处理管道,而不仅仅是特定的控制器或操作。

简单来说,你可以把资源过滤器看作是守门员,在请求进入“核心区域”之前,先进行一轮检查和处理。

如何创建自定义资源筛选器?

创建自定义资源筛选器,主要有两种方式:实现

IResourceFilter

接口或继承

Attribute

并实现

IResourceFilter

接口。 推荐使用第二种方式,可以方便地通过特性标记来应用筛选器。

1. 实现

IResourceFilter

接口:

public class MyResourceFilter : IResourceFilter{    private readonly ILogger _logger;    public MyResourceFilter(ILogger logger)    {        _logger = logger;    }    public void OnResourceExecuting(ResourceExecutingContext context)    {        _logger.LogInformation("MyResourceFilter - OnResourceExecuting");        // 在这里执行请求处理前的逻辑        // 例如:检查缓存,如果存在则短路请求    }    public void OnResourceExecuted(ResourceExecutedContext context)    {        _logger.LogInformation("MyResourceFilter - OnResourceExecuted");        // 在这里执行请求处理后的逻辑        // 例如:更新缓存    }}

2. 继承

Attribute

并实现

IResourceFilter

接口(推荐):

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]public class MyResourceFilterAttribute : Attribute, IResourceFilter{    private readonly ILogger _logger;    public MyResourceFilterAttribute(ILogger logger)    {        _logger = logger;    }    public void OnResourceExecuting(ResourceExecutingContext context)    {        _logger.LogInformation("MyResourceFilterAttribute - OnResourceExecuting");        // 在这里执行请求处理前的逻辑        // 例如:检查缓存,如果存在则短路请求        // 示例:短路请求        // context.Result = new ContentResult { Content = "请求被资源筛选器短路!" };    }    public void OnResourceExecuted(ResourceExecutedContext context)    {        _logger.LogInformation("MyResourceFilterAttribute - OnResourceExecuted");        // 在这里执行请求处理后的逻辑        // 例如:更新缓存    }}

3. 注册筛选器:

Startup.cs

ConfigureServices

方法中注册筛选器:

public void ConfigureServices(IServiceCollection services){    services.AddControllers(options =>    {        // 全局注册        // options.Filters.Add(new MyResourceFilter());    });    // 注册Logger    services.AddLogging();    // 注册筛选器依赖    services.AddScoped();    services.AddScoped();}

4. 应用筛选器:

全局应用:

ConfigureServices

中,通过

options.Filters.Add(new MyResourceFilter());

全局注册。控制器或操作级别应用: 使用特性标记:

[MyResourceFilter]

[TypeFilter(typeof(MyResourceFilter))]
[ApiController][Route("[controller]")][MyResourceFilterAttribute] // 使用特性标记public class WeatherForecastController : ControllerBase{    private readonly ILogger _logger;    public WeatherForecastController(ILogger logger)    {        _logger = logger;    }    [HttpGet]    //[TypeFilter(typeof(MyResourceFilter))] // 也可以这样使用    public IEnumerable Get()    {        return Enumerable.Range(1, 5).Select(index => new WeatherForecast        {            Date = DateTime.Now.AddDays(index),            TemperatureC = Random.Shared.Next(-20, 55),            Summary = Summaries[Random.Shared.Next(Summaries.Length)]        })        .ToArray();    }}

注意,使用

TypeFilter

可以解决构造函数注入的问题,而直接使用特性标记则需要在

ConfigureServices

中注册依赖。

资源筛选器在实际项目中的应用场景有哪些?

资源筛选器的应用场景非常广泛,以下是一些常见的例子:

缓存:

OnResourceExecuting

中检查缓存,如果缓存命中,则短路请求,直接返回缓存数据。在

OnResourceExecuted

中更新缓存。授权: 虽然有专门的授权过滤器,但资源筛选器可以在更早的阶段进行一些预授权检查,例如检查用户是否已登录。日志记录: 记录请求的开始和结束时间,以及其他相关信息。请求验证: 对请求数据进行全局验证,例如检查请求头是否包含必要的参数。防止CSRF攻击: 在请求处理的早期阶段验证 Anti-Forgery Token。全局异常处理: 虽然有异常过滤器,但资源筛选器可以在更早的阶段捕获一些异常,并进行处理。

如何在资源筛选器中访问和修改请求和响应?

ResourceExecutingContext

ResourceExecutedContext

中,你可以访问和修改请求和响应。

访问请求: 通过

context.HttpContext.Request

访问请求对象。你可以读取请求头、查询字符串、请求体等信息。修改请求: 虽然不建议直接修改请求,但在某些情况下,你可能需要修改请求头或查询字符串。访问响应: 通过

context.HttpContext.Response

访问响应对象。修改响应: 你可以修改响应头、状态码、响应体等信息。短路请求: 通过设置

context.Result

来短路请求,并返回自定义的响应。

例如,以下代码演示了如何在资源筛选器中读取请求头,并设置响应头:

public void OnResourceExecuting(ResourceExecutingContext context){    string userAgent = context.HttpContext.Request.Headers["User-Agent"];    _logger.LogInformation($"User-Agent: {userAgent}");    context.HttpContext.Response.Headers.Add("X-Custom-Header", "Hello from Resource Filter");}

资源筛选器与中间件的区别?什么时候应该使用资源筛选器?什么时候应该使用中间件?

资源筛选器和中间件都是 ASP.NET Core 请求管道中的组件,但它们的作用域和执行顺序不同。

作用域: 中间件的作用域是整个请求管道,而资源筛选器的作用域是 MVC 管道的一部分。执行顺序: 中间件在资源筛选器之前执行。

什么时候应该使用资源筛选器?

当你需要访问或修改 MVC 特定的上下文时,例如

ActionArguments

ModelState

等。当你需要在控制器执行前后执行代码时。当你需要利用 ASP.NET Core 的依赖注入系统时。

什么时候应该使用中间件?

当你需要在请求处理的早期阶段执行代码时,例如处理静态文件、重定向请求等。当你需要处理非 MVC 请求时,例如 WebSocket 请求。当你需要完全控制请求管道时。

总的来说,如果你的逻辑与 MVC 框架紧密相关,那么使用资源筛选器可能更合适。如果你的逻辑与 MVC 框架无关,或者需要在请求处理的早期阶段执行,那么使用中间件可能更合适。

选择哪种方式取决于你的具体需求。记住,资源筛选器更侧重于 MVC 管道,而中间件则更通用。

以上就是ASP.NET Core中的资源筛选器是什么?如何创建?的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1439377.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月17日 16:08:09
下一篇 2025年12月17日 16:08:22

相关推荐

发表回复

登录后才能评论
关注微信