Itérateurs (Visual Basic)Iterators (Visual Basic)

Un itérateur peut être utilisé pour parcourir des collections, comme des listes et des tableaux.An iterator can be used to step through collections such as lists and arrays.

Une méthode d’itérateur ou un accesseur get effectue une itération personnalisée sur une collection.An iterator method or get accessor performs a custom iteration over a collection. Une méthode Iterator utilise l’instruction yield pour retourner chaque élément un par un.An iterator method uses the Yield statement to return each element one at a time. Quand une instruction Yield est atteinte, l’emplacement actif dans le code est mémorisé.When a Yield statement is reached, the current location in code is remembered. L’exécution est redémarrée à partir de cet emplacement lors de l’appel suivant de la fonction d’itérateur.Execution is restarted from that location the next time the iterator function is called.

Vous consommez un itérateur à partir du code client à l’aide d’un for each... Instruction Next , ou à l’aide d’une requête LINQ.You consume an iterator from client code by using a For Each…Next statement, or by using a LINQ query.

Dans l’exemple suivant, la première itération de la boucle For Each fait que l’exécution continue dans la méthode d’itérateur SomeNumbers, jusqu’à ce que la première instruction Yield soit atteinte.In the following example, the first iteration of the For Each loop causes execution to proceed in the SomeNumbers iterator method until the first Yield statement is reached. Cette itération retourne la valeur 3, et l’emplacement actif dans la méthode d’itérateur est mémorisé.This iteration returns a value of 3, and the current location in the iterator method is retained. Dans l’itération suivante de la boucle, l’exécution de la méthode d’itérateur continue là où elle s’était arrêtée, et s’arrête de nouveau quand elle atteint une instruction Yield.On the next iteration of the loop, execution in the iterator method continues from where it left off, again stopping when it reaches a Yield statement. Cette itération retourne la valeur 5, et l’emplacement actif dans la méthode d’itérateur est mémorisé.This iteration returns a value of 5, and the current location in the iterator method is again retained. La boucle se termine quand la fin de la méthode d’itérateur est atteinte.The loop completes when the end of the iterator method is reached.

Sub Main()  
    For Each number As Integer In SomeNumbers()  
        Console.Write(number & " ")  
    Next  
    ' Output: 3 5 8  
    Console.ReadKey()  
End Sub  
  
Private Iterator Function SomeNumbers() As System.Collections.IEnumerable  
    Yield 3  
    Yield 5  
    Yield 8  
End Function  

Le type de retour d’une méthode d’itérateur ou de l’accesseur get peut être IEnumerable, IEnumerable<T>, IEnumerator ou IEnumerator<T>.The return type of an iterator method or get accessor can be IEnumerable, IEnumerable<T>, IEnumerator, or IEnumerator<T>.

Vous pouvez utiliser une Exit Function instruction Return ou pour terminer l’itération.You can use an Exit Function or Return statement to end the iteration.

Une Visual Basic une fonction d' get itérateur ou une déclaration d’accesseur comprend un modificateur d' itérateur .A Visual Basic iterator function or get accessor declaration includes an Iterator modifier.

Les itérateurs ont été introduits dans Visual Basic dans Visual Studio 2012.Iterators were introduced in Visual Basic in Visual Studio 2012.

Dans cette rubriqueIn this topic

Notes

Pour tous les exemples de la rubrique, à l’exception de l’exemple d’itérateur simple System.Collections , System.Collections.Generic incluez les instructions Imports pour les espaces de noms et.For all examples in the topic except the Simple Iterator example, include Imports statements for the System.Collections and System.Collections.Generic namespaces.

Itérateur simpleSimple Iterator

L’exemple suivant contient une instruction Yield unique qui se trouve à l’intérieur d’une instruction for... Next .The following example has a single Yield statement that is inside a For…Next loop. Dans Main, chaque itération du corps d’instruction For Each crée un appel à la fonction d’itérateur, qui poursuit avec l’instruction Yield suivante.In Main, each iteration of the For Each statement body creates a call to the iterator function, which proceeds to the next Yield statement.

Sub Main()  
    For Each number As Integer In EvenSequence(5, 18)  
        Console.Write(number & " ")  
    Next  
    ' Output: 6 8 10 12 14 16 18  
    Console.ReadKey()  
End Sub  
  
