c#的[xxxAttribute]特性

灰太狼 2021-09-21 17:38 226阅读 0赞

**1、什么是Atrribute**  
首先，我们肯定Attribute是一个类，下面是msdn文档对它的描述：  
公共语言运行时允许你添加类似关键字的描述声明，叫做attributes, 它对程序中的元素进行标注，如类型、字段、方法和属性等。Attributes和Microsoft .NET Framework文件的元数据保存在一起，可以用来向运行时描述你的代码，或者在程序运行的时候影响应用程序的行为。

在.NET中,Attribute被用来处理多种问题，比如序列化、程序的安全特征、防止即时编译器对程序代码进行优化从而代码容易调试等等。下面，我们先来看几个在.NET中标准的属性的使用，稍后我们再回过头来讨论Attribute这个类本身。（文中的代码使用C\#编写，但同样适用所有基于.NET的所有语言）

**2、Attribute作为编译器的指令**  
在C\#中存在着一定数量的编译器指令，如：\#define DEBUG, \#undefine DEBUG, \#if等。这些指令专属于C\#,而且在数量上是固定的。而Attribute用作编译器指令则不受数量限制。比如下面的三个Attribute:

Conditional：起条件编译的作用，只有满足条件，才允许编译器对它的代码进行编译。一般在程序调试的时候使用。  
   DllImport：用来标记非.NET的函数，表明该方法在一个外部的DLL中定义。  
   Obsolete：这个属性用来标记当前的方法已经被废弃，不再使用了。  
下面的代码演示了上述三个属性的使用：

