Iteradores (Visual Basic)

2025-06-20

Se puede usar un iterador para recorrer recopilaciones como listas y matrices.

Un método iterador o un descriptor de acceso get realiza una iteración personalizada en una colección. Un método de iterador usa la instrucción Yield para devolver cada elemento de uno en uno. Cuando se alcanza una instrucción Yield, se recuerda la ubicación actual en el código. La ejecución se reinicia desde esa ubicación la próxima vez que se llame a la función de iterador.

Para usar un método iterador desde código de cliente, use una instrucción For Each…Next o una consulta de LINQ.

En el siguiente ejemplo, la primera iteración del For Each bucle provoca que la ejecución avance en el método SomeNumbers iterador hasta que se llegue a la primera instrucción Yield. Esta iteración devuelve un valor de 3 y se conserva la ubicación actual del método iterador. En la siguiente iteración del bucle, la ejecución en el método iterador continúa desde donde se dejó, deteniéndose de nuevo cuando llega a una instrucción Yield. Esta iteración devuelve un valor de 5 y la ubicación actual del método iterador se conserva de nuevo. El bucle se completa cuando se alcanza el final del método iterador.

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

El tipo de valor devuelto de un método de iterador o descriptor de acceso get puede ser IEnumerable, IEnumerable<T>, IEnumerator, o IEnumerator<T>.

Puede usar una Exit Function instrucción o Return para finalizar la iteración.

Una función de iterador de Visual Basic o una declaración de descriptor de acceso get incluye un modificador de iterador.

Los iteradores se introdujeron en Visual Basic en Visual Studio 2012.

Nota:

Para todos los ejemplos del artículo, excepto el del iterador simple, incluya instrucciones Imports para los espacios de nombres System.Collections y System.Collections.Generic.

Iterador simple

En el ejemplo siguiente hay una única instrucción Yield que se encuentra dentro de un bucle For…Next. En Main, cada iteración del cuerpo de la instrucción For Each crea una llamada a la función de iterador, que continúa a la instrucción Yield siguiente.

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

Crear una clase de colección

En el ejemplo siguiente, la DaysOfTheWeek clase implementa la IEnumerable interfaz , que requiere un GetEnumerator método . El compilador llama implícitamente al GetEnumerator método , que devuelve un IEnumerator.

El GetEnumerator método devuelve cada cadena una a la vez mediante la Yield instrucción y un Iterator modificador se encuentra en la declaración de función.

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

En el ejemplo siguiente se crea una Zoo clase que contiene una colección de animales.

La For Each instrucción que hace referencia a la instancia de clase (theZoo) llama implícitamente al método GetEnumerator. Las For Each instrucciones que hacen referencia a las propiedades Birds y Mammals emplean el método iterador denominado AnimalsForType.

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

Bloques Try

Visual Basic permite una instrucción Yield en el bloque Try de una instrucción Try...Catch...Finally. Un Try bloque que tiene una Yield instrucción puede tener Catch bloques y puede tener un Finally bloque.

En el siguiente ejemplo se incluyen los bloques Try, Catch y Finally en una función de iterador. El Finally bloque de la función iterador se ejecuta antes de que finalice la For Each iteración.

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

Una Yield instrucción no puede estar dentro de un Catch bloque o un Finally bloque.

Si el For Each cuerpo (en lugar del método iterador) produce una excepción, no se ejecuta un Catch bloque de la función iterador, pero se ejecuta un Finally bloque de la función iterador. Un Catch bloque dentro de una función de iterador detecta solo excepciones que se producen dentro de la función de iterador.

Métodos anónimos

En Visual Basic, una función anónima puede ser una función de iterador. En el ejemplo siguiente se muestra esto.

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()

El ejemplo siguiente tiene un método que no es iterador que valida los argumentos. El método devuelve el resultado de un iterador anónimo que describe los elementos de la colección.

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 validación está en su lugar dentro de la función de iterador, la validación no se puede realizar hasta el inicio de la primera iteración del cuerpo de For Each.

Uso de iteradores con una lista genérica

En el ejemplo siguiente, la Stack(Of T) clase genérica implementa la IEnumerable<T> interfaz genérica. El Push método asigna valores a una matriz de tipo T. El GetEnumerator método devuelve los valores de matriz mediante la Yield instrucción .

Además del método genérico GetEnumerator , también se debe implementar el método no genérico GetEnumerator . Esto se debe a que IEnumerable<T> hereda de IEnumerable. La implementación no genérica aplaza la implementación genérica.

El ejemplo usa iteradores con nombre para admitir distintas formas de recorrer en iteración la misma colección de datos. Estos iteradores con nombre son las propiedades TopToBottom y BottomToTop, y el método TopN.

La declaración de BottomToTop propiedad incluye la Iterator palabra clave .

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

Información de sintaxis

Un iterador puede ocurrir como un método o como un get accesor. Un iterador no puede utilizarse en un evento, un constructor de instancia, un constructor estático o un destructor estático.

Una conversión implícita debe existir desde el tipo de expresión de la Yield instrucción al tipo de retorno del iterador.

En Visual Basic, un método iterador no puede tener ningún ByRef parámetro.

En Visual Basic, "Yield" no es una palabra reservada y tiene un significado especial solo cuando se usa en un Iterator método o get accesor.

Implementación técnica

Aunque se escribe un iterador como método, el compilador lo traduce en una clase anidada que es, en efecto, una máquina de estado. Esta clase realiza un seguimiento de la posición del iterador siempre que continúe el For Each...Next bucle en el código de cliente.

Para ver lo que hace el compilador, puede usar la herramienta Ildasm.exe para ver el código de lenguaje intermedio común que se genera para un método iterador.

Al crear un iterador para una clase o estructura, no es necesario implementar toda IEnumerator la interfaz. Cuando el compilador detecta el iterador, genera automáticamente los Currentmétodos , MoveNexty Dispose de la IEnumerator interfaz o IEnumerator<T> .

En cada iteración sucesiva del bucle For Each…Next (o la llamada directa a IEnumerator.MoveNext), el cuerpo de código del iterador siguiente se reanuda después de la instrucción Yield anterior. Después continúa con la siguiente instrucción Yield hasta que se alcanza el final del cuerpo del iterador, o hasta que se encuentra una instrucción Exit Function o Return.

Los iteradores no admiten el IEnumerator.Reset método . Para volver a recorrer en iteración desde el principio, se debe obtener un nuevo iterador.

Para obtener más información, consulte especificación del lenguaje Visual Basic.

Uso de iteradores

Los iteradores permiten mantener la simplicidad de un For Each bucle cuando se necesita usar código complejo para rellenar una secuencia de lista. Esto puede ser útil cuando desee hacer lo siguiente:

Modifique la secuencia de lista después de la primera For Each iteración del bucle.
Evite cargar completamente una lista grande antes de la primera iteración de un For Each bucle. Un ejemplo es una búsqueda paginada para cargar un lote de filas de tabla. Otro ejemplo es el EnumerateFiles método , que implementa iteradores dentro de .NET Framework.
Encapsular la creación de la lista en el iterador. En el método iterador, puede compilar la lista y, a continuación, generar cada resultado en un bucle.

Compartir a través de