Обращение к атрибутам с помощью отражения (C# и Visual Basic)

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

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

<Author("P. Ackerman", Version:=1.1)> 
Class SampleClass
    ' P. Ackerman's code goes here... 
End Class

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

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

Dim anonymousAuthorObject As Author = New Author("P. Ackerman")
anonymousAuthorObject.version = 1.1

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

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

Пример

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

' Multiuse attribute
<System.AttributeUsage(System.AttributeTargets.Class Or 
                       System.AttributeTargets.Struct, 
                       AllowMultiple:=True)> 
Public Class Author
    Inherits System.Attribute
    Private name As String 
    Public version As Double 
    Sub New(ByVal authorName As String)
        name = authorName

        ' Default value
        version = 1.0
    End Sub 

    Function GetName() As String 
        Return name
    End Function         
End Class 

' Class with the Author attribute
<Author("P. Ackerman")> 
Public Class FirstClass
End Class 

' Class without the Author attribute 
Public Class SecondClass
End Class 

' Class with multiple Author attributes.
<Author("P. Ackerman"), Author("R. Koch", Version:=2.0)> 
Public Class ThirdClass
End Class 

Class TestAuthorAttribute
    Sub Main()
        PrintAuthorInfo(GetType(FirstClass))
        PrintAuthorInfo(GetType(SecondClass))
        PrintAuthorInfo(GetType(ThirdClass))
    End Sub 

    Private Shared Sub PrintAuthorInfo(ByVal t As System.Type)
        System.Console.WriteLine("Author information for {0}", t)

        ' Using reflection 
        Dim attrs() As System.Attribute = System.Attribute.GetCustomAttributes(t)

        ' Displaying output 
        For Each attr In attrs
            Dim a As Author = CType(attr, Author)
            System.Console.WriteLine("   {0}, version {1:f}", a.GetName(), a.version)
        Next             
    End Sub 

    ' Output: 
    '   Author information for FirstClass 
    '     P. Ackerman, version 1.00 
    ' Author information for SecondClass 
    ' Author information for ThirdClass 
    '  R. Koch, version 2.00 
    '  P. Ackerman, version 1.00 

End Class

// Multiuse attribute.
[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;

        // Default value.
        version = 1.0;
    }

    public string GetName()
    {
        return name;
    }
}

// Class with the Author attribute.
[Author("P. Ackerman")]
public class FirstClass
{
    // ...
}

// Class without the Author attribute. 
public class SecondClass
{
    // ...
}

// Class with multiple Author attributes.
[Author("P. Ackerman"), Author("R. Koch", version = 2.0)]
public class ThirdClass
{
    // ...
}

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

    private static void PrintAuthorInfo(System.Type t)
    {
        System.Console.WriteLine("Author information for {0}", t);

        // Using reflection.
        System.Attribute[] attrs = System.Attribute.GetCustomAttributes(t);  // Reflection. 

        // Displaying output. 
        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
       P. Ackerman, version 1.00
    Author information for SecondClass
    Author information for ThirdClass
       R. Koch, version 2.00
       P. Ackerman, version 1.00
*/

См. также

Ссылки

Отражение (C# и Visual Basic)

Атрибуты (C# и Visual Basic)

Создание настраиваемых атрибутов (C# и Visual Basic)

System.Reflection

Attribute

Основные понятия

Руководство по программированию на C#

Извлечение информации, сохраненной в атрибуте

Другие ресурсы

Руководство по программированию на Visual Basic