KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / C#

Eigenschapsattributen: AttributeUsage en selectie met BindingFlags

Leg vast waar een attribuut is toegestaan, selecteer openbare instantie-eigenschappen en onderscheid direct toegepaste attributen van overgeërfde attributen.

Versie: 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(...)] is de verkorte schrijfwijze van System.AttributeUsageAttribute op een attribuutklasse die van System.Attribute is afgeleid. AttributeTargets.Property staat toepassing op een eigenschap toe, ongeacht de zichtbaarheid of de vraag of de eigenschap statisch is. Het doel is geen accessor of achterliggend veld. ValidOn geeft de toegestane doelen aan. AllowMultiple (standaard false) bepaalt of het attribuut meermaals op dezelfde declaratie mag staan; Inherited (standaard true) bepaalt of een overschrijvende eigenschap het kan erven.

Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) gebruikt vlaggen uit System.Reflection en retourneert een PropertyInfo[], niet de waarden van de eigenschappen. Voor reflectie is een eigenschap openbaar als minstens één accessor openbaar is. | is bitsgewijze OF: de overload met vlaggen vereist minstens één vlag uit Public/NonPublic en één uit Instance/Static. Met DeclaredOnly sluit je geërfde eigenschappen uit de lijst uit; die vlag stuurt de latere zoekactie naar attributen niet.

property.GetCustomAttribute<T>(inherit: ...) is een extensiemethode uit System.Reflection.CustomAttributeExtensions voor MemberInfo, de basisklasse van PropertyInfo; het is geen instantiemethode van PropertyInfo. T moet zijn afgeleid van Attribute. De niet-generieke tegenhanger is de statische methode Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false controleert alleen de opgegeven eigenschap; true doorzoekt ook de keten van overschreven eigenschappen als het attribuut overerfbaar is. De instantiemethode MemberInfo.GetCustomAttributes(..., inherit) negeert inherit bij eigenschappen.

Zonder overeenkomst krijg je null; bij meer dan één overeenkomst wordt AmbiguousMatchException gegenereerd. Verwacht je meerdere overeenkomsten, gebruik dan de extensiemethode GetCustomAttributes<T>(inherit: ...). Het ophalen van een attribuutinstantie kan de constructor uitvoeren. Gebruik CustomAttributeData om de opgeslagen argumenten zonder instantiëring te bekijken; het zoekt niet naar overgeërfde attributen.

Voorbeelden

#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 => "";
}

Resultaat

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

Het programma leest eerst de gebruiksregels van `LabelAttribute` en toont daarna de eigenschappen in ordinale volgorde op naam. `Code` heeft geen label en de overschrijvende eigenschap `Name` vindt `base` alleen met `inherit: true`. De gemarkeerde eigenschappen `Hidden` en `Kind` vallen buiten het filter.

Gerelateerde lessen

  • C# · Les 24 · Gevorderd · Versie: 3

Bronnen