Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

Atrybuty właściwości: AttributeUsage i wybór przez BindingFlags

Zadeklaruj, gdzie wolno stosować atrybut, wybierz publiczne właściwości instancji i odczytaj atrybut bezpośrednio lub z uwzględnieniem dziedziczenia.

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

Składnia

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(...)] to skrócony zapis System.AttributeUsageAttribute umieszczanego na klasie atrybutu, która dziedziczy po System.Attribute. AttributeTargets.Property zezwala na użycie atrybutu na właściwości, niezależnie od jej widoczności i od tego, czy jest statyczna. Nie oznacza akcesora ani pola zapasowego. ValidOn zwraca dozwolone cele. AllowMultiple (domyślnie false) określa, czy atrybut można powtórzyć na tej samej deklaracji, a Inherited (domyślnie true) — czy atrybut może zostać odziedziczony przy przesłonięciu właściwości.

Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) używa flag z System.Reflection i zwraca tablicę PropertyInfo[], a nie wartości właściwości. Właściwość jest publiczna dla refleksji, gdy przynajmniej jeden akcesor jest publiczny. Operator | to bitowe LUB: przeciążenie z flagami wymaga przynajmniej jednej flagi z pary Public/NonPublic i jednej z pary Instance/Static. Dodanie DeclaredOnly wyklucza odziedziczone właściwości z listy, ale nie steruje późniejszym wyszukiwaniem atrybutów.

property.GetCustomAttribute<T>(inherit: ...) to metoda rozszerzająca z System.Reflection.CustomAttributeExtensions dla MemberInfo, po którym dziedziczy PropertyInfo; nie jest to metoda instancyjna PropertyInfo. T musi dziedziczyć po Attribute. Niegenericznym odpowiednikiem jest statyczne Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false sprawdza tylko wskazaną właściwość; true uwzględnia też łańcuch przesłonięć, o ile atrybut można dziedziczyć. Instancyjna metoda MemberInfo.GetCustomAttributes(..., inherit) ignoruje inherit dla właściwości.

Brak dopasowania daje null, a więcej niż jedno dopasowanie powoduje AmbiguousMatchException. Jeśli oczekujesz wielu wyników, użyj rozszerzenia GetCustomAttributes<T>(inherit: ...). Odczyt instancji atrybutu może wykonać jego konstruktor; do odczytu samych zapisanych argumentów bez tworzenia instancji służy CustomAttributeData, które nie wyszukuje atrybutów odziedziczonych.

Przykłady

#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 => "";
}

Wynik

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

Program najpierw odczytuje reguły użycia `LabelAttribute`, a następnie wypisuje właściwości w porządku porównania `Ordinal`. `Code` nie ma etykiety, a przesłonięta właściwość `Name` znajduje `base` tylko przy `inherit: true`. Oznaczone właściwości `Hidden` i `Kind` nie przechodzą filtra.

Powiązane lekcje

  • C# · Lekcja 24 · Zaawansowany · Wersja: 3

Źródła