Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

AttributeUsageAttribute — reguły używania własnych atrybutów

AttributeUsageAttribute określa, gdzie wolno stosować własny atrybut, czy można go powtarzać i czy jest dziedziczony. AttributeTargets.Property ogranicza jego użycie do właściwości.

Wersja: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Składnia

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]

System.AttributeUsageAttribute, zapisywany jako [AttributeUsage(...)], umieszcza się na klasie własnego atrybutu dziedziczącej po Attribute. Określa on zasady stosowania tego atrybutu, a nie zachowanie oznaczonych nim obiektów.

Argument konstruktora typu AttributeTargets ustala odczytywaną właściwość ValidOn. To wyliczenie flagowe: cele można łączyć operatorem |, np. AttributeTargets.Property | AttributeTargets.Field. Samo AttributeTargets.Property zezwala na oznaczanie właściwości, nie pól ani metod dostępowych get i set. Niedozwolony cel powoduje błąd kompilacji.

AllowMultiple określa, czy dany atrybut można umieścić wielokrotnie na jednym elemencie; domyślnie wynosi false. Inherited określa dziedziczenie atrybutu przez klasy pochodne i przesłaniające składowe; domyślnie wynosi true. Nie oznacza to dziedziczenia samej klasy atrybutu. Domyślne reguły bez jawnego ograniczenia odpowiadają AttributeTargets.All, AllowMultiple = false, Inherited = true.

W przykładzie LabelAttribute może wystąpić tylko raz na właściwości i nie jest dziedziczony. [Label("Product name")] zapisuje metadane na Name; kod odczytuje je przez refleksję. Sam atrybut nie sprawdza wartości właściwości. Użyte API jest dostępne w .NET 10; przykład nie wymaga funkcji języka w wersji preview.

Przykłady

using System;

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
public sealed class LabelAttribute : Attribute
{
    public LabelAttribute(string text) => Text = text;
    public string Text { get; }
}

public sealed class Product
{
    [Label("Product name")]
    public string Name { get; set; } = "";
}

public static class Program
{
    public static void Main()
    {
        var property = typeof(Product).GetProperty(nameof(Product.Name))!;
        var label = (LabelAttribute)Attribute.GetCustomAttribute(
            property, typeof(LabelAttribute))!;
        Console.WriteLine(label.Text);
    }
}

Wynik

Product name

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła