Iterátory (Visual Basic)

Iterátor lze použít k procházení kolekcí, jako jsou seznamy a pole.

Metoda iterátoru nebo get příslušenství provádí vlastní iteraci v kolekci. Metoda iterátoru používá příkaz Yield k vrácení každého prvku po jednom. Když je dosaženo Yield příkazu, aktuální umístění v kódu se zapamatuje. Spuštění se restartuje z daného umístění při příštím volání funkce iterátoru.

Iterátor z klientského kódu používáte pomocí příkazu For Each... Další nebo pomocí dotazu LINQ.

V následujícím příkladu první iterace smyčky For Each způsobí, že provádění bude pokračovat v metodě iterátoru SomeNumbers, dokud nebude dosaženo prvního Yield příkazu. Tato iterace vrátí hodnotu 3 a aktuální umístění v metodě iterátoru se zachová. Při další iteraci smyčky pokračuje provádění v iterátoru v místě, kde skončilo, a znovu se zastaví, když dosáhne na Yield příkaz. Tato iterace vrátí hodnotu 5 a aktuální umístění v metodě iterátoru se znovu zachová. Smyčka se dokončí po dosažení konce metody iterátoru.

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

Návratový typ metody iterátoru nebo get přístupového objektu může být IEnumerable, IEnumerable<T>, IEnumerator, nebo IEnumerator<T>.

K ukončení iterace můžete použít příkaz Exit Function nebo Return příkaz.

Funkce iterátoru ve Visual Basic nebo deklarace přístupového objektu get obsahuje modifikátor Iterator.

Iterátory byly zavedeny v jazyce Visual Basic v sadě Visual Studio 2012.

Poznámka:

Pro všechny příklady v článku, s výjimkou příkladu Simple Iterator, zahrňte příkazy Imports pro obory názvů System.Collections a obory názvů System.Collections.Generic.

Jednoduchý iterátor

Následující příklad obsahuje jeden Yield příkaz, který je uvnitř For...Next smyčky. V každé iteraci těla příkazu Main se vytvoří volání funkce iterátoru, které pokračuje k dalšímu příkazu For Each.

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

Vytvoření třídy pro kolekci

V následujícím příkladu DaysOfTheWeek třída implementuje IEnumerable rozhraní, které vyžaduje metodu GetEnumerator . Kompilátor implicitně volá metoduGetEnumerator, která vrací .IEnumerator

Metoda GetEnumerator vrací každý řetězec po jednom pomocí Yield příkazu a Iterator modifikátor je v deklaraci funkce.

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

Následující příklad vytvoří Zoo třídu, která obsahuje kolekci zvířat.

Příkaz For Each , který odkazuje na instanci třídy (theZoo) implicitně volá metodu GetEnumerator . Příkazy For Each , které odkazují na Birds a Mammals vlastnosti, používají pojmenovanou metodu AnimalsForType iterátoru.

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

Vyzkoušet bloky

Visual Basic umožňuje příkaz Yield v Try bloku Try...Catch...Finally příkaz. Try Blok, který obsahuje Yield příkaz, může obsahovat Catch bloky a může obsahovat Finally blok.

Následující příklad obsahuje Try, Catcha Finally bloky ve funkci iterátoru. Blok Finally ve funkci iterátoru se spustí před dokončením For Each iterace.

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

Příkaz Yield nemůže být uvnitř Catch bloku nebo Finally bloku.

Pokud tělo For Each (místo metody iterátoru) vyvolá výjimku, blok Catch ve funkci iterátoru se nespustí, ale blok Finally se provede ve funkci iterátoru. Blok Catch uvnitř funkce iterátoru zachytává pouze výjimky, ke kterým dochází uvnitř funkce iterátoru.

Anonymní metody

V jazyce Visual Basic může být anonymní funkce iterátorem. Následující příklad to ilustruje.

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

Následující příklad obsahuje metodu ne iterátoru, která ověřuje argumenty. Metoda vrátí výsledek anonymního iterátoru, který popisuje prvky kolekce.

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

Pokud je ověření v rámci funkce iterátoru, nelze ověření provést před začátkem první iterace For Each těla.

Použití iterátorů s obecným seznamem

V následujícím příkladu Stack(Of T) obecná třída implementuje IEnumerable<T> obecné rozhraní. Metoda Push přiřadí hodnoty k poli typu T. Metoda GetEnumerator vrátí hodnoty pole pomocí příkazu Yield.

Kromě obecné GetEnumerator metody musí být také implementována ne generická GetEnumerator metoda. Je to proto, že IEnumerable<T> dědí z IEnumerable. Ne generická implementace vzdoruje obecné implementaci.

Příklad používá pojmenované iterátory k podpoře různých způsobů iterace prostřednictvím stejné kolekce dat. Tyto pojmenované iterátory jsou vlastnosti TopToBottom a BottomToTop a metoda TopN.

Deklarace BottomToTop vlastnosti obsahuje Iterator klíčové slovo.

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

Informace o syntaxi

Iterátor může nastat jako metoda nebo get příslušenství. Iterátor nelze použít v události, konstruktoru instance, statickém konstruktoru nebo statickém destruktoru.

Implicitní převod musí existovat z typu výrazu Yield v příkazu na návratový typ iterátoru.

V jazyce Visual Basic nemůže metoda iterátoru mít žádné ByRef parametry.

V jazyce Visual Basic není "Yield" vyhrazeným slovem a má zvláštní význam pouze v případě, že se používá v Iterator metodě nebo get přístupovém prvku.

Technická implementace

I když jako metodu napíšete iterátor, kompilátor ho přeloží do vnořené třídy, která je v podstatě stavový počítač. Tato třída sleduje pozici iterátoru, dokud smyčka For Each...Next v kódu klienta pokračuje.

Pokud chcete zjistit, co kompilátor dělá, můžete pomocí nástroje Ildasm.exe zobrazit kód společného zprostředkujícího jazyka, který je generován pro metodu iterátoru.

Při vytváření iterátoru pro třídu nebo strukturu nemusíte implementovat celé IEnumerator rozhraní. Když kompilátor zjistí iterátor, automaticky vygeneruje Current, MoveNext, a Dispose metody rozhraní IEnumerator nebo IEnumerator<T>.

Při každé následné iteraci smyčky For Each…Next (nebo při přímém volání IEnumerator.MoveNext) pokračuje další tělo kódu iterátoru po předchozím příkazu Yield. Potom pokračuje k dalšímu Yield příkazu až do dosažení konce textu iterátoru nebo dokud nedojde k výskytu Exit Function příkazu nebo Return příkazu.

Iterátory metodu IEnumerator.Reset nepodporují. Pokud chcete iterovat znovu od začátku, musíte získat nový iterátor.

Další informace najdete ve specifikaci jazyka Visual Basic.

Použití iterátorů

Iterátory umožňují udržovat jednoduchost For Each smyčky, když potřebujete použít složitý kód k naplnění sekvence seznamu. To může být užitečné, když chcete udělat toto:

• Upravte posloupnost seznamu po první For Each iteraci smyčky.

• Vyhněte se úplnému načtení velkého seznamu před první iterací smyčky For Each . Příkladem je stránkované načítání skupiny řádků tabulky. Dalším příkladem je EnumerateFiles metoda, která implementuje iterátory v rozhraní .NET Framework.

• Zapouzdřete vytváření seznamu v iterátoru. V metodě iterátoru můžete vytvořit seznam a pak získat každý výsledek ve smyčce.

Viz také

• System.Collections.Generic
• IEnumerable<T>
• Pro každý...Další příkaz
• Příkaz 'yield'
• Iterátor