Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / C#

Attributs de propriété : AttributeUsage et sélection avec BindingFlags

Déclarez où un attribut est autorisé, sélectionnez les propriétés d’instance publiques et distinguez les attributs appliqués directement des attributs hérités.

Version : C# 12 and .NET 8; later runtimes may add compatible features

Syntaxe

using System;
using System.Reflection;

// Model is the type to inspect.
PropertyInfo[] properties = typeof(Model).GetProperties(BindingFlags.Public | BindingFlags.Instance);
foreach (PropertyInfo property in properties)
{
    LabelAttribute? label = property.GetCustomAttribute<LabelAttribute>(inherit: false);
}

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
sealed class LabelAttribute : Attribute { }

[AttributeUsage(...)] est la forme abrégée de System.AttributeUsageAttribute, appliqué à une classe d’attribut dérivée de System.Attribute. AttributeTargets.Property autorise l’attribut sur une propriété, quels que soient sa visibilité et son caractère statique ou non. La cible n’est ni un accesseur ni un champ de stockage. ValidOn indique les cibles autorisées. AllowMultiple (false par défaut) indique si l’attribut peut figurer plusieurs fois sur la même déclaration ; Inherited (true par défaut) indique si une propriété qui en redéfinit une autre peut en hériter.

Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) utilise des indicateurs de System.Reflection et renvoie un tableau PropertyInfo[], pas les valeurs des propriétés. Pour la réflexion, une propriété est publique si au moins un accesseur est public. | est un OU bit à bit : la surcharge avec indicateurs exige au moins un indicateur dans chacun des couples Public/NonPublic et Instance/Static. Ajouter DeclaredOnly exclut les propriétés héritées de la liste, sans modifier la recherche d’attributs qui suit.

property.GetCustomAttribute<T>(inherit: ...) est une méthode d’extension de System.Reflection.CustomAttributeExtensions pour MemberInfo, la classe de base de PropertyInfo ; ce n’est pas une méthode d’instance de PropertyInfo. T doit dériver de Attribute. L’équivalent non générique est la méthode statique Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false examine uniquement la propriété indiquée ; true remonte aussi la chaîne des redéfinitions si l’attribut est héritable. La méthode d’instance MemberInfo.GetCustomAttributes(..., inherit) ignore inherit pour les propriétés.

En l’absence de correspondance, le résultat est null ; plusieurs correspondances déclenchent AmbiguousMatchException. Si plusieurs résultats sont possibles, utilisez l’extension GetCustomAttributes<T>(inherit: ...). Récupérer une instance d’attribut peut exécuter son constructeur. Pour lire les arguments enregistrés sans créer d’instance, utilisez CustomAttributeData, qui ne recherche pas les attributs hérités.

Exemples

#nullable enable
using System;
using System.Linq;
using System.Reflection;

var usage = typeof(LabelAttribute).GetCustomAttribute<AttributeUsageAttribute>(inherit: false)
    ?? throw new InvalidOperationException("Missing attribute usage metadata.");
Console.WriteLine($"Usage: {usage.ValidOn}, AllowMultiple={usage.AllowMultiple}, Inherited={usage.Inherited}");

foreach (PropertyInfo property in typeof(Item)
    .GetProperties(BindingFlags.Public | BindingFlags.Instance)
    .OrderBy(p => p.Name, StringComparer.Ordinal))
{
    var direct = property.GetCustomAttribute<LabelAttribute>(inherit: false);
    var withInheritance = property.GetCustomAttribute<LabelAttribute>(inherit: true);
    Console.WriteLine($"{property.Name}: direct={direct?.Text ?? "-"}; with inheritance={withInheritance?.Text ?? "-"}");
}

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
sealed class LabelAttribute : Attribute
{
    public LabelAttribute(string text) => Text = text;
    public string Text { get; }
}

class BaseItem
{
    [Label("base")]
    public virtual string Name => "";
}

sealed class Item : BaseItem
{
    public override string Name => "";
    public string Code { get; private set; } = "";

    [Label("private")]
    private string Hidden => "";

    [Label("static")]
    public static string Kind => "";
}

Résultat

Usage: Property, AllowMultiple=False, Inherited=True
Code: direct=-; with inheritance=-
Name: direct=-; with inheritance=base

Le programme lit d’abord les règles d’utilisation de `LabelAttribute`, puis affiche les propriétés dans l’ordre ordinal de leur nom. `Code` n’a pas de libellé, et la redéfinition de `Name` ne trouve `base` qu’avec `inherit: true`. Les propriétés annotées `Hidden` et `Kind` sont exclues par le filtre.

Leçons associées

  • C# · Leçon 24 · Avancé · Version : 3

Sources