C# 特性详解(上)

特性（attribute）是被指定给某一声明的一则附加的声明性信息。

元数据,就是C#中封装的一些类,无法修改.类成员的特性被称为元数据中的注释.

1、什么是特性

1）属性与特性的区别

属性(Property)：属性是面向对象思想里所说的封装在类里面的数据字段，Get，Set方法。

特性(Attribute): 官方解释：特性是给指定的某一声明的一则附加的声明性信息。允许类似关键字的描述声明。它对程序中的元素进行标注，如类型、字段、方法、属性等。从.net角度看，特性是一种类，这些类继承于System.Attribute类，用于对类、属性、方法、事件等进行描述，主要用在反射中。但从面向对象的级别看，其实 Attribute是类型级别的，而不是对象级别。

Attributes和.net文件的元素据保存在一起，可以用来向运行时描述你的代码，或者在程序运行的时候影响程序的行为。

2、特性的应用

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

 1 using System; 
 2 public class AnyClass 
 3 { 
 4     [Obsolete("Don't use Old method, use New method", true)] 
 5     static void Old( ) { }  
 6     static void New( ) { } 
 7      public static void Main( ) 
 8      { 
 9          Old( ); 
10     } 
11 }

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

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

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

（1）.net中特性用来处理多种问题，比如序列化、程序的安全特性、防止即时编译器对程序代码进行优化从而代码容易调试等等。

定植特性的本质上是一个类的元素上去添加附加信息，并在运行其通过反射得到该附加信息（在使用数据实体对象时经常用到）

（2）Attribute 作为编译器的指令时的应用

Conditional:起条件编译的作用，只有满足条件，才允许编译器对它的代码进行编译。一般在程序调试的时候使用

DllImport：用来标记费.net的函数，表明该方法在一个外部的DLL中定义。

Obsolete：这个属性用来标记当前的方法已经废弃，不再使用

注：Attribute是一个类，因此DllImport也是一个类，Attribute类是在编译的时候实例化，而不是像通常那样在运行时实例化。

CLSCompliant: 保证整个程序集代码遵守CLS，否则编译将报错。

3、自定义特性

使用AttributeUsage，来控制如何应用新定义的特性

[AttributeUsageAttribute(AttributeTargets.All //可以应用到任何元素
 ,AllowMultiple=true, //允许应用多次,我们的定值特性能否被重复放在同一个程序实体前多次
 ,Inherited=false,//不继承到派生
)]

特性也是一个类，必须继承于System.Attribute类,命名规范为“类名”+Attribute。不管是直接还是间接继承，都会成为一个特性类，特性类的声明定义了一种可以放置在声明之上新的特性。

public class MyselfAttribute:System.Attribute

自定义特定：

//限定特性类的应用范围
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field, AllowMultiple = true, Inherited = false)]
//定制MsgAttribute特性类，继承于Attribute
public class ClassMsgAttribute : Attribute
{
    //定义_msg字段和Msg属性//Msg属性用于读写msg字段
    string _msg;
    public string Msg { get { return _msg; } set { _msg = value; } }
    public ClassMsgAttribute() { }
    //重载构造函数接收一个参数，赋值给_msg字段
    public ClassMsgAttribute(string s) { _msg = s; }　
}

调用：

 1 //在Person类上标记ClassMsg特性
 2 [ClassMsg(Msg = "这是关于人的姓名信息的类")]
 3 class Person
 4 {
 5     //在_name字段上应用ClassMsg特性
 6     [ClassMsg("这是存储姓名的字段")]
 7     string _name;
 8     //以下特性无法应用，因为MsgAttribute定义的特性只能用于类和字段
 9     //[ClassMsg("这是读写姓名字段的属性")]
10     public string Name { get { return _name; } set { _name = value; } }
11 }

