CKTIS / C#
Eigenschaftsattribute: AttributeUsage und Auswahl mit BindingFlags
Lege fest, wo ein Attribut zulässig ist, wähle öffentliche Instanzeigenschaften aus und unterscheide direkt angewendete von geerbten Attributen.
Version: C# 12 and .NET 8; later runtimes may add compatible features
Syntax
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(...)] ist die Kurzschreibweise für System.AttributeUsageAttribute an einer von System.Attribute abgeleiteten Attributklasse. AttributeTargets.Property erlaubt das Attribut an einer Eigenschaft unabhängig von ihrer Sichtbarkeit und davon, ob sie statisch ist. Es gilt weder für eine Zugriffsmethode noch für ein zugrunde liegendes Feld. ValidOn gibt die zulässigen Ziele an. AllowMultiple (Standard false) bestimmt, ob das Attribut auf derselben Deklaration mehrfach stehen darf; Inherited (Standard true) bestimmt, ob eine überschreibende Eigenschaft es erben kann.
Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) verwendet Flags aus System.Reflection und liefert ein PropertyInfo[], keine Eigenschaftswerte. Für die Reflexion ist eine Eigenschaft öffentlich, wenn mindestens eine Zugriffsmethode öffentlich ist. | ist das bitweise ODER: Die Überladung mit Flags benötigt mindestens je ein Flag aus Public/NonPublic und Instance/Static. DeclaredOnly schließt geerbte Eigenschaften aus der Liste aus, steuert aber nicht die anschließende Attributsuche.
property.GetCustomAttribute<T>(inherit: ...) ist eine Erweiterungsmethode aus System.Reflection.CustomAttributeExtensions für MemberInfo, die Basisklasse von PropertyInfo, und keine Instanzmethode von PropertyInfo. T muss von Attribute abgeleitet sein. Das nicht generische Gegenstück ist die statische Methode Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false prüft nur die angegebene Eigenschaft; true durchsucht auch die Kette der überschriebenen Eigenschaften, sofern das Attribut vererbbar ist. Die Instanzmethode MemberInfo.GetCustomAttributes(..., inherit) ignoriert inherit bei Eigenschaften.
Ohne Treffer lautet das Ergebnis null; mehr als ein Treffer löst AmbiguousMatchException aus. Wenn mehrere Treffer zu erwarten sind, verwende die Erweiterung GetCustomAttributes<T>(inherit: ...). Beim Abrufen einer Attributinstanz kann ihr Konstruktor ausgeführt werden. Für die gespeicherten Argumente ohne Instanziierung eignet sich CustomAttributeData; es sucht nicht nach geerbten Attributen.
Beispiele
#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 => "";
}Ergebnis
Usage: Property, AllowMultiple=False, Inherited=True Code: direct=-; with inheritance=- Name: direct=-; with inheritance=base
Das Programm liest zuerst die Verwendungsregeln von `LabelAttribute` und gibt dann die Eigenschaften in ordinaler Namensreihenfolge aus. `Code` hat kein Label; die überschreibende Eigenschaft `Name` findet `base` nur mit `inherit: true`. Die markierten Eigenschaften `Hidden` und `Kind` passieren den Filter nicht.
Zugehörige Lektionen
- C# · Lektion 24 · Fortgeschritten · Version: 3
Quellen
- AttributeUsageAttribute Class (System)
- AttributeTargets Enum (System)
- Attributes - C# language specification
- BindingFlags Enum (System.Reflection)
- Type.GetProperties Method (System)
- CustomAttributeExtensions.GetCustomAttribute Method (System.Reflection)
- CustomAttributeExtensions.GetCustomAttributes Method (System.Reflection)
- Attribute.GetCustomAttribute Method (System)
- MemberInfo.GetCustomAttributes Method (System.Reflection)
- CustomAttributeData Class (System.Reflection)