特性简述:
c#中的特性,是给编码中的代码添加一些数据,也可以理解为说明。例如:给类添加个等级信息,给方法添加个编码日期等等。它必须继承自System.Attribute类或其派生类。
这东西,在代码被框架调用时,很有用,平时编程意义不大。
例:
编写一个特性TestA:
1 class TestA:Attribute 2 { 3 int power; 4 public int Power 5 { 6 get { return power; } 7 set { power = value; } 8 } 9 }
该特性仅仅设定一个整数,表示一段代码的权重(YY的)
编写两个类(其实内容一样),分别给出不同的权重:
1 [TestA(Power=100)] 2 class TestClass1 3 { 4 public string Name { get; set; } 5 public int Age { get; set; } 6 }
还有一个
[TestA(Power = 50)] class TestClass2 { public string Name { get; set; } public int Age { get; set; } }
在主方法中可以取出这两个类的权重:
1 static void Main(string[] args) 2 { 3 var myclass1 = new TestClass1(); 4 var myclass2 = new TestClass2(); 5 var as1 = myclass1.GetType().GetCustomAttributes(typeof(TestA), false); 6 var as2 = myclass2.GetType().GetCustomAttributes(typeof(TestA), false); 7 Console.WriteLine(((TestA)as1[0]).Power); 8 Console.WriteLine(((TestA)as2[0]).Power); 9 Console.ReadKey(); 10 }
运行结果:
除了用在类上,特性还可以用在很多地方,比如字段 、属性、方法、参数。相应获得它们的Info(比如ParameterInfo),然后就可以用对应的GetCustomAttribute获得附加在上面的用户特性。做法与上面类似。
例子看似没什么意义,但如果调用类的是框架,就可以根据特性做很多事情。作为普通程序员,对其有一定了解,至少有助于日后阅读代码。
有些特性类,配合框架,是具备触发条件的。例如.net8中,继承自Attribute的ActionFilterAttribute类,它就有自己的触发条件,可以酌情重写以下方法。
OnActionExecuted(ActionExecutedContext)
在操作执行后、操作结果之前调用。
OnActionExecuting(ActionExecutingContext)
在执行操作之前、模型绑定完成后调用。
OnActionExecutionAsync(ActionExecutingContext, ActionExecutionDelegate)
在操作之前、模型绑定完成后异步调用。
OnResultExecuted(ResultExecutedContext)
在操作结果执行之后调用。
OnResultExecuting(ResultExecutingContext)
在操作结果执行之前调用。
OnResultExecutionAsync(ResultExecutingContext, ResultExecutionDelegate)
在操作结果之前异步调用。
利用这个特点,可以实现MVC结构的鉴权。以下以带控制器的WEBAPI为例。.NET8下调试通过。
要点:
1、名称空间: using Microsoft.AspNetCore.Mvc.Filters;
2、可以通过返回“context.Result”来终止后续Action的执行。它的其他属性见微软文档。
3、该特性/过滤器可以用在动作上,也可以用在控制器上。
步骤:
1、新建webapi项目(略)
2、过滤器代码:
using Microsoft.AspNetCore.Mvc.Filters; using Microsoft.AspNetCore.Mvc; public class MyFilter : ActionFilterAttribute { public int RequestPower { get; set; } public override void OnActionExecuting(ActionExecutingContext context) { int HasPower = 50; if (HasPower < RequestPower) { string? t = context.HttpContext.Request.Headers.Host.ToString(); context.Result = new ContentResult() { Content = t }; } base.OnActionExecuting(context); } }
可以在headers上取Authorization(标准属性,jwt用于存放“权限签名字符串”),或任意非标头属性(如 context.HttpContext.Request.Headers["我的属性"] ,可由js构建)进行鉴权。取下来的内容(用户名、分组等)可以存放在 context.HttpContext.Items 键值对中与控制器共享。
3、控制器代码
[Route("api/[controller]/[action]")] [MyFilter(RequestPower = 100)] [ApiController] public class HomeController : ControllerBase { [HttpGet] public string Get1() { return "ok1"; } [HttpGet] //[MyFilter(RequestPower =40)] public string Get2() { return "ok2"; } }
结果略。