Freigeben über

Zugriffsattribute mithilfe von Reflexion

Die Tatsache, dass Sie benutzerdefinierte Attribute definieren und in Ihrem Quellcode platzieren können, wäre von geringem Wert, ohne diese Informationen abzurufen und darauf zu handeln. Mithilfe der Spiegelung können Sie die Informationen abrufen, die mit benutzerdefinierten Attributen definiert wurden. Die Schlüsselmethode ist GetCustomAttributes, die ein Array von Objekten zurückgibt, die die Laufzeitentsprechungen der Quellcodeattribute sind. Diese Methode hat viele überladene Versionen. Weitere Informationen finden Sie unter Attribute.

Eine Attributspezifikation, z. B.:

[Author("P. Ackerman", Version = 1.1)]
class SampleClass { }

entspricht konzeptuell dem folgenden Code:

var anonymousAuthorObject = new Author("P. Ackerman")
{
    Version = 1.1
};

Der Code wird allerdings erst ausgeführt, wenn SampleClass nach Attributen abgefragt wird. Wenn GetCustomAttributes in SampleClass aufgerufen wird, führt dies zur Erstellung und Initialisierung eines Author-Objekts. Wenn die Klasse andere Attribute aufweist, werden andere Attributobjekte ähnlich konstruiert. GetCustomAttributes gibt dann das Author Objekt und alle anderen Attributobjekte in einem Array zurück. Anschließend können Sie dieses Array durchlaufen, bestimmen, welche Attribute basierend auf dem Typ jedes Arrayelements angewendet wurden, und Informationen aus den Attributobjekten extrahieren.

Hier ist ein vollständiges Beispiel. Ein benutzerdefiniertes Attribut wird definiert, auf mehrere Entitäten angewendet und über Spiegelung abgerufen.

// Multiuse attribute.
[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct,
                       AllowMultiple = true)  // Multiuse attribute.
]
public class AuthorAttribute : System.Attribute
{
    string Name;
    public double Version;

    public AuthorAttribute(string name)
    {
        Name = name;

        // Default value.
        Version = 1.0;
    }

    public string GetName() => 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
{
    public 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 {t}");

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

        // Displaying output.
        foreach (System.Attribute attr in attrs)
        {
            if (attr is AuthorAttribute a)
            {
                System.Console.WriteLine($"   {a.GetName()}, version {a.Version:f}");
            }
        }
    }
}
/* 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