自定义属性.docx

1、C#中的自定义属性在这篇指南里，我们将会看到如何自己创建属性(Attribute)，并将其用到不同的程序实体(Entity)上，在程序运行时获取属性信息。属性(Attribute)是一种新型的声明信息。我们可以使用属性来定义设计时的信息(比如帮助文件、文档的链接) ，以及运行时的信息(比如将一个类的域与一个 XML 的域相关联)。我们也可以用属性来创建“自描述”的组件(可以提供该组件的描述信息)。在这篇指南里，我们将会看到如何自己创建属性 (Attribute)，并将其用到不同的程序实体(Entity)上，并在程序运行时获取属性信息。属性的概念 MSDN(ms-help:/MS.MSDNQTR

2、.2002APR.1033/csspec/html/vclrfcsharpspec_17_2.htm)里是这样定义的：属性是一个声明的附加声明。使用预定义的属性C#已经预定义了一小组的属性供我们使用。在学习如何创建一个自定义的属性前，我们先通过一段代码来看看怎么使用这些预定义的属性吧。 using System;public class AnyClass Obsolete(“别用 Old 这个老方法了，请用 New 方法“, true)static void Old( ) static void New( ) public static void Main( ) Old( );在这个例子里我们

3、使用了 Obsolete(“陈旧的”)属性，它会将其所修饰的程序实体( 类、方法、数据成员等 )说明为已废弃不用的。第一个参数 一个字符串说明这个实体为何被废弃、由谁代替。实际上这个字符串的内容你想写什么都可以。第二个参数则告诉编译器将用户对此实体的调用视作一个编译错误。这个参数的缺省值为 false，表示编译器仅将用户对其的调用视作警告。编译上面这段代码时，我们将会得到一个编译错误(译注：注意编译错误后附的提示了 吗？) ：AnyClass.Old() is obsolete：“别用 Old 这个老方法了，请用 New 方法”开发自定义的属性现在开始开发我们自己的属性吧。这儿有一个小窍门：从

4、 C#定义的System.Attribute 类派生我们的属性类 (从抽象基类 System.Attribute 直接或间接地派生一个类，该派生类都是一个属性类。一个属性类的声明就定义了一种新的属性类型)，然后得到了这样一个声 明： using System;public class Help : Attribute不管你相不相信，我们已经创建了一个自定义的属性。我们可以像这样用它修饰任何的类：Help()public class AnyClass注意：在属性类名与后缀 Attribute 间存在一个自动的编译转换。因此当我们用一个属性去修饰一个程序实体时，不需要给出 Attribute 这个

5、后缀。编译器首先会在 System.Attribute 的所有派生类中进行匹配，如果没有找到匹配属性，它就将属性名加上 Attribute 后缀名后再进行匹配。 目前我们的这个属性还没什么用，让我们加点内容吧。在这个示例里，我们为自定义的属性类添加了一个数据属性 Description(Property)，我们将在本文的最后演示如何在运行时查询这些信息。 using System;public class Help : Attributepublic Help(String Descrition_in)this.description = Description_in;protected St

6、ring description;public String Descriptiongetreturn this.description;Help(“这是个什么也不做的类“)public class AnyClass定义/控制自定义属性的使用AttributeUsage 类是另一个预定义的属性类，以帮助我们控制自定义属性的使用。即我们可以定义自定义属性类的属性。这个类描述了如何使用自定义的属性类。AttributeUsage 有三个数据属性可用以修饰我们的自定义的属性：1、ValidOn：定义了自定义属性在哪些程序实体上可被使用。这个可使用实体的列表可通过 AttributeTargets 枚

7、举类型的 OR 操作进行设置。2、AllowMultiple：定义了是否可在同一个程序实体上同时使用多个属性进行修饰。3、Inherited：定义了自定义属性的修饰是否可由被修饰类的派生类继承。让我们做点具体的吧。我们将会用一个 AttributeUsage 属性修饰我们的属性类，以控制其作用范围：using System;AttributeUsage(AttributeTargets.Class), AllowMultiple = false, Inherited = false public class HelpAttribute : Attributepublic HelpAttribu

8、te(String Description_in)this.description = Description_in; protected String description;public String Descriptionget return this.description; 先看看 AttributeTargets.Class，说明了我们的 Help 属性只能用以修饰类，下面的这段代码将会导致一个编译错误(“属性 Help 不能用在这样的声明上，它只能用在类的声明上”)，因为我们用 Help 属性去修饰方法 AnyMethod()了： Help(“this is a do-nothi

9、ng class“)public class AnyClassHelp(“this is a do-nothing method“) /errorpublic void AnyMethod()编译错误：AnyClass.cs: Attribute Help is not valid on this declaration type. It is valid on class declarations only.当然我们可以 AttributeTargets.All 来允许 Help 属性修饰任何类型的程序实体。AttributeTargets 可能的值包括：Assembly, Module,

