C#特性(Attribute)
这节讲一下:特性(Attribute)。
特性,是用来给代码添加额外信息的一种手段,我们通常是将特性标记到方法,类或者属性上,在使用的这些结构的时候,通过反射(reflection)这一非常高级的技术,获取它们通过特性标记的信息,从而进行某些特殊的处理。
系统也给我们提供了一些特性,比如Serializable 标记一个可序列化的类,DebuggerStepThrough设置方法在调试时为跳过的状态。
特性的使用很简单,在结构声明的上一行,用"[]"扩起特性类名即可:
[Serializable] class Sunshine{...}
它其实是省略了(),如果使用特性的其它的构造方法,显示声明即可:
[Serializable("test")] class Sunshine{...}
了解更多特性请自行查阅官方文档
接下来,看一下如何自定义特性,请先看如下代码:
class MyAttribute : Attribute { private string name; public MyAttribute(string name) { this.name = name; } public void GetName() { Console.WriteLine($"my name is {name}"); } } [My("charles")] public void ShowAttribute() { Console.WriteLine("I have a Attribute"); }
自定义特性,很简单,让一个类继承Attribute类即可,这是OOP的很常用的操作,另外,自定义的特性,名称后缀约定是Attribute结尾,使用的时候这个后缀可以省略。现在我们用反射,读取这个方法的特性信息:
Type type = typeof(Program);//获取这个类的类型信息 MethodInfo methodInfo = type.GetMethod("ShowAttribute");//获取该类下的ShowAttribute方法 //获取特性信息,返回特性的实例对象 MyAttribute customAttribute = methodInfo.GetCustomAttribute<MyAttribute>(); customAttribute.GetName();//调用方法
GetCustomAttribute<T>泛型方法用于获取某个特定的特性,返回该特性实例,还有一个GetCustomAttributes()方法用于获取所有的特性。
IEnumerable<Attribute> attributes = methodInfo.GetCustomAttributes(); foreach (Attribute attribute in attributes) { Console.WriteLine(attribute); }
反射获取的就是这个特性的实例,它的构造方法就是方法声明中的构造方法,所以我们可以在类上标记信息,通过构造传参,传入信息。但是一般我们不会这样使用,一般都是配合框架,通过继承框架中为我们写好的特性,进行定制操作。
另外,还有一些标记在特性上的特性,用于设置特性的用途,或者是否可以重复声明等等:
[AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] class MyAttribute : Attribute {...}
AttributeUsage用于设置特性的使用范围,它第一个参数需要一个枚举,也可以通过或(|)将需要的多个枚举关联起来。它的第二个可选参数是AllowMultiple,用于设置是否可以重复标记在一个结构上。它的第三个可选参数是Inherited,用于设置是否可以继承,默认为true。
这是我的公众号二维码,获取最新文章,请关注此号