Zugriff auf Attribute mit Reflektion (C#-Programmierhandbuch)

Artikel
09/03/2008

Aktualisiert: November 2007

Die Definition von benutzerdefinierten Attributen und ihre Einbindung in den Quellcode wäre wenig sinnvoll, wenn diese Informationen nicht abgerufen bzw. wenn nicht auf sie reagiert werden könnte. C# hat ein Reflektionssystem, mit dem Sie die Informationen abrufen können, die mit benutzerdefinierten Attributen definiert wurden. Die wichtigste Methode ist GetCustomAttributes, durch die ein Array von Objekten zurückgegeben wird, die die Entsprechungen der Quellcodeattribute zur Laufzeit darstellen. Von dieser Methode sind mehrere überladene Versionen vorhanden. Weitere Informationen finden Sie unter Attribute.

Die Attributspezifikation

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

ist von ihrer Konzeption äquivalent zu

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

Der Code wird jedoch erst ausgeführt, wenn Attribute von SampleClass abgefragt werden. Der Aufruf von GetCustomAttributes für SampleClass bewirkt, dass ein Author-Objekt wie oben dargestellt erstellt und initialisiert wird. Falls die Klasse andere Attribute hat, werden andere Attributobjekte in ähnlicher Weise erstellt. GetCustomAttributes gibt dann das Author-Objekt und jedes weitere Attributobjekt in einem Array zurück. Im Anschluss können Sie das Array durchlaufen, anhand von Arrayelementtypen bestimmen, welche Attribute angewendet wurden, und Informationen aus den Attributobjekten extrahieren.

Beispiel

Im Folgenden sehen Sie ein vollständiges Beispiel. Ein benutzerdefiniertes Attribut wird definiert, auf mehrere Entitäten angewendet und mittels Reflektion abgerufen.

[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
*/