摘要:

.NET的自定义属性可以实现程序集元数据扩展,并能为框架设计和实现提供新的思路和解决办法。NUnit即是一个很好的例子。


1.属性概述

.NET的元数据体系是.NET Framework的亮点之一。利用元数据可以对程序集、模块、类型、方法、成员等进行某种特性描述,而这些描述将作为元数据被编译到程序集中,并通过.NET运行环境为其调用者所使用。这也即元数据扩展。

属性(Attribute)的定义和使用是元数据扩展的主要内容。这包括对.NET标准属性的使用和自定义属性。

注:“属性”是汉化MSDN对本文所讨论的概念—Attribute的翻译,我也习惯这么说。这好像很容易和OO中的“属性”混淆。有些同类讨论中,将此翻译为“标签”、“标记”,请注意区分。

也许开发者对属性还感觉比较陌生,对其如何发挥作用也没有什么感性认识。但其实在日常的开发中,.NET开发者来已经在大量使用.NET的标准属性。如:

当要引用某个传统动态连接库中的函数时,我们常用到DllImportAttribute标准属性来注释某个函数的原型:

[DllImport(“user32.dll”)]

public static extern int MessageBoxA(int p, string m, string h, int t);

//…

又 比如,在编写Web Service时会使用到WebServiceAttribute和WebMethodAttribute属性。[WebService]和 [WebMethod]会在生成WSDL时发挥作用,为我们生成相应的Web Service描述,下面的代码片段开发者是多么的熟悉:

[WebMethod]

public string HelloWorld()

//…

这些属性直接对程序集中的类型或类型成员进行注释,并且这样的注释可以影响相应程序集的编译、逻辑、运行等。.NET Framework带有很多标准的属性,并在MSDN中有详细的文档。


2.自定义属性

属性也可以自定义,即自行开发属性,对属性进行某种格式的定义,并利用属性来影响开发者自己开发的程序集。这也是.NET元数据扩展最直接的应用了。自定义的属性在编译时作为元数据被编译到程序集中,在运行时可以利用反射机制(Reflection)被读取。

.NET中的属性是以一个类的形式来定义的。几乎所有的属性都继承自System.Attribute,开发者自定义属性也需首先继承自该抽象类。


自定义属性可以用于对程序集中的元素进行标记和描述,并被编译到.NET程序集中,成为其元数据的一部分。而从属性和属性值的读取就是对.NET程序集元数据的读取,这会用到反射机制。具体如何编写自定义属性和如何读取属性的例子在MSDN中有很多,不再冗述了。


3.属性的应用

属 性的以上的特性往往在设计一些框架时很有用:利用反射机制,作为属性的元数据可以反过来在运行期影响代码的运行配置项,或者为特殊的操作方法作以属性作标 记,以便在运行时做特殊处理。属性的另一个很有诱惑力的应用是,可以用于构建管理项目程序集的工具:属性表现为某种注释,而注释内容可以在编译后从程序集 中读取出来,从而可以通过属性内容的注释和读取来实现对程序集中各类型、方法的管理了。天ol

3.1 NUnit中的属性应用

先看看属性在框架设计中的应用吧!最典型的例子就是NUnit。在NUnit的框架设计中将自定义属性的特性、以及.NET的反射机制发挥得淋漓尽致。以一个简化了的测试案例(TestCase)为例:在测试时,NUnit需要让其中3种不同的函数依次运行如下:

首先前运行测试前的环境准备函数;然后是0~n个测试函数;最后是测试环境清理函数。熟悉NUnit的开发者都知道,在NUnit的TestCase中分别使用[SetUp]、[Test]、[TearDown]属性来进行标记。如下例:

//一个NUnit测试程序集中代码

[SetUp]

public void Init()

//…

[TearDown]

public void Destroy()

//…

[Test]

public void TestXXX()

//…

NUnit框架在运行时要从待测试程序集中读取出上述函数,并且要保证上述3种不同的函数以正确的先后顺序被依次调用。NUnit是这样实现的:

首先是开发了一套属性,用来标记测试案例(TestCase)中各种函数,如:[SetUp]、[Test]、[TearDown]。(NUnit的属性标记并不止用来标记程序集中的函数,但限于篇幅,这里只在先前作的简化环境中讨论)

NUnit 在运行时利用反射机制运行已经被编译成程序集的测试案例(TestCase)中的函数。NUnit框架中有一系列的函数来完成这项工作,这些函数只负责运 行测试案例程序集中特定属性标记所标记的函数。如:InvokeSetUp()就负责运行标记有[SetUp]的函数;InvokeTestCase() 负责运行标记有[Test]的函数,即测试案例;InvokeTearDown()负责运行标记有[TearDown]的函数。然后NUnit利用这几个 InvokeXXX()函数的调用先后来保证这3种函数运行的先后顺序。

//From TemplateTestCase in NUnit.Core namespace

//用于执行测试的Run函数

public override void Run(TestCaseResult testResult )

{

       //…

try{

            //…

         InvokeSetUp();//首先运行标有[SetUp]标记的函数

         //…

InvokeTestCase();//然后是[Test]

//…

}

catch(…)

//…

finally {

      //…

            InvokeTearDown();//最后是[TearDown]标记的函数

//…

}

//…

}

而InvokeXXX()函数则利用反射机制运行相关函数,可以看看以下几个代码段:

//From TemplateTestCase in NUnit.Core namespace

private void InvokeSetUp()

{

MethodInfo method = FindSetUpMethod(fixture);//取得[SetUp]标记的函数反射实例

           if(method != null)

           {

                  InvokeMethod(method, fixture);//运行该函数

           }

}

FindSetUpMethod(…)通过调用一个叫FindMethodByAttribute(…)的函数,利用反射机制来获得可调用该函数的MethodInfo,并最后通过InvokeMethod(MethodInfo,…)来运行。

//From Test class in NUnit.Core namespace

protected void InvokeMethod(MethodInfo method, object fixture)

{

if(method != null)

           {

           try

               {

                      method.Invoke(fixture, null);//调用由method实例反射的方法或构造函数

               }

               catch(…)

               //…

           }

}

仔细阅读源码可以看到因为NUnit使用反射机制来运行测试程序集中的测试案例,所以对[SetUp]、[Test]、[TearDown]函数的返回值、参数都有具体的要求,形成了一种规则耦合。这是为了方便反射实现、简化框架而作出的必要设计。

由NUnit可以看到.NET元数据扩展中的自定义属性在框架设计中的应用,相信会有更多的框架类项目利用.NET自定义属性的特性。下面是本文涉及的几个类在NUnit中的关系(已经作了简化)。



3.2 属性其他应用

优秀的构架启迪我们的思维,.NET属性元数据扩展的应用还远不止这些。利用其特性,还可以实现若干应用和框架设计。最近,我正在实现一个基于属性元数据扩展的项目代码管理工具,以后会与朋友们分享。


4.总结

利用.NET自定义属性实现元数据扩展,可以为在我们设计、构架时添加新的思路和解决办法。学习优秀框架(如:NUnit)是一个好办法。但读取元数据必将涉及到反射机制的使用,而反射机制的性能是较低的,这一点在设计、构架时须谨慎处理。