享受代码,享受人生

SOA is an integration solution. SOA is message oriented first.
The Key character of SOA is loosely coupled. SOA is enriched
by creating composite apps.
  博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

C#与NET实战 第七章 反射、后期绑定与attribute 节选

Posted on 2007-08-25 11:18  idior  阅读(6185)  评论(5编辑  收藏

我们在2.2.2节曾讨论过元数据(metadata)以及它在程序集中的物理存储方式。本章将会看到它们是如何构成反射与attribute机制的基础的。

7.1 反射

反射机制代表了在执行期一个程序集的类型元数据的使用。通常情况下,该程序集是在另一个程序集执行的时候被显式载入的,不过它也可以被动态生成。

反射这个词用于表明我们使用了一个程序集的映像(就像镜子中的映像)。该映像由程序集的类型元数据构成。我们有时候也会使用内省(introspection)这个术语来表示反射。

7.1.1 何时需要反射

我们收集了一些反射机制的使用分类,在本章接下来的小节中将对它们展开更详细的讨论。反射机制可以在下述场景中用到。

  • 在应用程序执行时,我们可以使用类型元数据的动态分析来探索程序集中的类型。例如,ildasm. exe与Reflector工具会显式地装载一个程序集中的模块并分析它们的内容(参见2.3节)。
  • 使用后期绑定的期间。该技术需要使用程序集中的一个类,而该类在编译期是未知的。后期绑定技术通常用于解释型语言,如脚本语言。
  • 当我们希望使用attribute中的信息的时候。
  • 当我们希望从类外部访问类中的非公开成员的时候。当然,这种行为应该尽量避免,不过有时候还是有必要使用的。例如,在编写没有非公开成员就无法完成的单元测试的时候。
  • 在动态构造程序集的期间。为了使用一个动态构造的程序集中的类,我们必须显式地使用后期绑定技术。

CLR与Framework在某些情况下会使用反射机制。例如,在值类型的Equals()方法的默认实现中,使用反射逐一比较两个实例中的字段。

CLR在序列化对象期间也使用反射,以确定哪个字段需要被序列化。甚至垃圾收集器也会在回收过程中使用它来构造引用树。

7.1.2 .NET反射有何新意

反射机制的底层原理并不是什么新概念。很早以前我们就能够动态地分析一个可执行程序了,尤其是通过使用自描述信息。TLB格式(参见8.4节)就是为了这个目的构想出来的。而TLB格式中的数据正是来自于IDL(Interface Definition Language,接口定义语言)格式。IDL语言也可以被视为一种自描述语言。.NET中的反射机制则比TLB与IDL格式更进了一步。

  • 在某些基类的帮助下,它更易于使用。
  • 它比TLB与IDL语言更抽象。例如,它不使用物理地址,这意味着它在32位与64位机器上都能发挥作用。
  • 相比TBL元数据,.NET元数据总是包含在它所描述的模块中。
  • 它描述数据的详细程度远胜于TLB格式。具体来说,我们能够获得一个程序集中声明的任何类型的所有可能信息(例如:类中方法的某个参数的类型)。

.NET反射之所以能描述如此详细的内容,归功于.NET Framework 中众多的基类,通过它们可以从一个包含在AppDomian中的程序集中抽取出各种类型元数据(type metadata)并使用它们。这些类大多可以在System.Reflection命名空间中找到,而且程序集中每个类型的元素都有一个类与之对应。

  • 有一个类的实例代表了程序集(System.Reflection.Assembly);
  • 有一个类的实例代表了类与结构(System.Type);
  • 有一个类的实例代表了方法(System.Reflection.MethodInfo);
  • 有一个类的实例代表了字段(System.Reflection.FieldInfo);
  • 有一个类的实例代表了方法参数(System.Reflection.ParameterInfo)。

……

最后要提醒大家,这些类仅仅提供了一种从逻辑上查看全体类型元数据的方法。但是我们看到的内容与物理的全体类型元数据并不会完全吻合,其中某些用于程序集内部组织的元素并没有被展现出来。

System.Reflection命名空间下的所有类以一种逻辑方式相互联系。例如,从一个System. Reflection.Assembly的实例中,可以获得一个System.Type实例的列表。从一个System.Type的实例中,可以获得一个System.Reflection.MethodInfo实例表。而从一个System.Reflection.Method- Info实例中,又可以获得一个System.Reflection.ParameterInfo实例表。所有这些如图7-1所示。

图7-1 反射类之间的交互

你可能会发现我们无法深入到IL指令层面,而只能到达字节表的层面,在字节表中包含一个方法的IL体。因此,为了查看IL指令,你可能想使用某些库,比如Cecil(由Jean-Baptiste Evain开发)、ILReader (由Lutz Roeder开发)或Rail(由Coimbra大学开发)。应该了解,在.NET 2下,反射知道如何处理泛型类型、泛型方法以及对参数类型的约束(参见13.10.2节)。

7.1.3 对载入AppDomain的程序集的反射

下面的例子展现了如何使用System.Reflection命名空间下的类分析类型元数据。事实上,这里我们展现了一个分析它自身的类型元数据的程序集。为了获得一个代表该程序集的Assembly类的实例,我们使用了静态方法Assembly.GetExecutingAssembly()。

例7-1

程序输出如下:

7.1.4 从元数据获取信息

本节的目的在于展示一个小程序,该程序使用反射机制显示了包含在System与mscorlib程序集中的异常类集合。我们是建立在所有异常类都继承自System.Exception这一事实的基础上的。不是直接继承自System.Exception的异常类型会用一个星号标记。

我们可以依据所有attribute类都继承自System.Attribute类这一事实,很容易地修改该程序来显示框架中所有的attribute类。

例7-2

注意前一个例子中使用的Assembly.ReflectionOnlyLoad()方法。通过该方法可以告诉CLR,载入的程序集将仅用于反射。因此,CLR将不允许以这种方法载入的程序集的代码执行。同样,以Reflection Only模式装载程序集会稍微快些,因为CLR不需要完成任何安全验证工作。Assembly类提供bool ReflectionOnly{get;}属性用于判断一个程序集是否是通过该方法载入的。

7.2 后期绑定

在开始本节之前,建议对面向对象编程的基本内容有着很好的理解,尤其是有关多态的概念。该主题请参见第12章。

7.2.1 “绑定一个类”的含义

首先,我们需要在“绑定一个类”的含义上达成共识。我们将使用“软件层”这个术语而不是“程序集”,因为后者在其他技术中也被用到。

在使用类(实例化类并使用类的实例)的软件层与定义类的软件层之间会建立起一个类的联系。具体来说,这个联系是使用类的软件层中对类中方法的调用与这些方法在定义类的软件层中的物理地址之间的对应关系。正是通过这个联系,当类方法被调用时线程才能继续执行下去。

一般来说,我们将一个类的联系分为三类:完全在编译期创建的早期绑定,在编译期创建了部分联系的动态绑定以及在执行期创建的后期绑定。

7.2.2 早期绑定与动态绑定

早期绑定联系由编译器在根据.NET源代码创建程序集的期间创建。我们无法为一个虚方法或抽象方法创建一个早期绑定。事实上,当一个虚方法或抽象方法被调用时,多态机制会在执行期间根据被调用方法的实际对象确定将要执行的代码。这种情况下,该联系被视为动态绑定。在其他资料中,动态绑定有时被称为隐式的后期绑定,因为它们是由多态机制隐式创建的并且是在执行期完成的。

现在让我们进一步观察早期绑定,它们是为静态方法或类中那些不是虚方法或抽象方法的方法创建的。如果严格遵循前一节中对“类的联系”的定义,.NET中是不存在早期绑定的。事实上,我们必须先等待JIT编译器将方法体转换为机器语言,才能知道它在进程地址空间中的物理地址。创建程序集的编译器并不知道这个方法的地址信息[1]。我们在4.6节看到,为了解决这个问题,创建程序集的编译器在IL代码中方法将被调用的位置插入了与被调用的方法相对应的元数据符号(metadata token) 。当方法体被即时(JIT)编译的时候,CLR在内部保存了方法与机器语言下的方法体的物理地址的对应联系。这段被称为存根的信息被物理保存到一个与方法相关的内存地址中。

以上的认识很重要,因为在像C++这样的语言中,当一个方法不是虚方法或抽象方法(即C++中的纯虚函数)时,编译器就可以计算出该方法体在机器语言下的物理地址。然后,编译器在每个调用该方法的位置插入一个指向该内存地址的指针。这个区别给了.NET很大的优势,因为编译器不需要再考虑诸如内存表现之类的技术细节。IL代码完全独立于它所运行的物理层。

而在动态绑定中,其中几乎所有的事物都是以与早期绑定中相同的方式工作的。编译器在IL代码中方法被调用的位置插入了与被调用的虚(或抽象)方法相对应的元数据符号。这里,我们提到的元数据符号是属于定义在引用类型中的方法的,而该引用类型就是将发生方法调用的那个类型。然后就是CLR的工作,它将在执行期间根据引用对象的具体实现确定跳转到哪个方法。

插入一个类型元数据符号,编译器使用这项技术创建动态绑定与早期绑定,它主要用于以下三种情况。

  • 当包含在模块中的代码调用了一个处在同一模块中的方法时。
  • 当包含在模块中的代码调用了一个处在同一程序集的不同模块中的方法时。
  • 当包含在程序集的一个模块中的代码调用了定义在另一个在编译期引用进来的程序集中的方法时。在运行时,如果即时编译方法调用的时候该程序集尚未载入,那么CLR将隐式地装载它。

7.2.3 后期绑定

程序集A的代码可以实例化并使用一个定义在程序集B中的类型,而该类型可能在A编译的时候并没有被引用。我们把这种类型的联系描述为后期绑定。我们之所以在句中使用“后期”这个词是因为绑定是在代码执行期完成的而非编译期。这种类型的绑定同样是显式的,因为被调用的方法的名称必须使用一个字符串显式地指定。

后期绑定在微软的开发世界中并不是什么新的概念。COM技术中的自动化机制就是一个例子,它使用IDispatch接口作为变通方法,允许脚本语言或者弱类型的语言如VB使用后期绑定。后期绑定的概念同样存在于Java中。

后期绑定是习惯于C++的开发者很难理解的概念之一。事实上,在C++中只存在早期与动态绑定。难于理解的原因来自以下事实:我们知道创建一个绑定所需的必要信息(即元数据符号)处在将被调用的类所在的程序集B之中,但是我们不能理解为什么开发者不能利用编译器的能力,在编译A的期间,通过引用程序集B创建早期与动态绑定。对此,存在以下解释:

  • 最常见的原因在于某些语言根本就没有编译器!在一个脚本语言中,指令是被一条一条解释的。在这种情况下,只存在后期绑定。通过使用后期绑定,可以使用由解释型语言编译的程序集中的类。在.NET中可以方便地使用后期绑定技术这一事实,使得创建一个专有的解释/动态语言变得相对容易(比如IronPython语言http://www.ironpython.com/)。
  • 我们可能希望在由编译型语言如C#写成的程序中使用后期绑定技术。原因在于,使用后期绑定可以为应用程序的通用架构带来某种程度的灵活性。该技术实际上是一种最近很流行的被称为插件的设计模式,我们将在本章对它做进一步介绍。
  • 某些应用程序需要调用尚未获得的程序集中的代码。一个典型的例子就是开源工具NUnit,该工具可以通过调用任意一个程序集的方法来测试其代码。我们将在稍后构造一个自定义attribute的时候,再进一步接触这个话题。
  • 如果在程序集A编译期间程序集B尚不存在,我们就必须在A中的代码与B中的类之间使用后期绑定。这种情况我们将在稍后谈到动态构造程序集的时候介绍。

一些人喜欢使用后期绑定来代替多态。事实上,因为在调用期间,只考虑方法的名称与签名式,而与被调用方法所处对象的类型无关,所以只需要在实现对象的时候提供具有合适名称和签名式的方法即可。但是,我个人不推荐这种做法,因为它的约束性太差,并且无法促使应用程序的开发者去做恰当的设计以及使用抽象接口。

除了刚提到的原因外,还有就是不需要显式地使用后期绑定。不要为了好玩而在应用程序中使用后期绑定,因为:

  • 会失去由编译器完成的语法验证的好处。
  • 后期绑定的性能远不如早期或动态绑定方法。(即使使用了后面提到的优化方法。)
  • 无法为被混淆的类创建后期绑定。事实上,在混淆过程中,程序集中包含的类的名称会被改变。因此,后期绑定机制无法正确地找到合适的类。
7.2.4 在C#编译到IL期间如何实例化一个未知的类

如果一个类或结构在编译期是未知的,那么就无法使用new操作符对它实例化。幸运的是,.NET Framework确实提供了一些类,使用这些类可以创建那些在编译期间未知的类的实例。

1. 精确化一个类型

现在让我们看一下,在指定一个类型时,可以采取的各种不同的技术。

  • 某些类的某些方法接受一个包含类型完整名称(包括命名空间)的字符串。
  • 其他方法接受一个System.Type类的实例。在一个AppDomain中,每个System.Type类的实例代表一种类型,而且不会有两个实例同时代表该类型。
    获得一个System.Type类的实例的几种方式:
  • 在C#中,我们通常使用typeof()关键字,它接受一个类型作为参数并返回相应的System.Type实例。
  • 也可以使用System.Type类中GetType()静态方法的一个重载版本。
  • 如果一个类型被封装在另一个类中,可以使用System.Type类的非静态方法GetNestedType() 或GetNestedTypes()。还可以使用System.Reflection.Assembly类的非静态方法GetType()、 GetTypes()或GetExportedTypes()。
  • 也可以使用System.Relection.Module类的非静态方法GetType()、GetTypes()或FindTypes()。

现在假设以下程序被编译为Foo.dll程序集。我们将要展示几种创建一个NMFoo.Calc类的实例的方法,这些方法允许在一个没有引用Foo.dll的程序集中完成创建。

例7-3 Foo.dll程序集的代码

2. 使用System.Activator

System.Activator类提供了两个静态方法CreateInstance()与CreateInstanceFrom(),通过它们可以创建一个在编译期间未知的类的实例。例如:

例7-4

这两个方法中都提供了一些重载版本,甚至还有泛型版本,其中使用了以下参数。

  • 用于代表一个字符串的类或System.Type的一个实例;
  • 包含类的程序集的名称,该参数是可选的;
  • 构造参数列表,该参数是可选的。

如果包含类的程序集并未出现在AppDomain中,调用CreateInstance()或CreateInstanceFrom()方法会导致该程序集被载入。取决于我们调用的是CreateInstance()方法还是CreateInstanceFrom()方法,在内部会调用System.AppDomain.Load()或System.AppDomain.LoadFrom()方法来载入程序集。CLR会根据提供的参数选择类的一个构造函数,并返回一个包含了一个封送对象的ObjectHandle类的实例。在介绍.NET remoting的第22章中,我们会在分布式应用的环境下展示这些方法的另一种用法。

使用System.Type类的一个实例来指定类型的CreateInstance()重载版本会直接返回对象的一个实例。

System.Activator还有一个CreateComInstanceFrom()方法,该方法用于创建一个COM对象的实例,以及一个用于创建远程对象的GetObject()方法。

3. 使用System.AppDomain类

System.AppDomain类拥有CreateInstance()、CreateInstanceAndUnWrap()、CreateInstance- From()与CreateInstanceFromAndUnwrap()这四个非静态方法,通过它们可以创建一个在编译期间未知的类的实例,例如:

例7-5

这些方法与之前谈到的System.Activator中的方法类似。不过,通过它们可以选择将对象创建在哪个AppDomain中。此外,“AndUnwarp()”版本会返回一个对对象的直接引用,该引用是从一个ObjectHandle类的实例中获得的。

4. 使用System.Reflection.ConstructorInfo

System.Reflection.ConstructorInfo类的实例引用一个构造函数。该类的Invoke()方法在内部为构造函数创建了一个后期绑定,并通过这个绑定调用构造函数。因此,通过它们可以创建一个该构造函数所属类型的实例。例如:

例7-6

5. 使用System.Type

通过System.Type类的非静态方法InvokeMember()可以创建一个在编译期间未知的类的实例,只需要在调用的时候使用BindingFlags枚举量中的CreateInstance值即可。例如:

例7-7

6. 特殊情况

通过以上介绍的方法,几乎可以创建任何一种类或结构的实例。下面是两种特殊情况。

  • 为了创建一个数组,必须调用System.Array类中的静态方法CreateInstance()。
  • 为了创建一个委托对象,必须调用System.Delegate类中的CreateDelegate()方法。
7.2.5 使用后期绑定

现在我们知道如何创建在编译期间未知的类的实例,为了使用这些实例,让我们来看一下这些类型的成员之间的后期绑定的创建过程。同样有几种方法可以实现。

1. Type.InvokeMember()方法

让我们回到Type.InvokeMember()方法,之前我们使用它通过调用未知的类型的一个构造函数创建了一个在编译期间该未知的类型的实例。在内部实现中,该方法完成下面3个任务。

  • 它在它被调用的类型上寻找与所提供的信息相对应的成员。
  • 如果该成员被找到,为它创建一个后期绑定。
  • 使用该成员(是方法就调用,是构造函数就创建一个对象的实例,是字段就读取或设值,是属性就执行set或get访问器,等等)。

下面的例子展示了如何调用NMFoo.Calc类的实例上的Sum()方法(注意在调试期间,调试器能够进入使用后期绑定的方法体中)。

例7-8

Type.InvokeMember()方法最常用的重载版本是:

invokeAttr参数是一个二进制标志位,它指示了搜索何种类型的成员。为了搜索方法,我们使用BindingFlags.InvokeMethod标志位。各种标志位的介绍请参见MSDN上名为“BindingFlags Enumeration”的文章。

binder参数是一个Binder类型的对象,它会指示InvokeMember()方法如何搜索。大多数情况下,该参数可以设为null以表示希望使用默认值,也就是System.Type.DefaultBinder。Binder类型的对象提供了以下类型的信息:

  • 它指示了参数会接受何种类型的转换。在上一个例子中,我们可以提供两个double类型的参数。由于DefaultBinder支持从double到int的转换,所以仍然能够成功地调用方法。
  • 它指示了我们是否在参数列表中使用了可选参数。

所有这些(尤其是类型转换表)在MSDN上一篇名为Type.DefaultBinder Property的文章中有更详细的介绍。我们还可以通过继承Binder类,创建自己的binder对象。不过在大多数情况下使用一个DefaultBinder的实例就足够了。

如果在后期绑定成员的调用时引发了异常,InvokeMember()会截获异常并重新抛出一个System.Reflection.TargetInvocation Exception类型的异常。自然地,在方法中引发的异常会被重新抛出的异常中的InnerException属性所引用。

最后注意,在创建一个后期绑定时,无法访问非公有成员。否则,通常会抛出System.Security. SecurityException异常。不过,如果System.Security.Permissions. ReflectionPermissionFlags的TypeInformation标志位(可以通过System.Security.Permissions. ReflectionPermission类的实例访问)被设为真,就可以访问非公有成员。如果MemberAccess标志位被设为真,就可以访问非可见类型(即以非公有方式封装在其他类型中)[2]

2. 一次绑定,多次调用

我们看到,通过一个ConstructorInfo实例可以创建一个后期绑定以调用一个构造函数,以同样的方式,通过一个System.Reflection.MethodInfo类的实例也可以创建一个后期绑定并调用任意一个的方法。使用MethodInfo类而不是Type.InvokeMember()方法的优势在于可以节省每次调用时搜索成员的时间,因此会带来一些性能上的优化。如下例所示。

例7-9

3.VB.NET如何背着你创建后期绑定

让我们为VB.NET做一些旁注,并观察一下当Strict选项被设为Off之后,该语言如何背着你秘密地使用后期绑定。例如,下面的VB.NET程序……

例7-10 VB.NET与后期绑定

……等同于下面的C#程序:

例7-11

7.2.6 利用接口:使用后期绑定的正确方法

为了使用一个在编译期间未知的类,除了我们介绍过的通过使用后期绑定的方法外,还有另一个完全不同的方法。该方法具有较大优势,因为与使用早期或动态绑定相比,它在性能上几乎没有损失。不过,为了使用该“秘诀”,你必须迫使自己遵循某种规范(实际上就是名为插件的设计模式)。

我们的想法是确保在编译时未知的类型实现了一个接口,而该接口是编译器所知的。为此,我们不得不创建第三个程序集,用于承载该接口。让我们用三个程序集重写Calc的例子:

例7-12 包含接口的程序集的代码(InterfaceAsm.cs)

例7-13 包含目标类的程序集的代码(ClassAsm.cs)

例7-14 在编译期目标类未知的客户程序集的代码(ProgramAsm.cs)

注意,通过显式地将CreateInstanceAndUnwrap()方法返回的对象强制转换为ICalc类型,就可以通过动态链接方式调用Sum()方法。我们还可以使用Activator.CreateInstance<ICalc>()这个泛型重载版本来避免类型转化。

图7-2对3个程序集的组织结构以及它们之间的联系做了总结。

 

图7-2 插件设计模式与程序集组织结构

根据插件设计模式背后的思想,那些在CreateInstanceAndUnwrap()方法中用于创建实例所必需的数据(这里是"Foo.dll"与"NMFoo.CalcWithInterface"两个字符串)通常保存配置文件中。这样,就可以通过修改配置文件来选择新的实现而无需重新编译。

插件设计模式的一个变种就是使用抽象类代替接口。

最后,应该知道还可以使用委托来创建一个方法的后期绑定。尽管该方法比使用MethodInfo更加高效,但是一般来说我们更喜欢使用插件设计模式。

7.3 attribute

7.3.1 attribute是什么

一个attribute是一份标记代码中的元素的信息,这个元素可以是一个类或一个方法。例如,.NET Framework 提供了System.ObsoleteAttribute,该attribute可用于标记一个方法,如下所示(注意使用[]括号的语法):

Fct()方法被标记上了System.ObsoleteAttribute信息,该信息会在编译期间被插入到程序集中,以后可以被C#编译器使用。当调用该方法时,编译器会发出警告,提示最好避免调用废弃方法,因为此类方法可能在将来的版本中消失。如果没有attribute,就不得不通过合适的文档表述出Fct()方法现在处于废弃状态这一事实;而且这种做法的缺点在于,无法保证客户会阅读文档从而知道该方法现在是废弃的。

7.3.2 何时需要attribute

使用attribute的优势在于它所包含的信息会被插入到程序集中,而这些信息可以在不同的时间用于各种不同目的:

  • attribute可以为编译器所用,刚介绍过的System.ObsoleteAttribute就是一个很好的例子。某些专门针对编译器的标准attribute不会保存到程序集中。例如,SerializationAttribute并不会直接为一个类型加上特定的标记,而只是告诉编译器该类型可以被序列化。因此,编译器在将被CLR在执行期间使用的具体类型上设置某些标志。像SerializationAttribute这样的attribute,也被称为伪attribute。
  • attribute可以在CLR执行期间使用。例如,.NET Framework提供了System.ThreadStatic- Attribute,当一个静态字段被标记上该attribute时,CLR将确保在执行期间每个线程中只有该字段的一个版本。
  • attribute可以在调试器执行期间使用。因此,通过System.Diagnostics.DebuggerDisplay- Attribute可以在调试期间定制代码中某个元素的显示内容(例如某个对象的状态)。
  • attribute可以被一个工具使用。例如,.NET Framework提供了System.Runtime.Interop- Services.ComVisibleAttribute,当一个类被标记上该attribute,tlbexp.exe 工具会为该类产生一个文件,使得该类可以被当作一个COM对象使用。
  • attribute可以在用户代码执行期间使用,此时需要使用反射机制去访问attribute信息。例如,使用attribute验证类中字段的值就是一件很有趣的事。一个字段必须处于某个范围内,一个引用字段必须非空,一个字符串字段最多包含100个字符,……由于存在反射机制,使得编写代码以验证任何一个被标记字段的状态变得很容易。稍后,我们将展示一个在代码中使用attribute的例子。
  • attribute可以在用户通过诸如ildasm.exe或Reflector这样的工具分析程序集的时候使用。因此,可以想象一个attribute将会为代码中的一个元素赋予一个说明其特性的字符串。由于该字符串被包含在程序集中,所以我们就可以直接查阅这些注释而无需访问源代码。
7.3.3 关于attribute应该知道的事
  • 一个attribute必须由一个继承于System.Attribute的类定义。
  • attribute类的一个实例只有在被反射机制访问时才会被实例化。根据它的使用情况,一个attribute类不一定会被实例化(像System.ObsoleteAttribute那样的attribute就不需要被反射机制使用)。
  • .NET Framework 内置了一些attribute以供使用。某些attribute是专门为CLR提供的,其他的则被编译器或微软提供的工具所使用。
  • 可以创建自己的attribute类,不过它们只能被你的程序使用,因为你无法修改编译器或CLR。
  • 习惯上,一个attribute类的名称会以Attribute为后缀。不过,在C#中,一个名为XXXAttribute的attribute,在标记代码中元素的时候既可以使用XXXAttribute表示也可以简单地用XXX表示。

在专门介绍泛型的那一章中,我们在13.10.3节中讨论了attribute概念与泛型概念之间相互交叠的规则。

7.3.4 可以应用attribute的代码元素

attribute将被应用于源代码中的各种元素。下面是可以使用attribute标记的所有元素。它们是由AttributeTargets枚举量的值定义的。

 

7.3.5 .NET Framework中的一些标准attribute

要想很好地理解一个attribute,首先要很好地了解它的应用场景。因此,每个标准attribute将在专门提到它们的章节中介绍。

一些与安全管理相关的attribute参见6.6节。

一些与P/Invoke机制相关的attribute参见8.1节。

一些与在.NET应用程序中使用COM相关的attribute参见原书8.4.3节。

一些与序列化机制相关的attribute参见22.3节。

一些与XML序列化相关的attribute参见原书21.9.2节。

允许实现一个同步机制的System.Runtime.Remoting.Contexts.SynchronizationAttribute参见5.9节。

允许提示编译器对某些方法进行有条件编译的ConditionalAttribute参见9.3.2节。

用于针对静态字段修改线程行为的ThreadStaticAttribute参见原书5.13.1节。

用于提示编译器是否必须做某些验证的CLSCompliantAttribute参见4.9.2节。

用于实现params C#关键字的ParamArrayAttribute参见4.9.2节。

CategoryAttribute参见18.5节。

7.3.6 自定义的attribute的示例

一个自定义的attribute就是你通过定义一个继承于System.Attribute的类而为自己创建的attribute。和我们在本节一开始谈到的字段验证attribute类似,可以想象,在很多情况下我们都可以从使用自定义的attribute中受益。我们将要展示的例子来自于NUnit开源工具的启发。

通过NUnit工具可以执行任何程序集中的任何方法从而测试它们。由于没有必要测试一个程序集中的每一个方法,NUnit仅执行那些被标记了TestAttribute的方法。

为了实现该特性的一个简化版,我们将做出以下约束。

  • 如果没有抛出任何未捕获的异常则认为该方法通过测试。
  • 我们定义了一个只能应用于方法的TestAttribute。该attribute可以配置方法必须被执行的次数(通过int类型的TestAttribute.nTime属性)。该attribute还可以用于忽略一个被标记的方法(通过bool类型的TestAttribute.Ignore属性)。
  • Program.TestAssembly(Assembly)方法允许执行包含在程序集中所有被标记了TestAttribute的方法,而程序集是作为参数传入方法的。出于简单化的考虑,我们假设这些方法都是公有的、非静态的而且不接受任何参数。我们还必须使用后期绑定来访问这些被标记的方法。

下面的程序满足了这些约束。

例7-15

该程序输出:

让我们做一些注解。

  • 我们为TestAttribute类标记了一个AttributeUsage类型的attribute。我们使用AttributeTarget枚举量的Method值告诉编译器TestAttribute只能被应用在方法上。
  • 我们将AttributeUsage类的AllowMultiple属性设为false以表示一个方法不会接受多个TestAttribute类型的attribute。注意用于初始化AllowMultiple属性的特殊语法,我们把AllowMultiple称为有名参数。
  • 在为Foo.CrashButIgnore()方法标记TestAttribute的时候,我们也使用了有名参数这一语法。
  • 当一个异常被引发并且没有在某个方法执行期间被捕获,但由于该方法是通过后期绑定调用的,所以此时调用该方法的方法会产生一个TargetInvocationException类型的异常将原始异常覆盖,而原始异常则被覆盖它的异常的InnerException属性所引用。
  • 为了避免将代码分散到多个程序集中,该程序将进行自我测试(事实上,只有Foo类中的方法被测试,因为只有它们被标记了TestAttribute)。图7-3是将代码分散后将会出现的程序集组织结构。

图7-3 程序集组织结构

图7-3与图7-2相似不是偶然的。在两种情况中,都是通过一个在编译期间两者都知道的中介(本例中是一个attribute,而前一个例子中是一个接口)来使用一个在编译期未知的元素。

7.3.7 条件attribute

C#2引入了条件attribute的概念。一个条件attribute只有在一个符号被定义后才会被编译器考虑到。下面的例子展示了在一个由3个文件生成的项目中使用条件attribute。

例7-16

例7-17

例7-18

在上一节的示例中,条件attribute被用于从同一段代码产生debug与release版本。在9.2.2节,我们介绍了条件attribute的另一个用处。


[1] 因为在程序运行时才发生JIT编译。——译者注

[2] 这段内容似乎有误,TypeInformation标志位表示是否可以绑定非可见成员,而MemberAccess标志位表示是否可以调用非可见成员,有待进一步查证。——译者注