10、Class, Struct, Enum, Constructor, Method, Property, Field, Event, Interface, Parameter, Delegate, All = Assembly | Module | Class | Struct | Enum | Constructor | Method | Property | Field | Event | Interface | Parameter | Delegate,ClassMembers = Class | Struct | Enum | Constructor | Method | Propert

11、y | Field | Event | Delegate | Interface ) 接下来，该看看 AllowMultiple = false 这句了：它确定了不能像下面这样，在同一实体上同时使用多个同种属性进行修饰：Help(“this is a do-nothing class“)Help(“it contains a do-nothing method“)public class AnyClassHelp(“this is a do-nothing method“) /也是错误的，因为 Help 属性只能修饰类public void AnyMethod()编译错误： AnyClass.

12、cs: Duplicate Help attribute我们再来谈谈 AttributeUsage 的最后一个数据属性 Inherited：定义了自定义属性的修饰是否可由被修饰类的派生类继承。基于下示代码表示的继承关系，让我们看看会发生什么吧： Help(“BaseClass“) public class Basepublic class Derive : Base我们选择了 AttributeUsage 的四种组合：AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false Attribute

13、Usage(AttributeTargets.Class, AllowMultiple = true, Inherited = false AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true 对应上述组合的结果：如果我们查询(稍后我们会看见如何在运行时查询一个类的属性信息。) 这个Derive 类的 Help 属性时，会因其未从基类继承

14、该属性而一无所获。因为同样的原因，得到与结果不同样的结果。为了解释这后面的两种情况，我们把同样的属性也用在这个 Derive 派生类上，代码修改如下：Help(“BaseClass“) public class BaseHelp(“DeriveClass“) public class Derive : Base我们的查询会同时得到其类 Base 与派生类 Dervie 的 Help 属性信息，因为继承与多重修饰均被允许。 注意：AttributeUsage 只能用于 System.Attribute 的派生类，且该派生类的AllowMultiple 与 Inherited 都为 false。

15、定位参数与命名参数 定位参数是属性类构造子(Constructor)的参数。它们是每次使用该属性修饰某个程序实体时都必须提供值的参数。相对的，命名参数则是可选参数，它也不是属性类构造子的参数。为了详细解释它们的含义，让我们给 Help 属性类加点内容，然后看看下面的示例： AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)public class HelpAttribute : Attributepublic HelpAttribute(String Description_in)th

16、is.description = Description_in;this.verion = “No Version is defined for this class“;protected String description;public String Descriptionget return this.description;protected String version;public String Versionget return this.version;/即便我们不想我们的属性让用户设置 Version 这个数据属性，我们也不得不提供 set 方法set this.verion

17、 = value;Help(“This is Class1“)public class Class1Help(“This is Class2“, Version = “1.0“)public class Class2Help(“This is Class3“, Version = “2.0“, Description = “This is do-nothing class“)public class Class3我们查询 Class1 的 Help 属性信息时，会得到下列结果： Help.Description : This is Class1Help.Version :No Version

18、is defined for this class如果我们不定义 Version 数据属性的值，那么构造子函数体内所赋的缺省值将会使用。如果也没有，那么该数据属性对应的数据类型的缺省值将被使用(比如 int类型的缺省值为 0)。查询 Class2 将会得到这样的结果： Help.Description : This is Class2Help.Version : 1.0请不要为了可选的参数而提供多个构造子的重载版本，而应该将它们定义成命名参数。我们之所以称其为“命名的”，是我们为了能在构造子里给它们赋值，不得不用一个个的标识符定义和访问它们。比如在第二个类中 Help 属性的使用Help(“T

19、his is Class2“, Version = “1.0“) 你瞧，AttributeUsage 的 ValidOn 参数就是一个定位参数，而 Inherited 与 AllowMultiple 则是命名参数。 注意：在属性类的构造子中给命名参数赋值，我们必须为它提供一个相应的 set 方法，否则会导致这样的编译错误(Version 不能是一个只读的数据属 性)： Version : Named attribute argument cant be a read only property当我们查询 Class3 的 Help 属性信息时会发生什么呢？会这样因上述的原因导致编译错误(Des

20、cription 不能是只读的数据属性)： Desciption : Named attribute argument cant be a read only property所以还是给 Description 添加一个 set 方法吧。这样会得到正确的输出结果： This is do-nothing class Help.Version : 2.0这是因为构造子利用定位参数构造一个属性时，它会调用所有命名参数的 set 方法。构造子里的赋值行为实际均由各命名参数对应的数据属性的 set 方法完成，被其覆写(Override)了。 参数类型一个属性类的参数可使用的数据类型限于： bool by

