Partager via

Accéder à des attributs à l’aide de la réflexion

Le fait que vous pouvez définir des attributs personnalisés et les placer dans votre code source serait de peu de valeur sans aucun moyen de récupérer ces informations et d’agir dessus. En utilisant la réflexion, vous pouvez récupérer les informations qui ont été définies avec des attributs personnalisés. La méthode clé est GetCustomAttributes, qui retourne un tableau d’objets qui sont les équivalents au moment de l’exécution des attributs de code source. Cette méthode comporte de nombreuses versions surchargées. Pour plus d’informations, consultez Attribute.

Spécification d’attribut, par exemple :

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

est conceptuellement équivalent au code suivant :

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

Toutefois, le code n’est pas exécuté tant qu’il SampleClass n’est pas interrogé pour les attributs. L'appel de GetCustomAttributes sur SampleClass provoque la construction et l'initialisation d'un objet Author. Si la classe a d’autres attributs, d’autres objets d’attribut sont construits de la même façon. GetCustomAttributes retourne ensuite l’objet Author et tous les autres objets d’attribut dans un tableau. Vous pouvez ensuite itérer sur ce tableau, déterminer quels attributs ont été appliqués en fonction du type de chaque élément de tableau et extraire des informations des objets d’attribut.

Voici un exemple complet. Un attribut personnalisé est défini, appliqué à plusieurs entités et récupéré via la réflexion.

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

Voir aussi