CKTIS / C#
Atributos de propriedades: AttributeUsage e seleção com BindingFlags
Declara onde é permitido aplicar um atributo, seleciona propriedades públicas de instância e distingue atributos aplicados diretamente de atributos herdados.
Versão: C# 12 and .NET 8; later runtimes may add compatible features
Sintaxe
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(...)] é a forma abreviada de System.AttributeUsageAttribute numa classe de atributo derivada de System.Attribute. AttributeTargets.Property permite aplicar o atributo a uma propriedade, independentemente da sua visibilidade ou de ser estática. O alvo não é um método de acesso nem um campo de suporte. ValidOn indica os alvos permitidos. AllowMultiple (false por predefinição) indica se o atributo pode repetir-se na mesma declaração; Inherited (true por predefinição) indica se uma propriedade que redefine outra pode herdá-lo.
Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) usa sinalizadores de System.Reflection e devolve um PropertyInfo[], não os valores das propriedades. Para a reflexão, uma propriedade é pública se tiver pelo menos um método de acesso público. | é o OU bit a bit: a sobrecarga com sinalizadores exige pelo menos um de Public/NonPublic e um de Instance/Static. Acrescentar DeclaredOnly exclui as propriedades herdadas da lista, mas não altera a pesquisa posterior de atributos.
property.GetCustomAttribute<T>(inherit: ...) é um método de extensão de System.Reflection.CustomAttributeExtensions para MemberInfo, a classe base de PropertyInfo; não é um método de instância de PropertyInfo. T tem de derivar de Attribute. O equivalente não genérico é o método estático Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false examina apenas a propriedade indicada; true percorre também a cadeia de redefinições se o atributo puder ser herdado. O método de instância MemberInfo.GetCustomAttributes(..., inherit) ignora inherit no caso das propriedades.
Sem correspondências, o resultado é null; se houver mais do que uma, é lançada AmbiguousMatchException. Se esperares várias correspondências, usa a extensão GetCustomAttributes<T>(inherit: ...). Obter uma instância do atributo pode executar o seu construtor. Para consultar os argumentos registados sem criar a instância, usa CustomAttributeData, que não procura atributos herdados.
Exemplos
#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 => "";
}Resultado
Usage: Property, AllowMultiple=False, Inherited=True Code: direct=-; with inheritance=- Name: direct=-; with inheritance=base
O programa lê primeiro as regras de utilização de `LabelAttribute` e depois apresenta as propriedades por ordem ordinal do nome. `Code` não tem etiqueta e a redefinição de `Name` só encontra `base` com `inherit: true`. As propriedades etiquetadas `Hidden` e `Kind` não passam no filtro.
Lições relacionadas
- C# · Lição 24 · Avançado · Versão: 3
Fontes
- 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)