Private Iterator Function EvenSequence(  
ByVal firstNumber As Integer, ByVal lastNumber As Integer) _  
As System.Collections.Generic.IEnumerable(Of Integer)  
  
    ' Yield even numbers in the range.  
    For number As Integer = firstNumber To lastNumber  
        If number Mod 2 = 0 Then  
            Yield number  
        End If  
    Next  
End Function  

Création d’une classe de collectionCreating a Collection Class

Dans l’exemple suivant, la classe DaysOfTheWeek implémente l’interface IEnumerable, ce qui nécessite la méthode GetEnumerator.In the following example, the DaysOfTheWeek class implements the IEnumerable interface, which requires a GetEnumerator method. Le compilateur appelle implicitement la méthode GetEnumerator, qui retourne un IEnumerator.The compiler implicitly calls the GetEnumerator method, which returns an IEnumerator.

La GetEnumerator méthode retourne chaque chaîne l’une après l’autre à l' Yield aide de l’instruction Iterator , et un modificateur est dans la déclaration de la fonction.The GetEnumerator method returns each string one at a time by using the Yield statement, and an Iterator modifier is in the function declaration.

Sub Main()  
    Dim days As New DaysOfTheWeek()  
    For Each day As String In days  
        Console.Write(day & " ")  
    Next  
    ' Output: Sun Mon Tue Wed Thu Fri Sat  
    Console.ReadKey()  
End Sub  
  
Private Class DaysOfTheWeek  
    Implements IEnumerable  
  
    Public days =  
        New String() {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}  
  
    Public Iterator Function GetEnumerator() As IEnumerator _  
        Implements IEnumerable.GetEnumerator  
  
        ' Yield each day of the week.  
        For i As Integer = 0 To days.Length - 1  
            Yield days(i)  
        Next  
    End Function  
End Class  

L’exemple suivant crée une classe Zoo qui contient une collection d’animaux.The following example creates a Zoo class that contains a collection of animals.

L’instruction For Each qui fait référence à l’instance de classe (theZoo) appelle implicitement la méthode GetEnumerator.The For Each statement that refers to the class instance (theZoo) implicitly calls the GetEnumerator method. Les instructions For Each qui font référence aux propriétés Birds et Mammals utilisent la méthode d’itérateur nommée AnimalsForType.The For Each statements that refer to the Birds and Mammals properties use the AnimalsForType named iterator method.

Sub Main()  
    Dim theZoo As New Zoo()  
  
    theZoo.AddMammal("Whale")  
    theZoo.AddMammal("Rhinoceros")  
    theZoo.AddBird("Penguin")  
    theZoo.AddBird("Warbler")  
  
    For Each name As String In theZoo  
        Console.Write(name & " ")  
    Next  
    Console.WriteLine()  
    ' Output: Whale Rhinoceros Penguin Warbler  
  
    For Each name As String In theZoo.Birds  
        Console.Write(name & " ")  
    Next  
    Console.WriteLine()  
    ' Output: Penguin Warbler  
  
    For Each name As String In theZoo.Mammals  
        Console.Write(name & " ")  
    Next  
    Console.WriteLine()  
    ' Output: Whale Rhinoceros  
  
    Console.ReadKey()  
End Sub  
  
Public Class Zoo  
    Implements IEnumerable  
  
    ' Private members.  
    Private animals As New List(Of Animal)  
  
    ' Public methods.  
    Public Sub AddMammal(ByVal name As String)  
        animals.Add(New Animal With {.Name = name, .Type = Animal.TypeEnum.Mammal})  
    End Sub  
  
    Public Sub AddBird(ByVal name As String)  
        animals.Add(New Animal With {.Name = name, .Type = Animal.TypeEnum.Bird})  
    End Sub  
  
    Public Iterator Function GetEnumerator() As IEnumerator _  
        Implements IEnumerable.GetEnumerator  
  
        For Each theAnimal As Animal In animals  
            Yield theAnimal.Name  
        Next  
    End Function  
  
    ' Public members.  
    Public ReadOnly Property Mammals As IEnumerable  
        Get  
            Return AnimalsForType(Animal.TypeEnum.Mammal)  
        End Get  
    End Property  
  
    Public ReadOnly Property Birds As IEnumerable  
        Get  
            Return AnimalsForType(Animal.TypeEnum.Bird)  
        End Get  
    End Property  
  
    ' Private methods.  
    Private Iterator Function AnimalsForType( _  
    ByVal type As Animal.TypeEnum) As IEnumerable  
        For Each theAnimal As Animal In animals  
            If (theAnimal.Type = type) Then  
                Yield theAnimal.Name  
            End If  
        Next  
    End Function  
  
    ' Private class.  
    Private Class Animal  
        Public Enum TypeEnum  
            Bird  
            Mammal  
        End Enum  
  
        Public Property Name As String  
        Public Property Type As TypeEnum  
    End Class  
