CKTIS / C#
GetCustomAttribute<T> — ein einzelnes Attribut auslesen
CustomAttributeExtensions.GetCustomAttribute<T> ruft mithilfe von Reflection ein einzelnes Attribut des Typs T ab. Erfahre, welche Ziele unterstützt werden, wie null behandelt wird und warum mehrere Treffer eine Ausnahme auslösen.
Version: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Syntax
public static T? GetCustomAttribute<T>(this System.Reflection.MemberInfo element, bool inherit) where T : Attribute;CustomAttributeExtensions.GetCustomAttribute<T> in System.Reflection stellt Erweiterungsmethoden für MemberInfo, ParameterInfo, Assembly und Module bereit. T kann System.Attribute selbst oder ein davon abgeleiteter Typ sein. Mit using System.Reflection; kannst du element.GetCustomAttribute<T>() schreiben; für einen Typ verwendest du typeof(Report).
Das Ergebnis ist ein passendes Attribut des Typs T oder null, wenn keines gefunden wird. Bei mehreren Treffern wird AmbiguousMatchException ausgelöst, statt das erste Ergebnis auszuwählen. Ein Aufruf von GetCustomAttribute<Attribute> ist zulässig und löst diese Ausnahme ebenfalls aus, wenn mehr als ein Attribut gefunden wird. Wenn du mehrere Attribute erwartest, verwende GetCustomAttributes<T>. Ist das Argument element gleich null, wird ArgumentNullException ausgelöst.
Überladungen für MemberInfo und ParameterInfo akzeptieren außerdem bool inherit. false beschränkt die Suche auf Attribute, die direkt auf das Ziel angewendet wurden. true berücksichtigt die Vererbung nur, wenn das Ziel sie unterstützt. Ein Parameter einer überschreibenden Methode kann Attribute vom entsprechenden Parameter der Basismethode erben. Bei einem Konstruktorparameter gibt es keine solche Vererbungskette. Attribute mit Inherited = false werden nicht vererbt. Das Beispiel begrenzt die Suche ausdrücklich mit inherit: false; das Ergebnis Monthly stammt von dem auf Report angewendeten LabelAttribute.
Beispiele
using System;
using System.Reflection;
LabelAttribute? label = typeof(Report)
.GetCustomAttribute<LabelAttribute>(inherit: false);
Console.WriteLine(label?.Text ?? "missing");
[AttributeUsage(AttributeTargets.Class)]
public sealed class LabelAttribute : Attribute
{
public LabelAttribute(string text) => Text = text;
public string Text { get; }
}
[Label("Monthly")]
public sealed class Report { }
Ergebnis
Monthly
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.