CKTIS / C#
Атрибути на свойства: AttributeUsage и избор чрез BindingFlags
Задай къде е позволен даден атрибут, избери публичните свойства на екземпляра и различи пряко приложените атрибути от наследените.
Версия: C# 12 and .NET 8; later runtimes may add compatible features
Синтаксис
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(...)] е съкратен запис на System.AttributeUsageAttribute върху клас на атрибут, производен на System.Attribute. AttributeTargets.Property позволява прилагане на атрибута върху свойство независимо от неговата видимост и от това дали е статично. Целта не е метод за достъп или поле за съхранение. ValidOn показва разрешените цели. AllowMultiple (по подразбиране false) определя дали атрибутът може да се повтори в една и съща декларация; Inherited (по подразбиране true) определя дали свойство, което предефинира друго, може да наследи атрибута.
Type.GetProperties(BindingFlags.Public | BindingFlags.Instance) използва флагове от System.Reflection и връща масив PropertyInfo[], а не стойностите на свойствата. За рефлексията свойството е публично, ако поне един от методите му за достъп е публичен. | е побитово ИЛИ: претоварването с флагове изисква поне един от Public/NonPublic и един от Instance/Static. Добавянето на DeclaredOnly изключва наследените свойства от списъка, но не управлява последващото търсене на атрибути.
property.GetCustomAttribute<T>(inherit: ...) е метод за разширение от System.Reflection.CustomAttributeExtensions за MemberInfo, базовия клас на PropertyInfo; не е екземплярен метод на PropertyInfo. T трябва да е производен на Attribute. Необобщеният еквивалент е статичният метод Attribute.GetCustomAttribute(property, typeof(T), inherit). inherit: false проверява само посоченото свойство; true претърсва и веригата от предефинирани свойства, ако атрибутът може да се наследява. Екземплярният метод MemberInfo.GetCustomAttributes(..., inherit) пренебрегва inherit при свойства.
При липса на съвпадение резултатът е null; повече от едно съвпадение води до AmbiguousMatchException. Ако очакваш няколко съвпадения, използвай разширението GetCustomAttributes<T>(inherit: ...). Извличането на екземпляр на атрибута може да изпълни неговия конструктор. За преглед на записаните аргументи без създаване на екземпляр използвай CustomAttributeData, който не търси наследени атрибути.
Примери
#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 => "";
}Резултат
Usage: Property, AllowMultiple=False, Inherited=True Code: direct=-; with inheritance=- Name: direct=-; with inheritance=base
Програмата първо прочита правилата за използване на `LabelAttribute`, след което извежда свойствата по имена чрез ординално сравнение. `Code` няма етикет, а предефинираното свойство `Name` намира `base` само с `inherit: true`. Маркираните свойства `Hidden` и `Kind` не преминават през филтъра.
Свързани уроци
- C# · Урок 24 · Напреднало · Версия: 3
Източници
- 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)