Zugriff auf Attribute mit Reflektion (C#)Accessing Attributes by Using Reflection (C#)

Die Tatsache, dass Sie benutzerdefinierte Attribute definieren und diese in Ihren Quellcode platzieren können, hätte keinen Nutzen, wenn Sie diese Informationen nicht abrufen und darauf reagieren könnten.The fact that you can define custom attributes and place them in your source code would be of little value without some way of retrieving that information and acting on it. Mithilfe der Reflektion können Sie die Informationen abrufen, die mit benutzerdefinierten Attributen definiert wurden.By using reflection, you can retrieve the information that was defined with custom attributes. Die Schlüsselmethode ist GetCustomAttributes, die ein Array von Objekten zurück gibt, die die Laufzeitäquivalente der Quellcodeattribute sind.The key method is GetCustomAttributes, which returns an array of objects that are the run-time equivalents of the source code attributes. Diese Methode hat mehrere überladene Versionen.This method has several overloaded versions. Weitere Informationen finden Sie unter Attribute.For more information, see Attribute.

Eine Attributspezifikation wie z.B.:An attribute specification such as:

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

ist mit Folgendem vergleichbar:is conceptually equivalent to this:

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

Der Code wird allerdings erst ausgeführt, wenn SampleClass nach Attributen abgefragt wird.However, the code is not executed until SampleClass is queried for attributes. Wenn GetCustomAttributes in SampleClass aufgerufen wird, führt dies zur Erstellung und Initialisierung eines Author-Objekt wie oben aufgeführt.Calling GetCustomAttributes on SampleClass causes an Author object to be constructed and initialized as above. Wenn die Klasse andere Attribute aufweist, werden so auch andere Attributobjekte erstellt.If the class has other attributes, other attribute objects are constructed similarly. GetCustomAttributes gibt anschließend das Author-Objekt zurück sowie jedes andere Attributobjekt eines Arrays.GetCustomAttributes then returns the Author object and any other attribute objects in an array. Dann können Sie dieses Array durchlaufen, anhand der Type der Arrayelemente feststellen, welche Attribute gelten, und Informationen jedes Attributobjekts erhalten.You can then iterate over this array, determine what attributes were applied based on the type of each array element, and extract information from the attribute objects.

BeispielExample

Im Folgenden sehen Sie ein vollständiges Beispiel.Here is a complete example. Ein benutzerdefiniertes Attribut wird definiert, auf mehrere Entitäten angewendet und mithilfe der Reflektion abgerufen.A custom attribute is defined, applied to several entities, and retrieved via reflection.

// Multiuse attribute.  
[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;  

        // Default value.  
        version = 1.0;  
    }  

    public string GetName()  
    {  
        return name;  
    }  
}  

// Class with the Author attribute.  
[Author("P. Ackerman")]  
public class FirstClass  
{  
    // ...  
}  

// Class without the Author attribute.  
public class SecondClass  
{  
    // ...  
}  

// Class with multiple Author attributes.  
[Author("P. Ackerman"), Author("R. Koch", version = 2.0)]  
public class ThirdClass  
{  
    // ...  
}  

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

    private static void PrintAuthorInfo(System.Type t)  
    {  
        System.Console.WriteLine("Author information for {0}", t);  

        // Using reflection.  
        System.Attribute[] attrs = System.Attribute.GetCustomAttributes(t);  // Reflection.  

        // Displaying output.  
        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  
       P. Ackerman, version 1.00  
    Author information for SecondClass  
    Author information for ThirdClass  
       R. Koch, version 2.00  
       P. Ackerman, version 1.00  
*/  

Siehe auchSee Also

System.Reflection
Attribute
C#-ProgrammierhandbuchC# Programming Guide
Abrufen von Informationen aus AttributenRetrieving Information Stored in Attributes
Reflektion (C#)Reflection (C#)
Attribute (C#)Attributes (C#)
Erstellen benutzerdefinierter Attribute (C#)Creating Custom Attributes (C#)