C# 特性（Attribute）入门

绪论

特性（ Attributes ）是一种崭新的声明性信息。我们不仅可以通过特性来定义设计层面的信息（例如 help file, URL for documentation ）以及运行时（ run-time ）信息（例如使 XML 与 class 相联系），而且我们还可以利用特性建立自描述（ self-describing ）组件。在这篇教程中，我们将会看到如何建立和添加特性到各种程序实体以及如何在运行时环境中获取特性信息。

 

定义

正如 MSDN 中所描述的那样 -----

   “特性是被指定给某一声明的一则附加的声明性信息。”

 

使用预定义（ Pre-defined ）特性

在 C# 中，有一个小的预定义特性集合。在学习如何建立我们自己的定制特性（ custom attributes ）之前，我们先来看看在我们的代码中如何使用预定义特性。

 

using System;

public class AnyClass 

{

    [Obsolete("Don't use Old method, use New method", true)]

    static void Old( ) { }

    static void New( ) { }

    public static void Main( ) 

    {

        Old( );

    }

}

我们先来看一下上面这个例子，在这个例子中我们使用了 Obsolete 特性，它标记了一个不应该再被使用的程序实体。第一个参数是一个字符串，它解释了为什么该实体是过时的以及应该用什么实体来代替它。实际上，你可以在这里写任何文本。第二个参数告诉编译器应该把使用这个过时的程序实体当作一种错误。它的默认值是 false ，也就是说编译器对此会产生一个警告。

当我们尝试编译上面这段程序的时候，我们将会得到一个错误：

AnyClass.Old()' is obsolete: 'Don't use Old method, use New method'

 

开发定制特性（ custom attributes ）

现在让我们来看看如何开发我们自己的特性。

首先我们要从 System.Attribute 派生出我们自己的特性类（一个从 System.Attribute 抽象类继承而来的类，不管是直接还是间接继承，都会成为一个特性类。特性类的声明定义了一种可以被放置在声明之上新的特性）。

using System;

public class HelpAttribute : Attribute

{

}

不管你是否相信，我们已经建立了一个定制特性，现在我们可以用它来装饰现有的类就好像上面我们使用 Obsolete attribute 一样。

[Help()]

public class AnyClass

{

}

注意：对一个特性类名使用 Attribute 后缀是一个惯例。然而，当我们把特性添加到一个程序实体，是否包括 Attribute 后缀是我们的自由。编译器会首先在 System.Attribute 的派生类中查找被添加的特性类。如果没有找到，那么编译器会添加 Attribute 后缀继续查找。

 

到目前为止，这个特性还没有起到什么作用。下面我们来添加些东西给它使它更有用些。

using System;

public class HelpAttribute : Attribute

{

    public HelpAttribute(String Descrition_in)

    {

        this.description = Description_in;

    }

    protected String description;

    public String Description 

    {

        get 

        {

            return this.description;

        }            

    }    

}

[Help("this is a do-nothing class")]

public class AnyClass

{

}

在上面的例子中，我们给 HelpAttribute 特性类添加了一个属性并且在后续的部分中我们会在运行时环境中查寻它。

定义或控制特性的使用

AttributeUsage 类是另外一个预定义特性类，它帮助我们控制我们自己的定制特性的使用。它描述了一个定制特性如和被使用。

AttributeUsage 有三个属性，我们可以把它放置在定制属性前面。第一个属性是：

 

ValidOn

通过这个属性，我们能够定义定制特性应该在何种程序实体前放置。一个属性可以被放置的所有程序实体在 AttributeTargets enumerator 中列出。通过 OR 操作我们可以把若干个 AttributeTargets 值组合起来。

 

AllowMultiple

这个属性标记了我们的定制特性能否被重复放置在同一个程序实体前多次。

 

Inherited

我们可以使用这个属性来控制定制特性的继承规则。它标记了我们的特性能否被继承。

 

下面让我们来做一些实际的东西。我们将会在刚才的 Help 特性前放置 AttributeUsage 特性以期待在它的帮助下控制 Help 特性的使用。

using System;

[AttributeUsage(AttributeTargets.Class), AllowMultiple = false, 

 Inherited = false ]

public class HelpAttribute : Attribute

{

    public HelpAttribute(String Description_in)

    {

        this.description = Description_in;

    }

    protected String description;

    public String Description

    {

        get 

        {

            return this.description;

        }            

    }    

}

先让我们来看一下 AttributeTargets.Class 。它规定了 Help 特性只能被放在 class 的前面。这也就意味着下面的代码将会产生错误：

[Help("this is a do-nothing class")]

public class AnyClass

{

    [Help("this is a do-nothing method")]    //error

    public void AnyMethod()

    {

    }

} 

编译器报告错误如下：

AnyClass.cs: Attribute 'Help' is not valid on this declaration type.

It is valid on 'class' declarations only.

 

我们可以使用 AttributeTargets.All 来允许 Help 特性被放置在任何程序实体前。可能的值是：

• Assembly, 
• Module, 
• 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 | Property | Field | Event | Delegate | Interface )

下面考虑一下 AllowMultiple = false 。它规定了特性不能被重复放置多次。

[Help("this is a do-nothing class")]

[Help("it contains a do-nothing method")]

public class AnyClass

{

    [Help("this is a do-nothing method")]        //error

    public void AnyMethod()

    {

    }

}

它产生了一个编译期错误。

AnyClass.cs: Duplicate 'Help' attribute

 

Ok, 现在我们来讨论一下最后的这个属性。 Inherited, 表明当特性被放置在一个基类上时，它能否被派生类所继承。

 

[Help("BaseClass")] 

public class Base

{

}

public class Derive : Base

{

}

这里会有四种可能的组合：

• [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false ] 
• [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false ] 
• [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true ] 
• [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true ] 

第一种情况：

如果我们查询（ Query ）（稍后我们会看到如何在运行期查询一个类的特性） Derive 类，我们将会发现 Help 特性并不存在，因为 inherited 属性被设置为 false 。

 

第二种情况：

和第一种情况相同，因为 inherited 也被设置为 false 。

 

第三种情况：

为了解释第三种和第四种情况，我们先来给派生类添加点代码：

[Help("BaseClass")] 

public class Base

{

}

[Help("DeriveClass")] 

public class Derive : Base

{

}

现在我们来查询一下 Help 特性，我们只能得到派生类的属性，因为 inherited 被设置为 true ，但是 AllowMultiple 却被设置为 false 。因此基类的 Help 特性被派生类 Help 特性覆盖了。

 

第四种情况：

在这里，我们将会发现派生类既有基类的 Help 特性，也有自己的 Help 特性，因为 AllowMultiple 被设置为 true 。