1![731655954c7be9d8835ece551b5385f8.png][]\#define DEBUG //这里定义条件  
 2![731655954c7be9d8835ece551b5385f8.png][]      
 3![731655954c7be9d8835ece551b5385f8.png][]using System;  
 4![731655954c7be9d8835ece551b5385f8.png][]using System.Runtime.InteropServices;  
 5![731655954c7be9d8835ece551b5385f8.png][]using System.Diagnostics;  
 6![731655954c7be9d8835ece551b5385f8.png][]      
 7![731655954c7be9d8835ece551b5385f8.png][]namespace AttributeDemo  
 8![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{  
 9![1408c5260b2f05e450dee929db9be5f7.png][]   class MainProgramClass  
10![715f2d05503b99d41f3b6ba2cdccc84d.png][]   \{  
11![1408c5260b2f05e450dee929db9be5f7.png][]   
12![1408c5260b2f05e450dee929db9be5f7.png][]      \[DllImport("User32.dll")\]  
13![1408c5260b2f05e450dee929db9be5f7.png][]      public static extern int MessageBox(int hParent, string Message, string Caption, int Type);  
14![1408c5260b2f05e450dee929db9be5f7.png][]       
15![1408c5260b2f05e450dee929db9be5f7.png][]      static void Main(string\[\] args)  
16![715f2d05503b99d41f3b6ba2cdccc84d.png][]      \{  
17![1408c5260b2f05e450dee929db9be5f7.png][]         DisplayRunningMessage();  
18![1408c5260b2f05e450dee929db9be5f7.png][]         DisplayDebugMessage();  
19![1408c5260b2f05e450dee929db9be5f7.png][]       
20![1408c5260b2f05e450dee929db9be5f7.png][]         MessageBox(0,"Hello","Message",0);  
21![1408c5260b2f05e450dee929db9be5f7.png][]       
22![1408c5260b2f05e450dee929db9be5f7.png][]         Console.ReadLine();  
23![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]      \}  
24![1408c5260b2f05e450dee929db9be5f7.png][]       
25![1408c5260b2f05e450dee929db9be5f7.png][]      \[Conditional("DEBUG")\]  
26![1408c5260b2f05e450dee929db9be5f7.png][]      private static void DisplayRunningMessage()  
27![715f2d05503b99d41f3b6ba2cdccc84d.png][]      \{  
28![1408c5260b2f05e450dee929db9be5f7.png][]         Console.WriteLine("开始运行Main子程序。当前时间是"+DateTime.Now);  
29![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]      \}  
30![1408c5260b2f05e450dee929db9be5f7.png][]    
31![1408c5260b2f05e450dee929db9be5f7.png][]      \[Conditional("DEBUG")\]  
32![1408c5260b2f05e450dee929db9be5f7.png][]      //\[Obsolete("Don't use Old method, use New method", true)\]   
33![1408c5260b2f05e450dee929db9be5f7.png][]      \[Obsolete\]  
34![1408c5260b2f05e450dee929db9be5f7.png][]      private static void DisplayDebugMessage()  
35![715f2d05503b99d41f3b6ba2cdccc84d.png][]      \{  
36![1408c5260b2f05e450dee929db9be5f7.png][]         Console.WriteLine("开始Main子程序");  
37![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]      \}  
38![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]   \}  
39![f466905a3bcb5dcef110eab799825254.png][]\}

如果在一个程序元素前面声明一个Attribute,那么就表示这个Attribute被施加到该元素上，前面的代码，\[DllImport\]施加到MessageBox函数上, \[Conditional\]施加到DisplayRuntimeMessage方法和DisplayDebugMessage方法，\[Obsolete\]施加到DisplayDebugMessage方法上。

根据上面涉及到的三个Attribute的说明，我们可以猜到程序运行的时候产生的输出：DllImport Attribute表明了MessageBox是User32.DLL中的函数，这样我们就可以像内部方法一样调用这个函数。

重要的一点就是Attribute就是一个类，所以DllImport也是一个类，Attribute类是在编译的时候被实例化的，而不是像通常的类那样在运行时候才实例化。Attribute实例化的时候根据该Attribute类的设计可以带参数，也可以不带参数，比如DllImport就带有"User32.dll"的参数。Conditional对满足参数的定义条件的代码进行编译，如果没有定义DEBUG,那么该方法将不被编译，读者可以把\#define DEBUG一行注释掉看看输出的结果（release版本，在Debug版本中Conditional的debug总是成立的）。Obsolete表明了DispalyDebugMessage方法已经过时了，它有一个更好的方法来代替它，当我们的程序调用一个声明了Obsolete的方法时，那么编译器会给出信息，Obsolete还有其他两个重载的版本。大家可以参考msdn中关于的ObsoleteAttribute 类的描述。

**3、Attribute类**  
除了.NET提供的那些Attribute派生类之外，我们可以自定义我们自己的Attribute，所有自定义的Attribute必须从Attribute类派生。现在我们来看一下Attribute 类的细节：

protected Attribute(): 保护的构造器，只能被Attribute的派生类调用。

**三个静态方法：**

static Attribute GetCustomAttribute():这个方法有8种重载的版本，它被用来取出施加在类成员上指定类型的Attribute。

static Attribute\[\] GetCustomAttributes(): 这个方法有16种重载版本，用来取出施加在类成员上指定类型的Attribute数组。

static bool IsDefined():由八种重载版本，看是否指定类型的定制attribute被施加到类的成员上面。

**实例方法：**

bool IsDefaultAttribute(): 如果Attribute的值是默认的值，那么返回true。

bool Match():表明这个Attribute实例是否等于一个指定的对象。

**公共属性：** TypeId: 得到一个唯一的标识，这个标识被用来区分同一个Attribute的不同实例。

我们简单地介绍了Attribute类的方法和属性，还有一些是从object继承来的。这里就不列出来了。

下面介绍如何自定义一个Attribute: 自定义一个Attribute并不需要特别的知识，其实就和编写一个类差不多。自定义的Attribute必须直接或者间接地从Attribute这个类派生，如：

public MyCustomAttribute : Attribute \{ ... \}

这里需要指出的是Attribute的命名规范，也就是你的Attribute的类名+"Attribute",当你的Attribute施加到一个程序的元素上的时候，编译器先查找你的Attribute的定义，如果没有找到，那么它就会查找“Attribute名称"+Attribute的定义。如果都没有找到，那么编译器就报错。

**4、定义或控制特性的使用**

对于一个自定义的Attribute，你可以通过AttributeUsage的Attribute来限定你的Attribute 所施加的元素的类型。代码形式如下：  
**\[AttriubteUsage(参数设置)\] public 自定义Attribute : Attribute \{ ... \}**

非常有意思的是，AttributeUsage本身也是一个Attribute，这是专门施加在Attribute类的Attribute. AttributeUsage自然也是从Attribute派生，它有一个带参数的构造器，这个参数是AttributeTargets的枚举类型。下面是AttributeTargets 的定义：

1![731655954c7be9d8835ece551b5385f8.png][]public enum AttributeTargets  
 2![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{  
 3![1408c5260b2f05e450dee929db9be5f7.png][]   All=16383,  
 4![1408c5260b2f05e450dee929db9be5f7.png][]   Assembly=1,  
 5![1408c5260b2f05e450dee929db9be5f7.png][]   Module=2,  
 6![1408c5260b2f05e450dee929db9be5f7.png][]   Class=4,  
 7![1408c5260b2f05e450dee929db9be5f7.png][]   Struct=8,  
 8![1408c5260b2f05e450dee929db9be5f7.png][]   Enum=16,  
 9![1408c5260b2f05e450dee929db9be5f7.png][]   Constructor=32,  
10![1408c5260b2f05e450dee929db9be5f7.png][]   Method=64,  
11![1408c5260b2f05e450dee929db9be5f7.png][]   Property=128,  
12![1408c5260b2f05e450dee929db9be5f7.png][]   Field=256,  
13![1408c5260b2f05e450dee929db9be5f7.png][]   Event=512,  
14![1408c5260b2f05e450dee929db9be5f7.png][]   Interface=1024,  
15![1408c5260b2f05e450dee929db9be5f7.png][]   Parameter=2048,  
16![1408c5260b2f05e450dee929db9be5f7.png][]   Delegate=4096,  
17![1408c5260b2f05e450dee929db9be5f7.png][]   ReturnValue=8192  
18![f466905a3bcb5dcef110eab799825254.png][]\}

作为参数的AttributeTarges的值允许通过“或”操作来进行多个值得组合，如果你没有指定参数，那么默认参数就是All 。 AttributeUsage除了继承Attribute 的方法和属性之外，还定义了以下三个属性：

AllowMultiple: 读取或者设置这个属性，表示是否可以对一个程序元素施加多个Attribute 。

Inherited:读取或者设置这个属性，表示是否施加的Attribute 可以被派生类继承或者重载。

ValidOn: 读取或者设置这个属性，指明Attribute 可以被施加的元素的类型。

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

1![731655954c7be9d8835ece551b5385f8.png][]using System;   
 2![731655954c7be9d8835ece551b5385f8.png][]\[AttributeUsage(AttributeTargets.Class), AllowMultiple = false,   
 3![731655954c7be9d8835ece551b5385f8.png][]Inherited = false \]   
 4![731655954c7be9d8835ece551b5385f8.png][]public class HelpAttribute : Attribute   
 5![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{   
 6![1408c5260b2f05e450dee929db9be5f7.png][]public HelpAttribute(String Description\_in)   
 7![715f2d05503b99d41f3b6ba2cdccc84d.png][]\{   
 8![1408c5260b2f05e450dee929db9be5f7.png][]this.description = Description\_in;   
 9![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]\}   
10![1408c5260b2f05e450dee929db9be5f7.png][]protected String description;   
11![1408c5260b2f05e450dee929db9be5f7.png][]public String Description   
12![715f2d05503b99d41f3b6ba2cdccc84d.png][]\{   
13![1408c5260b2f05e450dee929db9be5f7.png][]get   
14![715f2d05503b99d41f3b6ba2cdccc84d.png][]\{   
15![1408c5260b2f05e450dee929db9be5f7.png][]return this.description;   
16![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]\}   
17![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]\}   
18![f466905a3bcb5dcef110eab799825254.png][]\}

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

1![731655954c7be9d8835ece551b5385f8.png][]\[Help("this is a do-nothing class")\]   
2![731655954c7be9d8835ece551b5385f8.png][]public class AnyClass   
3![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{   
4![1408c5260b2f05e450dee929db9be5f7.png][]\[Help("this is a do-nothing method")\] //error   
5![1408c5260b2f05e450dee929db9be5f7.png][]public void AnyMethod()   
6![715f2d05503b99d41f3b6ba2cdccc84d.png][]\{   
7![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]\}   
8![f466905a3bcb5dcef110eab799825254.png][]\}

编译器报告错误如下：

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。它规定了特性不能被重复放置多次。

1![731655954c7be9d8835ece551b5385f8.png][]\[Help("this is a do-nothing class")\]   
2![731655954c7be9d8835ece551b5385f8.png][]\[Help("it contains a do-nothing method")\]   
3![731655954c7be9d8835ece551b5385f8.png][]public class AnyClass   
4![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{   
5![1408c5260b2f05e450dee929db9be5f7.png][]\[Help("this is a do-nothing method")\] //error   
6![1408c5260b2f05e450dee929db9be5f7.png][]public void AnyMethod()   
7![715f2d05503b99d41f3b6ba2cdccc84d.png][]\{   
8![5bcb1807ee3e00d2b3c225f0b3f5c751.png][]\}   
9![f466905a3bcb5dcef110eab799825254.png][]\}

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

AnyClass.cs: Duplicate 'Help' attribute

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

1![731655954c7be9d8835ece551b5385f8.png][]\[Help("BaseClass")\]   
2![731655954c7be9d8835ece551b5385f8.png][]public class Base   
3![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{   
4![f466905a3bcb5dcef110eab799825254.png][]\}   
5![731655954c7be9d8835ece551b5385f8.png][]  
6![731655954c7be9d8835ece551b5385f8.png][]public class Derive : Base   
7![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{   
8![f466905a3bcb5dcef110eab799825254.png][]\}  
9![731655954c7be9d8835ece551b5385f8.png][]

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

\[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。

第三种情况：

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

1![731655954c7be9d8835ece551b5385f8.png][]\[Help("BaseClass")\]   
2![731655954c7be9d8835ece551b5385f8.png][]public class Base   
3![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{   
4![f466905a3bcb5dcef110eab799825254.png][]\}   
5![731655954c7be9d8835ece551b5385f8.png][]\[Help("DeriveClass")\]   
6![731655954c7be9d8835ece551b5385f8.png][]public class Derive : Base   
7![24a924a57ba6b3f2b51fc9edb7ea4186.png][]\{   
8![f466905a3bcb5dcef110eab799825254.png][]\}

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

第四种情况：

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

[731655954c7be9d8835ece551b5385f8.png]: /images/20210920/29895174b6fc4e7fa81df98127c106cf.png
[24a924a57ba6b3f2b51fc9edb7ea4186.png]: /images/20210920/02fbded21ec14dafb3ebc9a3d3d788db.png
[1408c5260b2f05e450dee929db9be5f7.png]: /images/20210920/b85b12c0e81648c594fcb923f35d6a94.png
[715f2d05503b99d41f3b6ba2cdccc84d.png]: /images/20210920/38f4a729285f4db295b3f77b5986c51e.png
[5bcb1807ee3e00d2b3c225f0b3f5c751.png]: /images/20210920/6b2278125c3a40ed93778f0ffb87bb82.png
[f466905a3bcb5dcef110eab799825254.png]: /images/20210920/9a8c504f3c7048ddb9bef7b50d281b8b.png

发表评论取消回复

表情：

评论列表（有 0 条评论，226人围观）

还没有评论，来说两句吧...

相关阅读

相关【C++】C++11的新特性（上）

C++11作为C++标准的一个重要版本，引入了许多令人振奋的新特性，极大地丰富了这门编程语言的功能和表达能力。本章将为您介绍C++11的一些主要变化和改进，为接下来的章节铺垫。

喜欢ヅ旅行/ 2024年04月22日 22:20/ 0 赞/ 91 阅读

相关【c/c++】C++11中的新特性

说明 1. 新增关键词nullptr。新增的nullptr是用来替代0或者NULL，来表示指向空(no value)的指针。下面是一个例子： void

绝地灬酷狼/ 2023年10月16日 23:09/ 0 赞/ 65 阅读

相关 C#中的特性

什么是特性来看一段微软官方文档的描述： > 使用特性，可以有效地将元数据或声明性信息与代码（程序集、类型、方法、属性等）相关联。将特性与程序实体相关联后，可以在运行

小灰灰/ 2023年09月28日 22:25/ 0 赞/ 8 阅读

相关 C++11的特性

转：http://www.cnblogs.com/pzhfei/archive/2013/03/02/CPP\_new\_feature.html\section\_6.4

た入场券/ 2022年09月29日 04:07/ 0 赞/ 155 阅读

相关 C++的三大特性

OOP具有三大特性：封装性、继承性和多态性。 1.封装性(Encapsulation) 所谓封装，就是将某些东西包装和隐藏起来，让外界无法直接使用，只能通过某些

男娘i/ 2022年08月07日 08:47/ 0 赞/ 171 阅读

相关 C++11的新特性

最近学习了C++11的新特性，将学习内容整理下来以巩固记忆，C++11的新特性，可以分为两部分，第一部分是C++11核心语言的特性，第二部分是STL标准库的新特性。学习C++1

叁歲伎倆/ 2022年07月24日 03:26/ 0 赞/ 257 阅读

相关 C语言的特性

通过如下的一些例子，感知C语言的特性。 1、swtich 通常格式为： switch(表达式) \{ case 常量1：零或多条语句；break; case 常量

r囧r小猫/ 2022年07月13日 03:14/ 0 赞/ 188 阅读

相关 C99的新特性

C99出来很久了，好像现在还在谈论一个10多年前的标准显得有点过时。不过现实是：关于C99新增的特性，许多用C用了N年的人其实还都不清楚。而在一些能找到的相关文章里面，基本上都

末蓝、/ 2022年06月17日 23:21/ 0 赞/ 174 阅读

相关 C++11的特性

转：http://www.cnblogs.com/pzhfei/archive/2013/03/02/CPP\_new\_feature.html\section\_6.4

浅浅的花香味﹌/ 2022年03月11日 06:50/ 0 赞/ 267 阅读

相关 c#的[xxxAttribute]特性

1、什么是Atrribute 首先，我们肯定Attribute是一个类，下面是msdn文档对它的描述：公共语言运行时允许你添加类似关键字的描述声明，叫做attribu

灰太狼/ 2021年09月21日 17:38/ 0 赞/ 227 阅读