21、te char double float int long short string System.Type object 枚举类型以及上述数据类型的一维数组 属性标识 让我们想象一下，怎么才能把我们的 Help 属性用到一个完整的程序集(assembly)上？首先要面对的问题是该把 Help 属性放在哪儿，以便让编译器识别出它是属于一个程序集的？再考虑另一种情况：我们想把一个属性用在某个方法的返回类型上时，编译器如何才能确定我们把它用在了返回类型而不是这个方法本身之上？要解决这么多含糊的问题，我们需要属性标识。借助属性标识的帮助，我们可以明确地告诉程序集我们希望把属性放在哪儿。比如： ass

22、embly: Help(“this a do-nothing assembly“)这个 Help 属性前的 assembly 标识符显式地告诉了编译器，当前这个 Help 属性用于整个程序集。可用的标识符包括： assembly module type method property event field param return 在运行时查询属性 我们已经知道了如何创建属性并如何在程序中使用它们。现在该学习我们所建属性类的用户如何才能在运行时查询该属性类的信息了。要查询一个程序实体的所有属性信息，我们得使用反射(reflection)在运行时发现类型信息的一种功能。 我们可以直接使用.NE

23、T Framework 提供的反射 Reflection API 来枚举一个完整程序集的所有元数据(metadata)，并产生该程序集所有类、类型、方法的列表。还记得之前的 Help 属性和 AnyClass 类吗？ using System;using System.Reflection;using System.Diagnostics;/attaching Help attribute to entire assemblyassembly : Help(“This Assembly demonstrates custom attributes creation and their run-

24、time query.“)/our custom attribute classpublic class HelpAttribute : Attributepublic HelpAttribute(String Description_in)this.description = Description_in;protected String description;public String Descriptionget return this.deescription; /attaching Help attribute to our AnyClassHelpString(“This is

25、a do-nothing Class.“)public class AnyClass/attaching Help attribute to our AnyMethodHelp(“This is a do-nothing Method.“)public void AnyMethod()/attaching Help attribute to our AnyInt FieldHelp(“This is any Integer.“)public int AnyInt;class QueryApppublic static void Main()我们将在接下来的两节里在我们的 Main 方法里加入属

26、性查询的代码。 查询程序集的属性 在接下来的代码片段里，我们获取当前进程的名字，并使用 Assembly 类的LoadFrom 方法装载程序集。然后我们使用 GetCustomAttributes 方法获取当前程序集的所有自定义属性。接下来的 foreach 语句又遍历所有的属性对象，并试着将这些属性转化为 Help 属性(使用 as 关键字进行转换，如果转换失败，将会返回一个空值而不是触发一个异常)。再后的一条语句是指如果转换成功，则显示Help 属性的所有数据属性信息。 class QueryApppublic static void Main()HelpAttribute HelpAtt

27、r;/Querying Assembly AttributesString assemblyName;Process p = Process.GetCurrentProcess();assemblyName = p.ProcessName + “.exe“;Assembly a = Assembly.LoadFrom(assemblyName);foreach (Attribute attr in a.GetCustomAttributes(true)HelpAttr = attr as HelpAttribute;if (null != HelpAttr)Console.WriteLine(

28、“Description of 0:/n1“, assemblyName,HelpAttr.Description);程序的输出结果： Description of QueryAttribute.exe:This Assembly demonstrates custom attributes creation and their run-time query.Press any key to continue查询类、方法和域的属性在下面的代码片段里，和上面的代码不同的只是 Main 方法的第一条语句变成了： Type type = typeof(AnyClass);它使用 typeof 操作符

29、返回 AnyClass 对应的 Type 对象。其余的代码也类似上述的代码，我想不需要再做解释了吧。要查询方法和域的属性，我们首先要获得当前类中所有方法和类，然后再用类似于查询类的属性的方法来查询与之对应的属性。 class QueryApppublic static void Main()Type type = typeof(AnyClass);HelpAttribute HelpAttr;/Querying Class Attributesforeach (Attribute attr in type.GetCustomAttributes(true)HelpAttr = attr as

30、HelpAttribute;if (null != HelpAttr)Console.WriteLine(“Description of AnyClass:/n0“, HelpAttr.Description);/Querying Class-Method Attributes foreach(MethodInfo method in type.GetMethods()foreach (Attribute attr in method.GetCustomAttributes(true)HelpAttr = attr as HelpAttribute;if (null != HelpAttr)C

31、onsole.WriteLine(“Description of 0:/n1“, method.Name, HelpAttr.Description);/Querying Class-Field (only public) Attributesforeach(FieldInfo field in type.GetFields()foreach (Attribute attr in field.GetCustomAttributes(true)HelpAttr= attr as HelpAttribute;if (null != HelpAttr)Console.WriteLine(“Description of 0:/n1“,field.Name,HelpAttr.Description);下面是程序输出： Description of AnyClass:This is a do-nothing Class.Description of AnyMethod:This is a do-nothing Method.Description of AnyInt:This is any Integer.Press any key to continue