.NETCore反射获取所有控制器及方法上特定标签.

.NET Core 反射获取所有控制器及方法上特定标签.

有个需求&＃xff0c;就是在. NET Core中&＃xff0c;我们想在项目 启动时&＃xff0c;获取LinCmsAuthorizeAttribute这个特性标签所有出现的地方&＃xff0c;把他的参数&＃xff0c;放入一个集合并缓存起来&＃xff0c;以便后面使用此数据用于权限验证。

我们通过反射获取所有控制器下及方法的Attribute。

LinCmsAuthorizeAttribute是什么

其代码非常简单&＃xff0c;用于自定义权限验证&＃xff0c;通过重写OnAuthorizationAsync方法&＃xff0c;实现固定权限可分配给动态角色&＃xff08;也能分配给动态用户&＃xff09;。主要就基于权限的授权的实现进行研究&＃xff0c;实现方法级别的权限验证。

• https://www.cnblogs.com/RainingNight/p/dynamic-authorization-in-asp-net-core.html

当然&＃xff0c;这个只是部分代码&＃xff0c;完整代码请查看最下方开源地址&＃xff0c;其中LinCmsAuthorizeAttribute继承AuthorizeAttribute&＃xff0c;拥有指定角色权限控制&＃xff0c;当Permission未指定时&＃xff0c;当过滤器与Authorize功能相同。Module是指模块&＃xff0c;即多个权限&＃xff0c;属于同一个模块&＃xff0c;方便前台展示为树型结构。Permission属性的值不可重复。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple &＃61; true)]
public class LinCmsAuthorizeAttribute : AuthorizeAttribute, IAsyncAuthorizationFilter
{public string Permission { get; set; }public string Module { get; set; }public LinCmsAuthorizeAttribute(){}public LinCmsAuthorizeAttribute(string permission,string module){Permission &＃61; permission;Module &＃61; module;}public LinCmsAuthorizeAttribute(string permission,string module, string policy) : base(policy){Permission &＃61; permission;Module &＃61; module;}public async Task OnAuthorizationAsync(AuthorizationFilterContext context){if (Permission &＃61;&＃61; null) return;var authorizationService &＃61; (IAuthorizationService)context.HttpContext.RequestServices.GetService(typeof(IAuthorizationService));var authorizationResult &＃61; await authorizationService.AuthorizeAsync(context.HttpContext.User, null, new OperationAuthorizationRequirement() { Name &＃61; Permission });if (!authorizationResult.Succeeded){context.Result &＃61; new ForbidResult();}}public override string ToString(){return $"\"{base.ToString()}\",\"Permission:{Permission}\",\"Module:{Module}\",\"Roles:{Roles}\",\"Policy:{Policy}\",\"AuthenticationSchemes:{AuthenticationSchemes}\"";}
}


Controller

在 LinCms.Web中的Controller&＃xff0c;至于为什么Permission为中文&＃xff0c;目前的主要原因&＃xff0c;此项目用于适配 Lin-CMS-VUE项目,所以于平常我们以某个字符串作为权限名不同&＃xff0c;但不须大精小怪&＃xff0c;道理相同。

[Route("cms/log")]
[ApiController]
public class LogController : ControllerBase
{private readonly ILogService _logService;public LogController(ILogService logService){_logService &＃61; logService;}[HttpGet("users")][LinCmsAuthorize("查询日志记录的用户", "日志")]public List GetLoggedUsers([FromQuery]PageDto pageDto){return _logService.GetLoggedUsers(pageDto);}[HttpGet][LinCmsAuthorize("查询所有日志", "日志")]public PagedResultDto GetLogs([FromQuery]LogSearchDto searchDto){return _logService.GetLogUsers(searchDto);}[HttpGet("search")][LinCmsAuthorize("搜索日志", "日志")]public PagedResultDto SearchLogs([FromQuery]LogSearchDto searchDto){return _logService.GetLogUsers(searchDto);}
}


测试类获取方法上的特定标签

in xunit test 项目工程中&＃xff0c;开始我们的测试

[Fact]
public void GetAssemblyMethodsAttributes()
{var assembly &＃61; typeof(Startup).Assembly.GetTypes().AsEnumerable().Where(type &＃61;> typeof(ControllerBase).IsAssignableFrom(type)).ToList();assembly.ForEach(r &＃61;>{foreach (var methodInfo in r.GetMethods()){foreach (Attribute attribute in methodInfo.GetCustomAttributes()){if (attribute is LinCmsAuthorizeAttribute linCmsAuthorize){_testOutputHelper.WriteLine(linCmsAuthorize.ToString());}}}});
}


方法结果

可在输出文本中查看&＃xff0c;正是我们想要的东西&＃xff0c;最后一行&＃xff0c;是其他Controller中的内容&＃xff0c;而且我们重写了ToString(),所以我们能看到其属性。

"LinCms.Zero.Authorization.LinCmsAuthorizeAttribute","Permission:查询日志记录的用户","Module:日志","Roles:","Policy:","AuthenticationSchemes:"
"LinCms.Zero.Authorization.LinCmsAuthorizeAttribute","Permission:查询所有日志","Module:日志","Roles:","Policy:","AuthenticationSchemes:"
"LinCms.Zero.Authorization.LinCmsAuthorizeAttribute","Permission:搜索日志","Module:日志","Roles:","Policy:","AuthenticationSchemes:"
"LinCms.Zero.Authorization.LinCmsAuthorizeAttribute","Permission:查看lin的信息","Module:信息","Roles:","Policy:","AuthenticationSchemes:"

获取控制器上特性标签

///

Controller结果

只有AdminController加了此标签&＃xff0c;所以只有一行。

"LinCms.Zero.Authorization.LinCmsAuthorizeAttribute","Permission:","Module:","Roles:Administrator","Policy:","AuthenticationSchemes:"


此时Roles为Administrator&＃xff0c;Permission及Module都是null&＃xff0c;
这是因为只有AdminController中加了LinGroup.Administrator&＃61;"Administrator"字符串&＃xff0c;在登录过程中&＃xff0c;已经给当前登录用户设置了 new Claim(ClaimTypes.Role,user.IsAdmin()?LinGroup.Administrator:user.GroupId.ToString())&＃xff0c;即"Administrator,当用户访问AdminController中的方法时&＃xff0c;LinCmsAuthorize并没有做相关验证&＃xff0c;都是AuthorizeAttribute&＃xff0c;实现了固定角色权限的判断及登录的判断。LinCmsAuthorize完成了固定权限设置为不同的动态角色后&＃xff0c;判断用户是否拥有此权限。

[LinCmsAuthorize(Roles &＃61; LinGroup.Administrator)]
public class AdminController : ControllerBase
{...
}


参考

• c# – 如何在asp. net core rc2中获取控制器的自定义属性 https://codeday.me/bug/20181207/453278.html

开源地址

• github.com/luoyunchong/lin-cms-dotnetcore