Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / C#

Atribúty vlastností: AttributeUsage a výber pomocou BindingFlags

Urči, kde sa atribút smie použiť, vyber verejné inštančné vlastnosti a rozlíš priamo použité atribúty od atribútov nájdených dedením.

Verzia: C# 12 and .NET 8; later runtimes may add compatible features

Syntax

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 skrátený zápis atribútu System.AttributeUsageAttribute na triede atribútu odvodenej od System.Attribute. AttributeTargets.Property dovoľuje použiť atribút na vlastnosti bez ohľadu na jej viditeľnosť alebo na to, či je statická. Cieľom nie je prístupová metóda ani podkladové pole. ValidOn uvádza povolené ciele. AllowMultiple (predvolene false) určuje, či sa atribút môže opakovať na tej istej deklarácii; Inherited (predvolene true) určuje, či ho prepisujúca vlastnosť môže zdediť.

Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) používa príznaky z System.Reflection a vracia pole PropertyInfo[], nie hodnoty vlastností. Pri reflexii je vlastnosť verejná, ak je verejná aspoň jedna jej prístupová metóda. | je bitové ALEBO: preťaženie s príznakmi vyžaduje aspoň jeden príznak z dvojice Public/NonPublic a jeden z dvojice Instance/Static. Pridanie DeclaredOnly vylúči zdedené vlastnosti zo zoznamu, ale neriadi následné vyhľadávanie atribútov.

property.GetCustomAttribute<T>(inherit: ...) je rozširujúca metóda z System.Reflection.CustomAttributeExtensions pre MemberInfo, základnú triedu PropertyInfo; nie je to inštančná metóda PropertyInfo. T musí byť odvodené od Attribute. Negenerickým náprotivkom je statická metóda Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false kontroluje len zadanú vlastnosť; true prehľadá aj reťazec prepísaných vlastností, ak sa atribút môže dediť. Inštančná metóda MemberInfo.GetCustomAttributes(..., inherit) parameter inherit pri vlastnostiach ignoruje.

Ak sa nenájde zhoda, výsledkom je null; viac než jedna zhoda vyvolá AmbiguousMatchException. Ak očakávaš viac zhôd, použi rozšírenie GetCustomAttributes<T>(inherit: ...). Pri získaní inštancie atribútu sa môže spustiť jej konštruktor. Na čítanie uložených argumentov bez vytvorenia inštancie použi CustomAttributeData, ktoré zdedené atribúty nevyhľadáva.

Prí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ýsledok

Usage: Property, AllowMultiple=False, Inherited=True
Code: direct=-; with inheritance=-
Name: direct=-; with inheritance=base

Program najprv načíta pravidlá použitia `LabelAttribute` a potom vypíše vlastnosti v ordinálnom poradí podľa názvu. `Code` nemá označenie a prepisujúca vlastnosť `Name` nájde `base` len s `inherit: true`. Označené vlastnosti `Hidden` a `Kind` filtrom neprejdú.

Súvisiace lekcie

  • C# · Lekcia 24 · Pokročilá · Verzia: 3

Zdroje