前言
咱们上篇说到,过滤的简单介绍,但是未介绍如何使用,接下来几篇,我来给大家讲讲如何使用,今天第一篇是Authorization。认证过滤器,
开发环境介绍
开发工具:VS2019
开发环境:.net core 3.1
1.创建项目
首先创建一个Api的项目,选择.net core的版本,选择好,点击创建即可
2 创建一个自定义类
public class AuthenticationTest: IAuthorizationFilter { public void OnAuthorization(AuthorizationFilterContext context) { //逻辑处理 } }
查看IAuthorizationFilter源代码
IAuthorizationFilter接口只有一个方法OnAuthorization,
创建一个类,继承IAuthorizationFilter接口,然后实现一下接口方法。是不是有点疑问,AuthorizationFilterContext是什么?
3 AuthorizationFilterContext是什么?
中文理解:授权过滤器上下文
六大属性:
- ActionDescriptor:获取或设置所选动作的ActionDescriptor。(获取请求的Method)
- Filters:获取所有适用的IFilterMetadata实现。(可以检测请求的Action是否具备AllowAnonymous,如果有,则直接跳过AuthorizationFilter滤器)
- HttpContext:获取或设置当前请求的HttpContext。(获取当前请求的很多信息,例如当前用户信息,当前请求的Heads[可以从Head获取Token,即验证Token])
- ModelState:获取模型状态字典。在你使用MVC框架下,对Molde进行验证的时候才会使用到,去验证模型是否验证通过。
- Result:获取或设置请求的结果。将结果设置为null授权过滤器内的非值将使过滤器管道的其余部分短路。
- RouteData:获取或设置当前请求的RouteData。(获取当前路由的信息)
4 编写简答的业务逻辑
public class AuthenticationTest: IAuthorizationFilter { public void OnAuthorization(AuthorizationFilterContext context) { Console.WriteLine("我是Authorization过滤器"); //请求的地址 var url = context.HttpContext.Request.Path.Value; #region 打印头部信息 var heads = context.HttpContext.Request.Headers; string msg = string.Empty; foreach (var item in heads) { msg += item.Key + ":" + item.Value + "\r\n"; } Console.WriteLine("我是heads:" + msg); #endregion } }
5 注册全局过滤器
找到Startup.cs文件,然后找到其中一个方法ConfigureServices,将代码修改为这样:
public void ConfigureServices(IServiceCollection services) { services.AddControllers(); //全局添加过滤器 #region 全局过滤器 services.AddMvc(a => { a.Filters.Add<AuthenticationTest>(); }); #endregion }
6.启动项目(这里是使用Kestrel作为服务器启动,启动的是控制台程序)
启动之后,会在控制台打印如上图所示,我们可以获取当前请求的Head信息。如果Head包含Token,我们也是可以获取token,然后验证token,后面可以进行一系列自己的逻辑运算。
7.1扩展IAsyncAuthorizationFilter
过滤器还存在一个异步过滤器,它是继承IAsyncAuthorizationFilter
public class AsyncAuthentication : IAsyncAuthorizationFilter { public Task OnAuthorizationAsync(AuthorizationFilterContext context) { return Task.CompletedTask; } }
异步确认请求授权的过滤器,和之前的IAuthorizationFilter区别,大家显而易见,只是处理请求的方式不一样,一个是同步,一个是异步,如果了解线程,就应该了解二者的区别,在这只做简单介绍,编写你自己业务逻辑,可以自由编写。
7.2 扩展:修改401返回的返回值 正常的401报错:
public class AuthenticationTest: IAuthorizationFilter { public void OnAuthorization(AuthorizationFilterContext context) { context.Result = new StatusCodeResult(401); } }
效果如下图:
这种并不是客户想看到的,我们可以自定义返回值。
自定义的401报错:
public class AuthenticationTest: IAuthorizationFilter { public void OnAuthorization(AuthorizationFilterContext context) { context.Result = new JsonResult(new { StatusCodeResult = StatusCodes.Status401Unauthorized, Title = "401", Time = DateTime.Now,test="测试" }); } }
效果如下图:
自定义设置返回的值,是没有限制,可以根据场景进行自定义,合适才是最好。
8.总结:
通过上面的一顿操作,我们应该能明白,一个自定义的权限过滤器的创建,注册,使用等。这个过滤器让我们能控制用户的请求,哪些是请求是当前用户可以匿名登录,哪些请求是当前用户无权访问的,在一方面,可以帮助我编写自定义的权限管理,还是那句话,合适才是重要的!
到此这篇关于.net core中的Authorization过滤器使用的文章就介绍到这了,更多相关.net core 过滤器内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!
作者:喜欢吃鱼的青年 出处:https://home.cnblogs.com/u/2828sea/