C#编程指南：使用属性

属性可以放置在几乎所有的声明中（但特定的属性可能限制在其上有效的声明类型）。

在语法上，属性的指定方法为：将括在方括号中的属性名置于其适用的实体声明之前。例如，具有 DllImport 属性的方法将声明如下：

C#  
[System.Runtime.InteropServices.DllImport( " user32.dll ")]
extern  static  void SampleMethod();

 

 许多属性都有参数，而这些参数可以是定位（未命名）参数也可以是命名参数。任何定位参数都必须按特定顺序指定并且不能省略，而命名参数是可选的且可以按任意顺序指定。首先指定定位参数。例如，这三个属性是等效的：

[DllImport( " user32.dll ")]
[DllImport( " user32.dll ", SetLastError= false, ExactSpelling= false)]
[DllImport( " user32.dll ", ExactSpelling= false, SetLastError= false)]

第一个参数（DLL 名称）是定位参数并且总是第一个出现，其他参数为命名参数。在这种情况下，两个命名参数均默认为 false，因此可将其省略。有关默认参数值的信息，请参考各个属性的文档。

在一个声明中可以放置多个属性，可分开放置，也可放在同一组括号中：

C#   
void MethodA([In][Out]  ref  double x) { }
void MethodB([Out][In]  ref  double x) { }
void MethodC([In, Out]  ref  double x) { }

 

某些属性对于给定实体可以指定多次。例如，Conditional 就是一个可多次使用的属性：

C# 
[Conditional( " DEBUG "), Conditional( " TEST1 ")]
void TraceMethod()
{
     //  ...
}

 

注意：
根据约定，所有属性名称都以单词“Attribute”结束，以便将它们与“.NET Framework”中的其他项区分。但是，在代码中使用属性时不需要指定属性后缀。例如，[DllImport] 虽等效于 [DllImportAttribute]，但 DllImportAttribute 才是该属性在 .NET Framework 中的实际名称。
 

如果没有检索自定义属性的信息和对其进行操作的方法，则定义自定义属性并将其放置在源代码中就没有意义。C# 具有一个反射系统，可用来检索用自定义属性定义的信息。主要方法是 GetCustomAttributes，它返回对象数组，这些对象在运行时等效于源代码属性。此方法具有多个重载版本。有关更多信息，请参见 Attribute。

属性规范，如：

C# 
[Author( " H. Ackerman ", version =  1.1)]
class SampleClass 

在概念上等效于：

C#
Author anonymousAuthorObject =  new Author( " H. Ackerman ");
anonymousAuthorObject.version =  1.1;

但是，直到查询 SampleClass 以获取属性时才会执行此代码。对 SampleClass 调用 GetCustomAttributes 会导致按上述方式构造并初始化一个 Author 对象。如果类还有其他属性，则其他属性对象的以类似方式构造。然后 GetCustomAttributes 返回 Author 对象和数组中的任何其他属性对象。之后就可以对此数组进行迭代，确定根据每个数组元素的类型所应用的属性，并从属性对象中提取信息。

示例
下面是一个完整的示例。定义一个自定义属性，将其应用于若干实体并通过反射进行检索。 

C#   
[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct,
                       AllowMultiple =  true)   //  multiuse attribute
]
public  class Author : System.Attribute
{
     string name;
     public  double version;

     public Author( string name)
    {
         this.name = name;
        version =  1.0;   //  Default value
    }

     public  string GetName()
    {
         return name;
    }
}

[Author( " H. Ackerman ")]
private  class FirstClass
{
     //  ...
}

//  No Author attribute
private  class SecondClass
{
     //  ...
}

[Author( " H. Ackerman "), Author( " M. Knott ", version =  2.0)]
private  class ThirdClass
{
     //  ...
}

class TestAuthorAttribute
{
     static  void Main()
    {
        PrintAuthorInfo( typeof(FirstClass));
        PrintAuthorInfo( typeof(SecondClass));
        PrintAuthorInfo( typeof(ThirdClass));
    }

     private  static  void PrintAuthorInfo(System.Type t)
    {
        System.Console.WriteLine( " Author information for {0} ", t);
        System.Attribute[] attrs = System.Attribute.GetCustomAttributes(t);   //  reflection

         foreach (System.Attribute attr  in attrs)
        {
             if (attr  is Author)
            {
                Author a = (Author)attr;
                System.Console.WriteLine( "    {0}, version {1:f} ", a.GetName(), a.version);
            }
        }
    }
}

输出
Author information for FirstClass

H. Ackerman, version 1.00

Author information for SecondClass

Author information for ThirdClass

H. Ackerman, version 1.00

M. Knott, version 2.00