Поделиться через

Итераторы (Visual Basic)

Итератор можно использовать для пошагового выполнения коллекций, таких как списки и массивы.

Метод итератора или get аксессор выполняет настраиваемую итерацию по коллекции. Метод итератора использует инструкцию Yield для возврата каждого элемента по одному за раз. После достижения инструкции запоминается текущее Yield расположение в коде. Выполнение перезапускается из этого расположения при следующем вызове функции итератора.

Вы используете итератор из клиентского кода с помощью For Each... Next оператора или используя запрос LINQ.

В следующем примере первая итерация For Each цикла приводит к тому, что выполнение продолжается в методе итератора SomeNumbers до того, как будет достигнута первая Yield инструкция. Эта итерация возвращает значение 3, а текущее расположение в методе итератора сохраняется. В следующей итерации цикла выполнение в методе итератора продолжается с того места, где он остался, снова остановившись при достижении инструкции Yield . Эта итерация возвращает значение 5, а текущее расположение в методе итератора снова сохраняется. Цикл завершается после достижения конца метода итератора.

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

Возвращаемый тип метода итератора или аксессора get может быть IEnumerable, IEnumerable<T>, IEnumerator или IEnumerator<T>.

Для завершения итерации можно использовать Exit Function инструкцию или Return инструкцию.

Функция итератора Visual Basic или декларация аксессора get включает модификатор итератора.

Итераторы появились в Visual Basic в Visual Studio 2012.

Замечание

Для всех примеров в статье, кроме примера Simple Iterator, включите инструкции Imports для пространств имен System.Collections и System.Collections.Generic.

Простой итератор

В следующем примере есть одна Yield инструкция внутри цикла For…Next. В Mainкаждом итерации текста инструкции For Each создается вызов функции итератора, которая переходит к следующей 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

Создание класса коллекции

В следующем примере DaysOfTheWeek класс реализует IEnumerable интерфейс, для которого требуется GetEnumerator метод. Компилятор неявно вызывает GetEnumerator метод, который возвращает IEnumerator.

Метод GetEnumerator возвращает каждую строку по одному элементу за раз с помощью инструкции Yield, а модификатор Iterator находится в объявлении функции.

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

В следующем примере создается Zoo класс, содержащий коллекцию животных.

Оператор For Each, ссылающийся на экземпляр класса (theZoo), неявно вызывает метод GetEnumerator. Инструкции For Each, ссылающиеся на свойства Birds и Mammals, используют метод именованного итератора 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

Пробные блоки

Visual Basic позволяет оператору YieldTry в блоке Try...Catch...Finally. Блок Try, содержащий оператор Yield, может иметь блоки Catch и блок Finally.

В следующем примере содержатся Try, Catch, и Finally блоки в функции итератора. В функции итератора блок Finally выполняется до завершения 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

Оператор Yield не может находиться внутри Catch блока или Finally блока.

Если тело For Each (вместо метода итератора) вызывает исключение, Catch блок в функции итератора не выполняется, но блок Finally в функции итератора выполняется. Блок Catch внутри функции итератора перехватывает только исключения, происходящие внутри функции итератора.

Анонимные методы

В Visual Basic анонимная функция может быть итератором. В следующем примере показано это.

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

В следующем примере есть метод, отличный от итератора, который проверяет аргументы. Метод возвращает результат анонимного итератора, описывающего элементы коллекции.

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

Если проверка находится внутри функции итератора, она не может быть выполнена до начала первой итерации For Each тела.

Использование итераторов с универсальным списком

В следующем примере универсальный Stack(Of T) класс реализует универсальный IEnumerable<T> интерфейс. Метод Push назначает значения массиву типов T. Метод GetEnumerator возвращает значения массива с помощью инструкции Yield .

В дополнение к обобщенному методу GetEnumerator, также должен быть реализован не обобщенный метод GetEnumerator. Это связано с тем, что IEnumerable<T> наследует от IEnumerable. Не универсальная реализация откладывает универсальную реализацию.

В примере используются именованные итераторы для поддержки различных способов итерации по одной коллекции данных. Эти именованные итераторы — TopToBottom и свойства BottomToTop, а также метод TopN.

Объявление свойства включает ключевое слово BottomToTopIterator.

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

Сведения о синтаксисе

Итератор может выполняться как метод или get метод доступа. Итератор не может использоваться в событии, конструкторе экземпляра, статическом конструкторе или статическом деструкторе.

Неявное преобразование должно существовать из типа выражения в операторе Yield в тип возвращаемого значения итератора.

В Visual Basic метод итератора не может иметь никаких ByRef параметров.

В Visual Basic "Yield" не является зарезервированным словом и имеет особое значение, только когда используется в Iterator методе или get аксессоре.

Техническая реализация

Хотя вы пишете итератор в качестве метода, компилятор преобразует его в вложенный класс, который, в действительности, является компьютером состояния. Этот класс отслеживает положение итератора до тех пор, пока For Each...Next цикл в клиентском коде продолжается.

Чтобы узнать, что делает компилятор, можно использовать средство Ildasm.exe для просмотра кода общего промежуточного языка, созданного для метода итератора.

При создании итератора для класса или структуры не требуется реализовать весь IEnumerator интерфейс. Когда компилятор обнаруживает итератор, он автоматически создает методы Current, MoveNext и Dispose интерфейса IEnumerator или IEnumerator<T>.

При каждой последовательной For Each…Next итерации цикла (или прямого вызова IEnumerator.MoveNext), следующий текст кода итератора возобновляется после предыдущей Yield инструкции. Затем он продолжается до следующего Yield оператора до конца тела итератора или пока не будет обнаружен Exit Function или Return оператор.

Итераторы не поддерживают метод IEnumerator.Reset. Чтобы повторно выполнить итерацию с самого начала, необходимо получить новый итератор.

Дополнительные сведения см. в спецификации языка Visual Basic.

Использование итераторов

Итераторы позволяют поддерживать простоту For Each цикла, если необходимо использовать сложный код для заполнения последовательности списков. Это может быть полезно, если вы хотите сделать следующее:

  • Измените последовательность списков после первой For Each итерации цикла.

  • Избегайте полной загрузки большого For Each списка перед первой итерацией цикла. Примером является постраничная выборка для пакетной загрузки строк таблицы. Другим примером EnumerateFiles является метод, реализующий итераторы в .NET Framework.

  • Инкапсулируйте процесс создания списка в итераторе. В методе итератора можно создать список, а затем получить каждый результат в цикле.

См. также