Iterator (Visual Basic)

Iterator dapat digunakan untuk menelusuri koleksi seperti daftar dan array.

Metode iterator atau get aksesor melakukan iterasi kustom atas koleksi data. Metode iterator menggunakan pernyataan Hasil untuk mengembalikan setiap elemen satu per satu. Ketika pernyataan Yield dicapai, lokasi saat ini dalam kode disimpan. Eksekusi dimulai ulang dari lokasi tersebut saat fungsi iterator dipanggil berikutnya.

Anda memanfaatkan iterator dari kode klien dengan menggunakan Untuk Setiap…Selanjutnya, atau dengan menggunakan kueri LINQ.

Dalam contoh berikut, iterasi pertama perulangan For Each menyebabkan eksekusi dilanjutkan dalam SomeNumbers metode iterator hingga pernyataan pertama Yield tercapai. Iterasi ini mengembalikan nilai 3, dan lokasi saat ini dalam metode iterator dipertahankan. Pada iterasi berikutnya dari loop, eksekusi dalam metode iterator berlanjut dari tempat yang ditinggalkannya, sekali lagi berhenti ketika mencapai Yield pernyataan. Perulangan ini mengembalikan nilai 5, dan lokasi saat ini dalam metode iterator kembali dipertahankan. Perulangan selesai ketika akhir metode iterator tercapai.

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

Jenis pengembalian metode iterator atau get aksesor dapat berupa IEnumerable, , IEnumerable<T>IEnumerator, atau IEnumerator<T>.

Anda dapat menggunakan Exit Function pernyataan atau Return untuk mengakhiri iterasi.

Fungsi iterator Visual Basic atau get deklarasi aksesor menyertakan pengubah Iterator .

Iterator diperkenalkan di Visual Basic di Visual Studio 2012.

Nota

Untuk semua contoh dalam artikel kecuali contoh Iterator Sederhana, sertakan pernyataan Impor untuk namespace dan System.Collections.

Iterator Sederhana

Contoh berikut memiliki satu Yield pernyataan yang ada di dalam For…Next loop. Dalam Main, setiap iterasi dari isi pernyataan For Each menciptakan panggilan ke fungsi iterator, yang kemudian melanjutkan ke pernyataan berikutnya 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

Membuat Kelas Koleksi

Dalam contoh berikut, DaysOfTheWeek kelas mengimplementasikan IEnumerable antarmuka, yang memerlukan GetEnumerator metode. Kompilator memanggil metode GetEnumerator secara implisit, yang mengembalikan IEnumerator.

Metode mengembalikan GetEnumerator setiap string satu per satu dengan menggunakan Yield pernyataan , dan pengubah Iterator berada dalam deklarasi fungsi.

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

Contoh berikut membuat Zoo kelas yang berisi kumpulan hewan.

Pernyataan For Each yang mengacu pada instans kelas (theZoo) secara implisit memanggil metode GetEnumerator. Pernyataan For Each yang merujuk ke properti Birds dan Mammals menggunakan metode iterator bernama 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

Coba Blokir

Visual Basic memungkinkan Yield pernyataan di Try blok Try...Catch...Finally Statement. Try Blok yang memiliki Yield pernyataan dapat memiliki Catch blok, dan dapat memiliki Finally blok.

Contoh berikut mencakup Try, Catch, dan Finally blok dalam fungsi iterator. Finally Blok dalam fungsi iterator dijalankan sebelum perulangan For Each selesai.

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

Pernyataan Yield tidak boleh berada di dalam blok Catch atau blok Finally.

Jika badan For Each (alih-alih metode iterator) melempar pengecualian, blok Catch dalam fungsi iterator tidak dijalankan, tetapi blok Finally dalam fungsi iterator dijalankan. Blok Catch di dalam fungsi iterator hanya menangkap pengecualian yang terjadi di dalam fungsi iterator.

Metode Anonim

Di Visual Basic, fungsi anonim dapat menjadi fungsi iterator. Contoh berikut mengilustrasikan hal ini.

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

