Partager via

Accès aux attributs à l’aide de la réflection (Visual Basic)

Le fait que vous pouvez définir des attributs personnalisés et les placer dans votre code source serait de peu de valeur sans aucun moyen de récupérer ces informations et d’agir dessus. En utilisant la réflexion, vous pouvez récupérer les informations qui ont été définies avec des attributs personnalisés. La méthode clé est GetCustomAttributes, qui retourne un tableau d’objets qui sont les équivalents au moment de l’exécution des attributs de code source. Cette méthode comporte plusieurs versions surchargées. Pour plus d’informations, consultez Attribute.

Spécification d’attribut, par exemple :

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

est conceptuellement équivalent à ceci :

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

Toutefois, le code n'est pas exécuté tant que SampleClass n’est pas interrogé pour les attributs. L’appel de GetCustomAttributes sur SampleClass provoque la construction et l’initialisation d’un objet Author comme indiqué ci-dessus. Si la classe a d’autres attributs, d’autres objets d’attribut sont construits de la même façon. GetCustomAttributes retourne ensuite l’objet Author et tous les autres objets d’attribut dans un tableau. Vous pouvez ensuite itérer sur ce tableau, déterminer quels attributs ont été appliqués en fonction du type de chaque élément de tableau et extraire des informations des objets d’attribut.

Exemple :

Voici un exemple complet. Un attribut personnalisé est défini, appliqué à plusieurs entités et récupéré via la réflexion.

' 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

Voir aussi