主函数的情况

 1   static void Main(string[] args)
 2     {
 3         //获取Person类的Type对象tp
 4         Type tp = Type.GetType("Person");
 5         //获取tp对象的特性数组，并将数组赋值给MyAtts
 6         object[] MyAtts = tp.GetCustomAttributes(false);
 7         //遍历并输出MyAtts数组子项的Msg属性
 8         foreach (ClassMsgAttribute m in MyAtts)
 9         { 
10             Console.WriteLine("Person类的特性：{0}", m.Msg); 
11         }
12      }

GetCustomAttributes用于获取程序集的特性，也就是这个程序集合中包含了多少个特性

开发定制特性（custom attributes）

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

1 using System; 
2 public class HelpAttribute : Attribute 
3 { 
4 }

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

1 [Help()] 
2 public class AnyClass {}

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

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

 1 using System; 
 2 public class HelpAttribute : Attribute 
 3 { 
 4      public HelpAttribute(String Descrition_in) 
 5     { 
 6         this.description = Description_in; 
 7     } 
 8     protected String description; 
 9     public String Description 
10     { 
11        get 
12        { 
13            return this.description; 
14        } 
15    } 
16 } 
17 [Help("this is a do-nothing class")] 
18 public class AnyClass 
19 { 
20 }

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

定义或控制特性的使用

AttributeUsage类是另外一个预定义特性类，它帮助我们控制我们自己的定制特性的使用。它描述了一个定制特性如和被使用。
AttributeUsage有三个属性，我们可以把它放置在定制属性前面。第一个属性是：

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

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

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

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

 1 using System; 
 2 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)] 
 3 public class HelpAttribute : Attribute 
 4 { 
 5     public HelpAttribute(String Description_in) 
 6     { 
 7         this.description = Description_in; 
 8     } 
 9     protected String description; 
10     public String Description 
11    { 
12        get 
13        { 
14            return this.description; 
15        } 
16    } 
17 }

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

1 [Help("this is a do-nothing class")] 
2 public class AnyClass 
3 { 
4     [Help("this is a do-nothing method")] //error 
5     public void AnyMethod() 
6     { 
7     } 
8 }

编译器报告错误如下：

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

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

1 [Help("this is a do-nothing class")] 
2 [Help("it contains a do-nothing method")] 
3 public class AnyClass 
4 { 
5     [Help("this is a do-nothing method")] //error 
6     public void AnyMethod() 
7     { 
8     } 
9 }

它产生了一个编译期错误。
AnyClass.cs: Duplicate 'Help' attribute

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

1 [Help("BaseClass")] 
2 public class Base 
3 { 
4 } 
5 public class Derive : Base 
6 { 
7 }

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

1 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)] 
2 [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)] 
3 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)] 
4 [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]

第一种情况：

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

第二种情况：

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

第三种情况：

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

1 [Help("BaseClass")] 
2 public class Base 
3 { 
4 } 
5 [Help("DeriveClass")] 
6 public class Derive : Base 
7 { 
8 }

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

第四种情况：

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

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

属性和特性的区别可以参考一下： http://developer.51cto.com/art/200908/147097.htm

本文来自CSDN博客，转载请标明出处：http://blog.csdn.net/Foxalien/archive/2009/12/05/4946672.aspx

首先要说的是，可能一些刚接触C#的朋友常常容易把属性（Property）跟特性（Attribute）弄混淆，其实这是两种不同的东西。属性就是面向对象思想里所说的封装在类里面的数据字段，其形式为：

在HumanBase这个类里出现的字段都叫属性（Property），而C#特性（Attribute）又是怎样的呢？

简单地讲，我们在HumanBase类声明的上一行加了一个[Serializable]，这就是特性（Attribute），它表示HumanBase是可以被序列化的，这对于网络传输是很重要的，不过你不用担心如何去理解它，如何理解就是我们下面要探讨的。

C#特性可以应用于各种类型和成员。前面的例子将特性用在类上就可以被称之为“类特性”，同理，如果是加在方法声明前面的就叫方法特性。无论它们被用在哪里，无论它们之间有什么区别，特性的最主要目的就是自描述。并且因为特性是可以由自己定制的，而不仅仅局限于.NET提供的那几个现成的，因此给 C#程序开发带来了相当大的灵活性和便利。