Contoh berikut memiliki metode non-iterator yang memvalidasi argumen. Metode mengembalikan hasil iterator anonim yang menjelaskan elemen koleksi.

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

Jika validasi berada di dalam fungsi iterator, validasi tidak dapat dilakukan hingga dimulainya perulangan pertama pada bagian For Each.

Menggunakan Iterator dengan Daftar Generik

Dalam contoh berikut, Stack(Of T) kelas generik mengimplementasikan IEnumerable<T> antarmuka generik. Metode Push menetapkan nilai ke array bertipe T. Metode GetEnumerator mengembalikan nilai array dengan menggunakan Yield pernyataan .

Selain metode generik GetEnumerator , metode non-generik GetEnumerator juga harus diimplementasikan. Ini karena IEnumerable<T> mewarisi dari IEnumerable. Implementasi non-generik menangguhkan implementasi generik.

Contoh menggunakan iterator bernama untuk mendukung berbagai cara iterasi melalui pengumpulan data yang sama. Iterator yang dinamai ini adalah properti TopToBottom dan BottomToTop, serta metode TopN.

Deklarasi BottomToTop properti menyertakan Iterator kata kunci.

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

Informasi Sintaks

Iterator dapat berupa metode atau get aksesor. Iterator tidak dapat terjadi dalam peristiwa, konstruktor instans, konstruktor statis, atau destruktor statis.

Konversi implisit harus ada dari tipe ekspresi dalam pernyataan Yield ke tipe pengembalian iterator.

Di Visual Basic, metode iterator tidak dapat memiliki parameter apa pun ByRef .

Di Visual Basic, "Yield" bukan kata cadangan dan hanya memiliki arti khusus ketika digunakan dalam metode Iterator atau aksesor get.

Implementasi Teknis

Meskipun Anda menulis iterator sebagai metode, kompilator menerjemahkannya ke dalam kelas bersarang yang, pada dasarnya, adalah mesin status. Kelas ini melacak posisi iterator selama perulangan For Each...Next dalam kode klien berlanjut.

Untuk melihat apa yang dilakukan pengkompilasi, Anda dapat menggunakan alat Ildasm.exe untuk melihat kode bahasa perantara umum yang dihasilkan untuk metode iterator.

Saat Anda membuat iterator untuk kelas atau struktur, Anda tidak perlu mengimplementasikan seluruh IEnumerator antarmuka. Ketika kompilator mendeteksi iterator, kompilator secara otomatis menghasilkan Currentmetode , MoveNext, dan Dispose antarmuka IEnumerator atau IEnumerator<T> .

Pada setiap iterasi berturut-turut dari For Each…Next (atau panggilan langsung ke IEnumerator.MoveNext), badan kode iterator berikutnya berlanjut setelah pernyataan Yield sebelumnya. Kemudian berlanjut ke pernyataan berikutnya Yield sampai akhir isi iterator tercapai, atau sampai pernyataan Exit Function atau Return ditemui.

Iterator tidak mendukung metode IEnumerator.Reset. Untuk melakukan iterasi ulang sejak awal, Anda harus mendapatkan iterator baru.

Untuk informasi tambahan, lihat Spesifikasi Bahasa Visual Basic.

Penggunaan Iterator

Iterator memungkinkan Anda untuk mempertahankan kesederhanaan For Each perulangan ketika Anda perlu menggunakan kode kompleks untuk mengisi urutan daftar. Ini bisa berguna ketika Anda ingin melakukan hal berikut:

Ubah urutan daftar setelah iterasi pertama For Each loop.
Hindari memuat daftar besar sepenuhnya sebelum iterasi pertama perulangan For Each . Contohnya adalah pengambilan halaman untuk memuat batch baris tabel. Contoh lain adalah EnumerateFiles metode , yang mengimplementasikan iterator dalam .NET Framework.
Merangkum pembuatan daftar di iterator. Dalam metode iterator, Anda dapat membuat daftar dan kemudian menghasilkan setiap hasil dalam perulangan.

Lihat juga

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2025-06-17