Komma åt attribut med hjälp av reflektion (Visual Basic)

  • Artikel

Det faktum att du kan definiera anpassade attribut och placera dem i källkoden skulle vara av litet värde utan något sätt att hämta den informationen och agera på den. Med reflektion kan du hämta den information som har definierats med anpassade attribut. Nyckelmetoden är GetCustomAttributes, som returnerar en matris med objekt som är körningsekvivalenter för källkodsattributen. Den här metoden har flera överlagrade versioner. Mer information finns i Attribute.

En attributspecifikation som:

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

är begreppsmässigt likvärdigt med detta:

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

Koden körs dock inte förrän SampleClass den efterfrågas för attribut. Om du anropar GetCustomAttributesSampleClass på skapas och initieras ett Author objekt enligt ovan. Om klassen har andra attribut konstrueras andra attributobjekt på samma sätt. GetCustomAttributes returnerar Author sedan objektet och andra attributobjekt i en matris. Sedan kan du iterera över den här matrisen, bestämma vilka attribut som tillämpades baserat på typen av varje matriselement och extrahera information från attributobjekten.

Exempel

Här är ett fullständigt exempel. Ett anpassat attribut definieras, tillämpas på flera entiteter och hämtas via reflektion.

' 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

Se även