Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C#

GetCustomAttribute<T> — ler um único atributo

CustomAttributeExtensions.GetCustomAttribute<T> obtém, através de reflexão, um único atributo do tipo T. Saiba que destinos são suportados, como é tratado null e porque é que várias correspondências provocam uma exceção.

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

Sintaxe

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

CustomAttributeExtensions.GetCustomAttribute<T> em System.Reflection disponibiliza métodos de extensão para MemberInfo, ParameterInfo, Assembly e Module. T pode ser o próprio System.Attribute ou um tipo dele derivado. A importação using System.Reflection; permite escrever element.GetCustomAttribute<T>(); para um tipo, utilize typeof(Report).

O resultado é um atributo correspondente do tipo T ou null, caso não seja encontrado nenhum. Várias correspondências provocam AmbiguousMatchException, em vez de selecionar o primeiro resultado. Uma chamada a GetCustomAttribute<Attribute> é válida e também lança esta exceção se encontrar mais do que um atributo correspondente. Se espera vários atributos, utilize GetCustomAttributes<T>. Se o argumento element for null, é lançada uma ArgumentNullException.

As sobrecargas para MemberInfo e ParameterInfo também aceitam bool inherit. Com false, a pesquisa limita-se aos atributos aplicados diretamente ao elemento. Com true, a pesquisa tem em conta a herança apenas se o elemento a suportar. Um parâmetro de um método que substitui um método base pode herdar atributos do parâmetro correspondente do método base, mas um parâmetro de um construtor não tem uma cadeia de herança desse tipo. Os atributos marcados com Inherited = false não são herdados. O exemplo limita explicitamente a pesquisa com inherit: false; o resultado Monthly provém de LabelAttribute, aplicado a Report.

Exemplos

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

Resultado

Monthly

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes