CKTIS / C#
Atributy vlastností: AttributeUsage a výběr pomocí BindingFlags
Určete, kde lze atribut použít, vyberte veřejné instanční vlastnosti a rozlište přímo použité atributy od atributů nalezených děděním.
Verze: C# 12 and .NET 8; later runtimes may add compatible features
Syntaxe
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(...)] je zkrácený zápis atributu System.AttributeUsageAttribute na třídě atributu odvozené od System.Attribute. AttributeTargets.Property dovoluje použít atribut na vlastnosti bez ohledu na její viditelnost nebo na to, zda je statická. Cílem není přístupová metoda ani podkladové pole. ValidOn udává povolené cíle. AllowMultiple (výchozí hodnota false) určuje, zda se atribut smí na jedné deklaraci opakovat; Inherited (výchozí hodnota true) určuje, zda jej přepisující vlastnost může zdědit.
Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) používá příznaky z System.Reflection a vrací pole PropertyInfo[], nikoli hodnoty vlastností. Při reflexi je vlastnost veřejná, pokud je veřejná alespoň jedna její přístupová metoda. | je bitové NEBO: přetížení s příznaky vyžaduje alespoň jeden příznak z dvojice Public/NonPublic a jeden z dvojice Instance/Static. Přidáním DeclaredOnly vyloučíte zděděné vlastnosti ze seznamu, nikoli z následného hledání atributů.
property.GetCustomAttribute<T>(inherit: ...) je rozšiřující metoda z System.Reflection.CustomAttributeExtensions pro MemberInfo, základní třídu PropertyInfo; nejde o instanční metodu PropertyInfo. T musí být odvozeno od Attribute. Negenerickou obdobou je statická metoda Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false zkoumá pouze zadanou vlastnost; true prohledá také řetězec přepsaných vlastností, pokud je atribut děditelný. Instanční metoda MemberInfo.GetCustomAttributes(..., inherit) parametr inherit u vlastností ignoruje.
Pokud není nalezena shoda, výsledkem je null; více shod vyvolá AmbiguousMatchException. Očekáváte-li více shod, použijte rozšíření GetCustomAttributes<T>(inherit: ...). Při získání instance atributu se může spustit její konstruktor. Chcete-li číst pouze uložené argumenty bez vytvoření instance, použijte CustomAttributeData, které zděděné atributy nevyhledává.
Příklady
#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 => "";
}Výsledek
Usage: Property, AllowMultiple=False, Inherited=True Code: direct=-; with inheritance=- Name: direct=-; with inheritance=base
Program nejprve načte pravidla použití `LabelAttribute` a potom vypíše vlastnosti v ordinálním pořadí podle názvu. `Code` nemá štítek a přepisující vlastnost `Name` najde `base` pouze s `inherit: true`. Označené vlastnosti `Hidden` a `Kind` filtrem neprojdou.
Související lekce
- C# · Lekce 24 · Pokročilá · Verze: 3
Zdroje
- 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)