Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / C#

Atributos de propiedad: AttributeUsage y selección con BindingFlags

Declara dónde se permite un atributo, selecciona propiedades públicas de instancia y distingue los atributos aplicados directamente de los heredados.

Versión: C# 12 and .NET 8; later runtimes may add compatible features

Sintaxis

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(...)] es la forma abreviada de System.AttributeUsageAttribute en una clase de atributo derivada de System.Attribute. AttributeTargets.Property permite aplicar el atributo a una propiedad sin importar su visibilidad ni si es estática. No se aplica a un descriptor de acceso ni a un campo de respaldo. ValidOn indica los destinos permitidos. AllowMultiple (false por defecto) determina si el atributo puede repetirse en una misma declaración; Inherited (true por defecto) determina si puede heredarlo una propiedad que sobrescribe otra.

Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) usa marcas de System.Reflection y devuelve un PropertyInfo[], no los valores de las propiedades. Para la reflexión, una propiedad es pública si al menos uno de sus descriptores de acceso es público. | es el OR bit a bit: la sobrecarga con marcas requiere al menos una de Public/NonPublic y una de Instance/Static. Añadir DeclaredOnly excluye las propiedades heredadas de la lista; no controla la búsqueda posterior de atributos.

property.GetCustomAttribute<T>(inherit: ...) es un método de extensión de System.Reflection.CustomAttributeExtensions para MemberInfo, la clase base de PropertyInfo; no es un método de instancia de PropertyInfo. T debe derivar de Attribute. La alternativa no genérica es el método estático Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false examina solo esa propiedad; true también recorre la cadena de sobrescrituras si el atributo es heredable. El método de instancia MemberInfo.GetCustomAttributes(..., inherit) ignora inherit en las propiedades.

Si no hay coincidencias, el resultado es null; si hay más de una, se produce AmbiguousMatchException. Si esperas varias coincidencias, usa la extensión GetCustomAttributes<T>(inherit: ...). Obtener una instancia del atributo puede ejecutar su constructor. Para inspeccionar los argumentos registrados sin crear la instancia, usa CustomAttributeData, que no busca atributos heredados.

Ejemplos

#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

El programa lee primero las reglas de uso de `LabelAttribute` y después muestra las propiedades en orden ordinal por nombre. `Code` no tiene etiqueta y la sobrescritura de `Name` solo encuentra `base` con `inherit: true`. Las propiedades etiquetadas `Hidden` y `Kind` no pasan el filtro.

Lecciones relacionadas

  • C# · Lección 24 · Avanzado · Versión: 3

Fuentes