我们还是借用生活中的例子来介绍C#的特性机制吧。

假设有一天你去坐飞机，你就必须提前去机场登机处换登机牌。登机牌就是一张纸，上面写着哪趟航班、由哪里飞往哪里以及你的名字、座位号等等信息，其实，这就是特性。它不需要你生理上包含这些属性（人类出现那会儿还没飞机呢），就像上面的HumanBase类没有IsSerializable这样的属性，特性只需要在类或方法需要的时候加上去就行了，就像你不总是在天上飞一样。

当我们想知道HumanBase是不是可序列化的，可以通过：

拿到了登机牌，就意味着你可以合法地登机起飞了。但此时你还不知道你要坐的飞机停在哪里，不用担心，地勤人员会开车送你过去，但是他怎么知道你是哪趟航班的呢？显然还是通过你手中的登机牌。所以，特性最大的特点就是自描述。

既然是起到描述的作用，那目的就是在于限定。就好比地勤不会把你随便拉到一架飞机跟前就扔上去了事，因为标签上的说明信息就是起到限定的作用，限定了目的地、乘客和航班，任何差错都被视为异常。如果前面的HumanBase不加上Serializable特性就不能在网络上传输。

我们在顺带来介绍一下方法特性，先给HumanProperty加上一个Run方法：

只要是个四肢健全、身体健康的人就可以跑步，那这么说，跑步就是有前提条件的，至少是四肢健全，身体健康。由此可见，残疾人和老年人如果跑步就会出问题。假设一个HumanBase的对象代表的是一位耄耋老人，如果让他当刘翔的陪练，那就直接光荣了。如何避免这样的情况呢，我们可以在Run方法中加一段逻辑代码，先判断Age大小，如果小于2或大于60直接抛异常，但是2-60岁之间也得用Switch来分年龄阶段地判断speed参数是否合适，那么逻辑就相当臃肿。简而言之，如何用特性表示一个方法不能被使用呢？OK, here we go：

上面大致介绍了一下特性的使用与作用，接下来我们要向大家展示的是如何通过自定义特性来提高程序的灵活性，如果特性机制仅仅能使用.NET提供的那几种特性，不就太不过瘾了么。

首先，特性也是类。不同于其它类的是，特性都必须继承自System.Attribute类，否则编译器如何知道谁是特性谁是普通类呢。当编译器检测到一个类是特性的时候，它会识别出其中的信息并存放在元数据当中，仅此而已，编译器并不关心特性说了些什么，特性也不会对编译器起到任何作用，正如航空公司并不关心每个箱子要去哪里，只有箱子的主人和搬运工才会去关心这些细节。假设我们现在就是航空公司的管理人员，需要设计出前面提到的登机牌，那么很简单，我们先看看最主要的信息有哪些：

我们简单列举这些属性作为航空公司登机牌上的信息，用法和前面的一样，贴到HumanBase上就行了，说明此人具备登机资格。这里要简单提一下，你可能已经注意到了，在使用BoardingCheckAttribute的时候已经把Attribute省略掉了，不用担心，这样做是对的，因为编译器默认会自己加上然后查找这个属性类的。哦，等一下，我突然想起来他该登哪架飞机呢？显然，在这种需求下，我们的特性还没有起到应有的作用，我们还的做点儿工作，否则乘客面对一张空白的机票一定会很迷茫。

于是，我们必须给这个C#特性加上构造函数，因为它不仅仅表示登机的资格，还必须包含一些必要的信息才行：

OK，我们的乘客就可以拿到一张正式的登机牌登机了，have a good flight！

posted @ 2013-06-26 10:14 若愚Shawn 阅读(2317) 评论(0) 编辑收藏举报

刷新页面返回顶部

大智若愚

厚积薄发

C# 特性详解(上)

公告