Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

GetCustomAttribute<T> — odczyt pojedynczego atrybutu

CustomAttributeExtensions.GetCustomAttribute<T> odczytuje przez refleksję pojedynczy atrybut typu T. Poznaj dostępne obiekty docelowe, obsługę null i sytuację, w której wiele dopasowań powoduje wyjątek.

Wersja: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Składnia

public static T? GetCustomAttribute<T>(this System.Reflection.MemberInfo element, bool inherit) where T : Attribute;

CustomAttributeExtensions.GetCustomAttribute<T> z System.Reflection udostępnia metody rozszerzające dla MemberInfo, ParameterInfo, Assembly i Module. Typem T może być sam System.Attribute albo dowolny typ po nim dziedziczący. Import using System.Reflection; umożliwia zapis element.GetCustomAttribute<T>(); dla typu można użyć typeof(Report).

Wynikiem jest pasujący atrybut typu T albo null, gdy go nie znaleziono. Wiele dopasowań powoduje AmbiguousMatchException, a nie wybór pierwszego wyniku. Wywołanie GetCustomAttribute<Attribute> jest poprawne i również zgłasza ten wyjątek, jeśli pasuje więcej niż jeden atrybut. Gdy oczekujesz wielu atrybutów, użyj GetCustomAttributes<T>. Argument element równy null powoduje ArgumentNullException.

Przeciążenia dla MemberInfo i ParameterInfo przyjmują także bool inherit. Wartość false ogranicza wyszukiwanie do atrybutów zastosowanych bezpośrednio do elementu, a true uwzględnia dziedziczenie tylko tam, gdzie dany element je obsługuje. Parametr metody przesłaniającej może odziedziczyć atrybuty z odpowiadającego mu parametru metody bazowej, ale parametr konstruktora nie ma takiego łańcucha dziedziczenia. Atrybuty oznaczone Inherited = false nie są dziedziczone. W przykładzie inherit: false jawnie ogranicza wyszukiwanie; wynik Monthly pochodzi z LabelAttribute przypisanego do Report.

Przykłady

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 { }

Wynik

Monthly

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła