一.概述
本篇详细了解一下asp.net core filters,filter叫"筛选器"也叫"过滤器",是请求处理管道中的特定阶段之前或之后运行代码。filter用于处理横切关注点。 横切关注点的示例包括:错误处理、缓存、配置、授权和日志记录。 filter可以避免重复代码,通过Attribute特性来实现filter过滤。Filter适应于 Razor Pages, API controllers, mvc controllers。filter基类是IFilterMetadata 接口,该接口只是用来标记是一个filter过滤器。
前段时间在项目中实现了IAsyncAuthorizationFilter接口对用户访问controller或action进行了授权,在OnAuthorizationAsync方法中使用context.Result可使管道短道。IAsyncAuthorizationFilter是属于授权过滤器中的一种。勿在授权过滤器内抛出异常,这是因为所抛出的异常不会被处理。下面是简要的实现授权代码:
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] public class PermissionFilter : Attribute,IAsyncAuthorizationFilter { public Task OnAuthorizationAsync(AuthorizationFilterContext context) { IIdentity user = context.HttpContext.User.Identity; if (!user.IsAuthenticated) { //跳转到登录页 context.Result = new LocalRedirectResult(url); return Task.CompletedTask; } //根据当前用户,判断当前访问的action,没有权限时返回403错误 context.Result = new ForbidResult(); return Task.CompletedTask; } }
在官方文档中说到:"自定义授权筛选器Filter需要自定义授权框架, 建议配置授权策略或编写自定义授权策略,而不是编写自定义Filter筛选器"。
这里的意思是说,如果在项目中不使用asp.net core自带的identity,那么需要自定义授权框架,也就是需要自己建立一套用户权限表。 如果使用了identity建议配置授权策略或编写自定义授权策略。如果不用identity自己建立用户权限表,那么就可以编写自定义Filter筛选器。我在项目开发中是自己建立了用户权限表没有用identity。因为使用identity表还需要扩展字段,而且与EF core结合紧密,如果不使用EF core需要重写访问identity表的实现。
下面是identity与ef core相关的代码:
services.AddIdentity<ApplicationUser, IdentityRole>() .AddEntityFrameworkStores<ApplicationDbContext>() .AddDefaultTokenProviders(); -- TContext必须是DbContext类型 public static IdentityBuilder AddEntityFrameworkStores<TContext>(this IdentityBuilder builder) where TContext : DbContext
二.Filter 筛选器类型
Authorization filters 授权筛选器
Resource filters 资源筛选器
Action filters 操作筛选器 (Razor Pages 中使用 IPageFilter 和 IAsyncPageFilter)
Exception filters 异常筛选器
Result filters 结果筛选器
每种Filter 类型都在Filter 管道中的不同阶段执行,当用户请求进来时,经过Filter管道,执行Filter的阶段顺序如下所示:
上面每种Filter 类型都有自己的接口,都同时支持同步和异步实现,上面的授权示例就是一个异步实现授权筛选器IAsyncAuthorizationFilter。Filter 接口或直接或间接实现了IFilterMetadata接口,IFilterMetadata接口只是用来标记是一个Filter 。
三.filter筛选器作用域
(1) 将 attribute特性应用在 action上。
(2) 将 attribute特性应用在 controller上。
(3) 全局筛选器应用在controller和action上
下面使用全局筛选器,使用MvcOptions.Filters 集合,添加三个筛选器,如下面的代码所示:
public void ConfigureServices(IServiceCollection services) { services.AddMvc(options => { options.Filters.Add(new AddHeaderAttribute("GlobalAddHeader", "Result filter added to MvcOptions.Filters")); // An instance options.Filters.Add(typeof(MySampleActionFilter)); // By type options.Filters.Add(new SampleGlobalActionFilter()); // An instance }).SetCompatibilityVersion(CompatibilityVersion.Version_2_2); }
//实现了内置筛选器属性 public class AddHeaderAttribute : ResultFilterAttribute //实现了操作筛选器 public class MySampleActionFilter : IActionFilter //实现了操作筛选器 public class SampleGlobalActionFilter : IActionFilter