End Class  

Blocs tryTry Blocks

Visual Basic autorise une Yield instruction dans le Try bloc d’une instruction try... Catch... Finally, instruction.Visual Basic allows a Yield statement in the Try block of a Try...Catch...Finally Statement. Un Try bloc qui a une Yield instruction peut avoir Catch des blocs et peut avoir un Finally bloc.A Try block that has a Yield statement can have Catch blocks, and can have a Finally block.

L’exemple suivant comprend Trydes Catchblocs, Finally et dans une fonction d’itérateur.The following example includes Try, Catch, and Finally blocks in an iterator function. Le Finally bloc de la fonction Iterator s’exécute avant la For Each fin de l’itération.The Finally block in the iterator function executes before the For Each iteration finishes.

Sub Main()  
    For Each number As Integer In Test()  
        Console.WriteLine(number)  
    Next  
    Console.WriteLine("For Each is done.")  
  
    ' Output:  
    '  3  
    '  4  
    '  Something happened. Yields are done.  
    '  Finally is called.  
    '  For Each is done.  
    Console.ReadKey()  
End Sub  
  
Private Iterator Function Test() As IEnumerable(Of Integer)  
    Try  
        Yield 3  
        Yield 4  
        Throw New Exception("Something happened. Yields are done.")  
        Yield 5  
        Yield 6  
    Catch ex As Exception  
        Console.WriteLine(ex.Message)  
    Finally  
        Console.WriteLine("Finally is called.")  
    End Try  
End Function  

Une Yield instruction ne peut pas être Catch à l’intérieur Finally d’un bloc ou d’un bloc.A Yield statement cannot be inside a Catch block or a Finally block.

Si le For Each corps (au lieu de la méthode Iterator) lève une exception, un Catch bloc de la fonction d’itérateur n’est pas exécuté, Finally mais un bloc dans la fonction d’itérateur est exécuté.If the For Each body (instead of the iterator method) throws an exception, a Catch block in the iterator function is not executed, but a Finally block in the iterator function is executed. Un Catch bloc à l’intérieur d’une fonction d’itérateur intercepte uniquement les exceptions qui se produisent à l’intérieur de la fonction Iterator.A Catch block inside an iterator function catches only exceptions that occur inside the iterator function.

Méthodes anonymesAnonymous Methods

Dans Visual Basic, une fonction anonyme peut être une fonction d’itérateur.In Visual Basic, an anonymous function can be an iterator function. L'exemple suivant illustre ce comportement.The following example illustrates this.

Dim iterateSequence = Iterator Function() _  
                      As IEnumerable(Of Integer)  
                          Yield 1  
                          Yield 2  
                      End Function  
  
For Each number As Integer In iterateSequence()  
    Console.Write(number & " ")  
Next  
' Output: 1 2  
Console.ReadKey()  

L’exemple suivant a une méthode non itérateur qui valide les arguments.The following example has a non-iterator method that validates the arguments. La méthode retourne le résultat d’un itérateur anonyme qui décrit les éléments de la collection.The method returns the result of an anonymous iterator that describes the collection elements.

Sub Main()  
    For Each number As Integer In GetSequence(5, 10)  
        Console.Write(number & " ")  
    Next  
    ' Output: 5 6 7 8 9 10  
    Console.ReadKey()  
End Sub  
  
Public Function GetSequence(ByVal low As Integer, ByVal high As Integer) _  
As IEnumerable  
    ' Validate the arguments.  
    If low < 1 Then  
        Throw New ArgumentException("low is too low")  
    End If  
    If high > 140 Then  
        Throw New ArgumentException("high is too high")  
    End If  
  
    ' Return an anonymous iterator function.  
    Dim iterateSequence = Iterator Function() As IEnumerable  
                              For index = low To high  
                                  Yield index  
                              Next  
                          End Function  
    Return iterateSequence()  
End Function  

Si la validation est à l’intérieur de la fonction Iterator, la validation ne peut pas être effectuée avant le début de For Each la première itération du corps.If validation is instead inside the iterator function, the validation cannot be performed until the start of the first iteration of the For Each body.

Utilisation d’itérateurs avec une liste génériqueUsing Iterators with a Generic List

