Как создать атрибут в C#?

Создание пользовательских атрибутов в C#

Что такое атрибуты в C#?

Атрибуты — это мощный механизм метапрограммирования в C#, который позволяет добавлять декларативные метаданные к элементам программы (классам, методам, свойствам, параметрам и т.д.). Атрибуты предоставляют дополнительную информацию о типах и членах, которая может быть извлечена во время выполнения с помощью рефлексии.

Базовый синтаксис создания атрибута

Для создания пользовательского атрибута необходимо объявить класс, унаследованный от базового класса System.Attribute. По соглашению, имя класса должно заканчиваться суффиксом "Attribute".

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, 
                AllowMultiple = false, 
                Inherited = true)]
public class CustomAttribute : Attribute
{
    public string Description { get; }
    public int Priority { get; set; }
    
    public CustomAttribute(string description)
    {
        Description = description;
        Priority = 1;
    }
}

Ключевые аспекты создания атрибутов

1. Атрибут AttributeUsage

Этот атрибут применяется к вашему классу атрибута и определяет:

• AttributeTargets — элементы программы, к которым можно применять атрибут (классы, методы, свойства, параметры и т.д.)
• AllowMultiple — разрешено ли многократное применение атрибута к одному элементу
• Inherited — наследуется ли атрибут производными классами/переопределенными методами

// Пример с различными настройками
[AttributeUsage(AttributeTargets.Class | 
                AttributeTargets.Method | 
                AttributeTargets.Property,
                AllowMultiple = true,
                Inherited = false)]
public class MultiUseAttribute : Attribute
{
    public string Name { get; }
    
    public MultiUseAttribute(string name)
    {
        Name = name;
    }
}

2. Конструкторы и свойства

Атрибуты могут иметь конструкторы с обязательными параметрами и свойства для необязательных параметров:

public class ValidationAttribute : Attribute
{
    // Обязательный параметр через конструктор
    public int MaxLength { get; }
    
    // Необязательный параметр через свойство
    public int MinLength { get; set; }
    public bool Required { get; set; }
    
    public ValidationAttribute(int maxLength)
    {
        MaxLength = maxLength;
        MinLength = 0;
        Required = true;
    }
}

Практический пример применения атрибута

Создание атрибута для логирования

[AttributeUsage(AttributeTargets.Method)]
public class LogExecutionAttribute : Attribute
{
    public string Level { get; set; } = "Information";
    public bool LogParameters { get; set; } = true;
    
    public LogExecutionAttribute() { }
}

// Применение атрибута
public class DataService
{
    [LogExecution(Level = "Debug", LogParameters = false)]
    public void ProcessData(string input)
    {
        // Реализация метода
    }
    
    [LogExecution]
    public void SaveData(object data)
    {
        // Реализация метода
    }
}

Создание атрибута для валидации

[AttributeUsage(AttributeTargets.Property)]
public class RangeValidationAttribute : Attribute
{
    public double Minimum { get; }
    public double Maximum { get; }
    
    public RangeValidationAttribute(double minimum, double maximum)
    {
        Minimum = minimum;
        Maximum = maximum;
    }
}

// Использование атрибута
public class Product
{
    [RangeValidation(0.01, 10000)]
    public decimal Price { get; set; }
    
    [RangeValidation(1, 5)]
    public int Rating { get; set; }
}

Извлечение атрибутов с помощью рефлексии

Создание атрибутов — только половина дела. Для их использования необходимо извлекать информацию во время выполнения:

public class AttributeProcessor
{
    public static void ProcessAttributes(Type type)
    {
        // Получение атрибутов класса
        var classAttributes = type.GetCustomAttributes(typeof(CustomAttribute), false);
        
        foreach (CustomAttribute attr in classAttributes)
        {
            Console.WriteLine($"Class attribute: {attr.Description}, Priority: {attr.Priority}");
        }
        
        // Получение атрибутов методов
        foreach (var method in type.GetMethods())
        {
            var methodAttributes = method.GetCustomAttributes(typeof(LogExecutionAttribute), false);
            
            foreach (LogExecutionAttribute attr in methodAttributes)
            {
                Console.WriteLine($"Method {method.Name} has log level: {attr.Level}");
            }
        }
    }
}

// Использование
AttributeProcessor.ProcessAttributes(typeof(DataService));

Расширенный пример: атрибут для кэширования

[AttributeUsage(AttributeTargets.Method)]
public class CacheAttribute : Attribute
{
    public int DurationSeconds { get; }
    public string CacheKeyPrefix { get; set; } = "";
    
    public CacheAttribute(int durationSeconds)
    {
        DurationSeconds = durationSeconds;
    }
}

// Аспектно-ориентированное применение через интерцепцию
public class CacheInterceptor
{
    public T ExecuteCached<T>(Func<T> method, CacheAttribute attribute, string methodName)
    {
        string cacheKey = $"{attribute.CacheKeyPrefix}_{methodName}";
        
        // Проверка кэша
        if (Cache.TryGetValue(cacheKey, out T cachedValue))
            return cachedValue;
        
        // Выполнение метода
        var result = method();
        
        // Сохранение в кэш
        Cache.Set(cacheKey, result, TimeSpan.FromSeconds(attribute.DurationSeconds));
        
        return result;
    }
}

Рекомендации и лучшие практики

• Именование: Всегда используйте суффикс "Attribute" в имени класса
• Неизменяемость: Старайтесь делать атрибуты неизменяемыми после создания
• Производительность: Кэшируйте результаты рефлексии при частом доступе к атрибутам
• Сериализация: Убедитесь, что все свойства атрибута сериализуемы, если это необходимо
• Документация: Хорошо документируйте назначение и параметры атрибута

Заключение

Создание пользовательских атрибутов в C# — это мощная техника, которая позволяет реализовывать декларативное программирование, аспектно-ориентированные подходы и метапрограммирование. Атрибуты широко используются в таких фреймворках, как ASP.NET Core (маршрутизация, валидация), Entity Framework (конфигурация mapping) и многих других. Правильное использование атрибутов делает код более читаемым, поддерживаемым и расширяемым, позволяя отделить сквозную функциональность от бизнес-логики.