Zugreifen auf Attribute mithilfe der Reflektion (C# und Visual Basic)

Artikel
08/10/2011

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. Durch Reflektion können Sie die Informationen abrufen, 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("P. Ackerman", Version:=1.1)> 
Class SampleClass
    ' P. Ackerman's code goes here...
End Class

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

ist von ihrer Konzeption äquivalent zu

Dim anonymousAuthorObject As Author = New Author("P. Ackerman")
anonymousAuthorObject.version = 1.1

Author anonymousAuthorObject = new Author("P. 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. Wenn die Klasse über andere Attribute verfügt, werden andere Attributobjekte auf ähnliche Weise erstellt. GetCustomAttributes gibt dann das Author-Objekt und beliebige andere Attributobjekte 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.

' Multiuse attribute
<System.AttributeUsage(System.AttributeTargets.Class Or 
                       System.AttributeTargets.Struct, 
                       AllowMultiple:=True)> 
Public Class Author
    Inherits System.Attribute
    Private name As String
    Public version As Double
    Sub New(ByVal authorName As String)
        name = authorName

        ' Default value
        version = 1.0
    End Sub

    Function GetName() As String
        Return name
    End Function        
End Class

' Class with the Author attribute
<Author("P. Ackerman")> 
Public Class FirstClass
End Class

' Class without the Author attribute
Public Class SecondClass
End Class

' Class with multiple Author attributes.
<Author("P. Ackerman"), Author("R. Koch", Version:=2.0)> 
Public Class ThirdClass
End Class

Class TestAuthorAttribute
    Sub Main()
        PrintAuthorInfo(GetType(FirstClass))
        PrintAuthorInfo(GetType(SecondClass))
        PrintAuthorInfo(GetType(ThirdClass))
    End Sub

    Private Shared Sub PrintAuthorInfo(ByVal t As System.Type)
        System.Console.WriteLine("Author information for {0}", t)

        ' Using reflection
        Dim attrs() As System.Attribute = System.Attribute.GetCustomAttributes(t)

        ' Displaying output
        For Each attr In attrs
            Dim a As Author = CType(attr, Author)
            System.Console.WriteLine("   {0}, version {1:f}", a.GetName(), a.version)
        Next            
    End Sub

    ' 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

End Class

// 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 auch

Zugreifen auf Attribute mithilfe der Reflektion (C# und Visual Basic)

Beispiel

Siehe auch

Referenz

Konzepte

Weitere Ressourcen

Zusätzliche Ressourcen