使用反映存取屬性 (C# 程式設計手冊)

發行項
08/21/2008

更新：2007 年 11 月

如果沒有可以擷取資訊並加以執行的方法，那麼定義自訂屬性並且將他們放置在您的原始程式碼中實際上的價值不大。C# 具有一個反映系統，允許您擷取由自訂屬性定義的資訊。關鍵的方法是 GetCustomAttributes，它能傳回一個物件陣列，這是原始程式碼屬性在執行階段的對等用法。這個方法擁有數種多載版本。如需詳細資訊，請參閱 Attribute。

屬性規格例如：

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

在概念上相等於：

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

但是，除非查詢 SampleClass 屬性，否則不會執行程式碼。在 SampleClass 上呼叫 GetCustomAttributes，會建構並初始化 Author 物件，如上所述。如果該類別有其他屬性，其他屬性物件會以類似的方式建構。然後 GetCustomAttributes 會將 Author 物件和任何其他屬性物件傳回到陣列中。然後，您可以逐一查看陣列，以每項陣列元素的類型為基礎來決定所要套用的屬性，並且從屬性物件擷取資訊。

範例

以下是一個完整的範例，其中定義了一個自訂屬性，套用至數個實體，並且經由反映來擷取。

[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);
            }
        }
    }
}
/* Output:
    Author information for FirstClass
       H. Ackerman, version 1.00
    Author information for SecondClass
    Author information for ThirdClass
       M. Knott, version 2.00
       H. Ackerman, version 1.00
*/