Доступ к атрибутам через отражение (Руководство по программированию в C#)

Статья
11/05/2008

Обновлен: Ноябрь 2007

Факт возможности определения настраиваемых атрибутов и их помещения в собственный исходный код не будет настолько значимым без определенного способа извлечения этих сведений и работы с ними. В языке C# имеется система отражения, позволяющая извлекать сведения, определенные с настраиваемыми атрибутами. Основным методом выступает GetCustomAttributes, который возвращает массив объектов, являющихся эквивалентами времени выполнения атрибутов исходного кода. Для этого метода существует несколько перегруженных версий. Дополнительные сведения см. в разделе Attribute.

Спецификация атрибута, например:

[Author("H. Ackerman", version = 1.1)]
class SampleClass

концептуально эквивалентна следующей:

Author anonymousAuthorObject = new Author("H. Ackerman");
anonymousAuthorObject.version = 1.1;

При этом код не выполняется до тех пор, пока SampleClass не будет опрошен на предмет атрибутов. Вызов GetCustomAttributes в SampleClass приведет к тому, что объект Author будет построен и инициализирован так, как показано выше. Если класс имеет другие атрибуты, другие объекты атрибутов будут построены аналогичным образом. GetCustomAttributes затем вернет объект Author и любые другие объекты атрибутов в массиве. Потом можно перейти по этому массиву, выбрать примененные атрибуты на основе типа для каждого элемента массива и извлечь сведения из объектов массива.

Пример

Ниже приведен полный пример. Определяется настраиваемый атрибут, который применяется к нескольким сущностям и извлекается через отражение.

[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct,
                       AllowMultiple = true)  // multiuse attribute
]
public class Author : System.Attribute
{
    string name;
    public double version;

    public Author(string name)
    {
        this.name = name;
        version = 1.0;  // Default value
    }

    public string GetName()
    {
        return name;
    }
}

[Author("H. Ackerman")]
private class FirstClass
{
    // ...
}

// No Author attribute
private class SecondClass
{
    // ...
}

[Author("H. Ackerman"), Author("M. Knott", version = 2.0)]
private class ThirdClass
{
    // ...
}

class TestAuthorAttribute
{
    static void Main()
    {
        PrintAuthorInfo(typeof(FirstClass));
        PrintAuthorInfo(typeof(SecondClass));
        PrintAuthorInfo(typeof(ThirdClass));
    }

    private static void PrintAuthorInfo(System.Type t)
    {
        System.Console.WriteLine("Author information for {0}", t);
        System.Attribute[] attrs = System.Attribute.GetCustomAttributes(t);  // reflection

        foreach (System.Attribute attr in attrs)
        {
            if (attr is Author)
            {
                Author a = (Author)attr;
                System.Console.WriteLine("   {0}, version {1:f}", a.GetName(), a.version);
            }
        }
    }
}
/* Output:
    Author information for FirstClass
       H. Ackerman, version 1.00
    Author information for SecondClass
    Author information for ThirdClass
       M. Knott, version 2.00
       H. Ackerman, version 1.00
*/