Dans l’exemple suivant, la classe générique Stack(Of T) implémente l'interface générique IEnumerable<T>.In the following example, the Stack(Of T) generic class implements the IEnumerable<T> generic interface. La méthode Push affecte des valeurs à un tableau de type T.The Push method assigns values to an array of type T. La méthode GetEnumerator retourne les valeurs de tableau à l’aide de l’instruction Yield.The GetEnumerator method returns the array values by using the Yield statement.

Outre la méthode GetEnumerator générique, la méthode GetEnumerator non générique doit également être implémentée.In addition to the generic GetEnumerator method, the non-generic GetEnumerator method must also be implemented. C’est parce que IEnumerable<T> hérite de IEnumerable.This is because IEnumerable<T> inherits from IEnumerable. L’implémentation non générique s’en remet à l’implémentation générique.The non-generic implementation defers to the generic implementation.

L’exemple utilise des itérateurs nommés pour prendre en charge différentes façons d’itérer au sein de la même collection de données.The example uses named iterators to support various ways of iterating through the same collection of data. Ces itérateurs nommés sont les propriétés TopToBottom et BottomToTop, et la méthode TopN.These named iterators are the TopToBottom and BottomToTop properties, and the TopN method.

La BottomToTop déclaration de propriété comprend Iterator le mot clé.The BottomToTop property declaration includes the Iterator keyword.

Sub Main()  
    Dim theStack As New Stack(Of Integer)  
  
    ' Add items to the stack.  
    For number As Integer = 0 To 9  
        theStack.Push(number)  
    Next  
  
    ' Retrieve items from the stack.  
    ' For Each is allowed because theStack implements  
    ' IEnumerable(Of Integer).  
    For Each number As Integer In theStack  
        Console.Write("{0} ", number)  
    Next  
    Console.WriteLine()  
    ' Output: 9 8 7 6 5 4 3 2 1 0  
  
    ' For Each is allowed, because theStack.TopToBottom  
    ' returns IEnumerable(Of Integer).  
    For Each number As Integer In theStack.TopToBottom  
        Console.Write("{0} ", number)  
    Next  
    Console.WriteLine()  
    ' Output: 9 8 7 6 5 4 3 2 1 0  
  
    For Each number As Integer In theStack.BottomToTop  
        Console.Write("{0} ", number)  
    Next  
    Console.WriteLine()  
    ' Output: 0 1 2 3 4 5 6 7 8 9   
  
    For Each number As Integer In theStack.TopN(7)  
        Console.Write("{0} ", number)  
    Next  
    Console.WriteLine()  
    ' Output: 9 8 7 6 5 4 3  
  
    Console.ReadKey()  
End Sub  
  
Public Class Stack(Of T)  
    Implements IEnumerable(Of T)  
  
    Private values As T() = New T(99) {}  
    Private top As Integer = 0  
  
    Public Sub Push(ByVal t As T)  
        values(top) = t  
        top = top + 1  
    End Sub  
  
    Public Function Pop() As T  
        top = top - 1  
        Return values(top)  
    End Function  
  
    ' This function implements the GetEnumerator method. It allows  
    ' an instance of the class to be used in a For Each statement.  
    Public Iterator Function GetEnumerator() As IEnumerator(Of T) _  
        Implements IEnumerable(Of T).GetEnumerator  
  
        For index As Integer = top - 1 To 0 Step -1  
            Yield values(index)  
        Next  
    End Function  
  
    Public Iterator Function GetEnumerator1() As IEnumerator _  
        Implements IEnumerable.GetEnumerator  
  
        Yield GetEnumerator()  
    End Function  
  
    Public ReadOnly Property TopToBottom() As IEnumerable(Of T)  
        Get  
            Return Me  
        End Get  
    End Property  
  
    Public ReadOnly Iterator Property BottomToTop As IEnumerable(Of T)  
        Get  
            For index As Integer = 0 To top - 1  
                Yield values(index)  
            Next  
        End Get  
    End Property  
  
    Public Iterator Function TopN(ByVal itemsFromTop As Integer) _  
        As IEnumerable(Of T)  
  
        ' Return less than itemsFromTop if necessary.  
        Dim startIndex As Integer =  
            If(itemsFromTop >= top, 0, top - itemsFromTop)  
  
        For index As Integer = top - 1 To startIndex Step -1  
            Yield values(index)  
        Next  
    End Function  
End Class  

Informations sur la syntaxeSyntax Information

