Iteratori (Visual Basic)

2025-06-17

È possibile usare un iteratore per scorrere raccolte, ad esempio elenchi e matrici.

Un metodo iteratore o get una funzione di accesso esegue un'iterazione personalizzata su una raccolta. Un metodo iteratore usa l'istruzione Yield per restituire ogni elemento uno alla volta. Quando viene raggiunta un'istruzione Yield , viene memorizzata la posizione corrente nel codice. L'esecuzione viene riavviata da tale posizione alla successiva chiamata della funzione iteratore.

Si consuma un iteratore nel codice client usando un'istruzione For Each…Next, o tramite una query LINQ.

Nell'esempio seguente, la prima iterazione del For Each ciclo fa sì che l'esecuzione proceda nel SomeNumbers metodo iteratore fino a quando non viene raggiunta la prima Yield istruzione. Questa iterazione restituisce un valore pari a 3 e la posizione corrente nel metodo iteratore viene mantenuta. Nell'iterazione successiva del ciclo, l'esecuzione nel metodo iteratore continua da dove è stata interrotta, arrestando di nuovo quando raggiunge un'istruzione Yield . Questa iterazione restituisce un valore pari a 5 e la posizione corrente nel metodo iteratore viene nuovamente mantenuta. Il ciclo viene completato quando viene raggiunta la fine del metodo iteratore.

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

Il tipo restituito di un metodo iteratore o get di un accessore può essere IEnumerable, IEnumerable<T>, IEnumerator, o IEnumerator<T>.

È possibile usare un'istruzione Exit Function o Return per terminare l'iterazione.

Una funzione iteratore o una dichiarazione di accesso di Visual Basic include un modificatore get.

Gli iteratori sono stati introdotti in Visual Basic in Visual Studio 2012.

Annotazioni

Per tutti gli esempi nell'articolo eccetto l'esempio del Simple Iterator, includi le istruzioni Imports per gli spazi dei nomi System.Collections e System.Collections.Generic.

Iteratore semplice

L'esempio seguente ha una singola Yield istruzione che è all'interno di un For…Next loop. In Mainogni iterazione del corpo dell'istruzione For Each crea una chiamata alla funzione iteratore, che procede con l'istruzione successiva Yield .

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

Creazione di una classe di raccolta

Nell'esempio seguente la DaysOfTheWeek classe implementa l'interfaccia IEnumerable , che richiede un GetEnumerator metodo . Il compilatore chiama in modo implicito il GetEnumerator metodo , che restituisce un oggetto IEnumerator.

Il GetEnumerator metodo restituisce ogni stringa una alla volta usando l'istruzione Yield e un Iterator modificatore si trova nella dichiarazione di funzione.

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

Nell'esempio seguente viene creata una Zoo classe contenente una raccolta di animali.

L'istruzione For Each che fa riferimento all'istanza della classe (theZoo) chiama in modo implicito il GetEnumerator metodo . Le istruzioni For Each che fanno riferimento alle proprietà Birds e Mammals usano il metodo iteratore denominato 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

Prova blocchi

Visual Basic consente un'istruzione nel blocco YieldTry di un'istruzione Try...Catch...Finally Statement. Un Try blocco con un'istruzione Yield può avere Catch blocchi e può avere un Finally blocco.

Nell'esempio seguente sono inclusi i blocchi Try, Catch e Finally in una funzione iterativa. Il blocco Finally nella funzione dell'iteratore viene eseguito prima del completamento dell'iterazione For Each.

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

Un'istruzione Yield non può trovarsi all'interno di un blocco Catch o di un blocco Finally.

Se il For Each corpo (anziché il metodo iteratore) genera un'eccezione, non viene eseguito un Catch blocco nella funzione iteratore, ma viene eseguito un Finally blocco nella funzione iteratore. Un blocco Catch all'interno di una funzione iteratore rileva solo le eccezioni che si verificano all'interno di essa.

Metodi anonimi