Un itérateur peut être une méthode ou un accesseur get.An iterator can occur as a method or get accessor. Un itérateur ne peut pas être présent dans un événement, un constructeur d’instance, un constructeur statique ou un destructeur statique.An iterator cannot occur in an event, instance constructor, static constructor, or static destructor.

Une conversion implicite doit exister depuis le type d’expression dans l’instruction Yield vers le type de retour de l’itérateur.An implicit conversion must exist from the expression type in the Yield statement to the return type of the iterator.

Dans Visual Basic, une méthode d’itérateur ne peut ByRef pas avoir de paramètres.In Visual Basic, an iterator method cannot have any ByRef parameters.

Dans Visual Basic, « yield » n’est pas un mot réservé et a une signification spéciale uniquement lorsqu’il est utilisé Iterator dans une get méthode ou un accesseur.In Visual Basic, "Yield" is not a reserved word and has special meaning only when it is used in an Iterator method or get accessor.

Implémentation techniqueTechnical Implementation

Bien que vous écriviez un itérateur comme une méthode, le compilateur le traduit en une classe imbriquée, qui est en réalité une machine à états.Although you write an iterator as a method, the compiler translates it into a nested class that is, in effect, a state machine. Cette classe fait le suivi de la position de l’itérateur tant que la boucle For Each...Next du code client se poursuit.This class keeps track of the position of the iterator as long the For Each...Next loop in the client code continues.

Pour voir ce que fait le compilateur, vous pouvez utiliser l’outil Ildasm.exe pour afficher le code du langage intermédiaire Microsoft généré pour une méthode d’itérateur.To see what the compiler does, you can use the Ildasm.exe tool to view the Microsoft intermediate language code that is generated for an iterator method.

Lorsque vous créez un itérateur pour une classe ou un struct, vous n’avez pas à implémenter IEnumerator l’interface entière.When you create an iterator for a class or struct, you do not have to implement the whole IEnumerator interface. Quand le compilateur détecte l’itérateur, il génère automatiquement les méthodes Current, MoveNext et Dispose de l’interface IEnumerator ou IEnumerator<T>.When the compiler detects the iterator, it automatically generates the Current, MoveNext, and Dispose methods of the IEnumerator or IEnumerator<T> interface.

À chaque itération successive de la boucle For Each…Next (ou de l’appel direct à IEnumerator.MoveNext), le corps du code de l’itérateur suivant reprend après l’instruction Yield précédente.On each successive iteration of the For Each…Next loop (or the direct call to IEnumerator.MoveNext), the next iterator code body resumes after the previous Yield statement. Il continue ensuite à l’instruction Yield suivante jusqu’à ce que la fin du corps de l’itérateur soit atteinte Exit Function , Return ou jusqu’à ce qu’une instruction ou soit rencontrée.It then continues to the next Yield statement until the end of the iterator body is reached, or until an Exit Function or Return statement is encountered.

Les itérateurs ne prennent pas IEnumerator.Reset en charge la méthode.Iterators do not support the IEnumerator.Reset method. Pour réitérer à partir du début, vous devez obtenir un nouvel itérateur.To re-iterate from the start, you must obtain a new iterator.

Pour plus d’informations, consultez la spécification du langage Visual Basic.For additional information, see the Visual Basic Language Specification.

Utilisation d’itérateursUse of Iterators

Les itérateurs vous permettent de conserver la simplicité d’une boucle For Each quand vous avez besoin d’utiliser un code complexe pour remplir la séquence d’une liste.Iterators enable you to maintain the simplicity of a For Each loop when you need to use complex code to populate a list sequence. Ceci peut être utile quand vous voulez faire les opérations suivantes :This can be useful when you want to do the following:

  • Modifier la séquence de la liste après la première itération de la boucle For Each.Modify the list sequence after the first For Each loop iteration.

  • Éviter de charger entièrement une grande liste avant la première itération d’une boucle For Each.Avoid fully loading a large list before the first iteration of a For Each loop. Une extraction paginée pour charger un lot de lignes d’une table est un exemple.An example is a paged fetch to load a batch of table rows. Un autre exemple est la méthode EnumerateFiles , qui implémente les itérateurs dans le .NET Framework.Another example is the EnumerateFiles method, which implements iterators within the .NET Framework.

  • Encapsuler la création de la liste dans l’itérateur.Encapsulate building the list in the iterator. Dans la méthode d’itérateur, vous pouvez créer la liste et générer ensuite chaque résultat dans une boucle.In the iterator method, you can build the list and then yield each result in a loop.

Voir aussiSee also