In Visual Basic una funzione anonima può essere una funzione iteratore. Nell'esempio seguente viene illustrato questo.

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

Nell'esempio seguente è presente un metodo non iteratore che convalida gli argomenti. Il metodo restituisce il risultato di un iteratore anonimo che descrive gli elementi della raccolta.

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

Se la convalida è invece all'interno della funzione iteratore, la convalida non può essere eseguita fino all'inizio della prima iterazione del For Each corpo.

Uso di iteratori con un elenco generico

Nell'esempio seguente la Stack(Of T) classe generica implementa l'interfaccia IEnumerable<T> generica. Il Push metodo assegna valori a una matrice di tipo T. Il GetEnumerator metodo restituisce i valori della matrice usando l'istruzione Yield .

Oltre al metodo generico GetEnumerator , è necessario implementare anche il metodo non generico GetEnumerator . Questo perché IEnumerable<T> eredita da IEnumerable. L'implementazione non generica rinvia all'implementazione generica.

Nell'esempio vengono usati iteratori denominati per supportare vari modi di iterare la stessa raccolta di dati. Questi iteratori denominati sono le TopToBottom proprietà e BottomToTop e il TopN metodo .

La dichiarazione di BottomToTop proprietà include la Iterator parola chiave .

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

Informazioni sulla sintassi

Un iteratore può verificarsi come metodo o get accessor. Un iteratore non può essere utilizzato in un evento, un costruttore di istanza, un costruttore statico o un distruttore statico.

È necessario che esista una conversione implicita dal tipo di espressione nell'istruzione Yield al tipo restituito dell'iteratore.

In Visual Basic un metodo iteratore non può avere parametri ByRef .

In Visual Basic "Yield" non è una parola riservata e ha un significato speciale solo quando viene utilizzato in un metodo Iterator o in un accessor get.

Implementazione tecnica

Anche se si scrive un iteratore come metodo, il compilatore lo traduce in una classe nidificata che è, di fatto, una macchina a stati. Questa classe tiene traccia della posizione dell'iteratore finché il For Each...Next ciclo nel codice client continua.

Per verificare le operazioni del compilatore, è possibile usare lo strumento Ildasm.exe per visualizzare il codice del linguaggio intermedio comune generato per un metodo iteratore.

Quando si crea un iteratore per una classe o uno struct, non è necessario implementare l'intera IEnumerator interfaccia. Quando il compilatore rileva l'iteratore, genera automaticamente i Currentmetodi , MoveNexte Dispose dell'interfaccia IEnumerator o IEnumerator<T> .

Ad ogni iterazione del ciclo For Each…Next (o alla chiamata diretta a IEnumerator.MoveNext), il corpo del codice dell'iteratore riprende dopo l'istruzione precedente Yield. Continua quindi con l'istruzione successiva Yield fino al raggiungimento della fine del corpo dell'iteratore o fino a quando non viene rilevata un'istruzione Exit Function o Return .

Gli iteratori non supportano il IEnumerator.Reset metodo . Per ripetere l'iterazione dall'inizio, è necessario ottenere un nuovo iteratore.

Per altre informazioni, vedere Specifica del linguaggio Visual Basic.

Uso di iteratori

Gli iteratori consentono di mantenere la semplicità di un For Each ciclo quando è necessario usare codice complesso per popolare una sequenza di elenco. Ciò può essere utile quando si desidera eseguire le operazioni seguenti:

Modificare l'ordine dell'elenco dopo la prima iterazione del ciclo For Each.
Evitare di caricare completamente un elenco di grandi dimensioni prima della prima iterazione di un For Each ciclo. Un esempio è un recupero paginato per caricare un gruppo di righe di tabella. Un altro esempio è il EnumerateFiles metodo , che implementa gli iteratori all'interno di .NET Framework.
Incapsulare la compilazione dell'elenco nell'iteratore. Nel metodo iteratore è possibile compilare l'elenco e quindi restituire ogni risultato in un ciclo.

Condividi tramite