Iteradores (Visual Basic)
Um iterador pode ser usado para percorrer coleções como listas e matrizes.
Um método iterador ou get acessador executa uma iteração personalizada em uma coleção. Um método iterador usa a instrução Yield para retornar cada elemento, um de cada vez. Quando uma Yield instrução é alcançada, o local atual no código é lembrado. A execução é reiniciada a partir desse local na próxima vez que a função iterador for chamada.
Você consome um iterador do código do cliente usando um For Each... Próxima instrução ou usando uma consulta LINQ.
No exemplo a seguir, a primeira iteração do loop faz com que a For EachSomeNumbers execução prossiga no método iterator até que a primeira Yield instrução seja atingida. Essa iteração retorna um valor de 3 e o local atual no método iterador é mantido. Na próxima iteração do loop, a execução no método iterator continua de onde parou, parando novamente quando atinge uma Yield instrução. Essa iteração retorna um valor de 5 e o local atual no método iterador é novamente mantido. O loop é concluído quando o final do método iterador é atingido.
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
O tipo de retorno de um método iterador ou get acessador pode ser IEnumerable, IEnumerable<T>, IEnumerator, ou IEnumerator<T>.
Você pode usar uma Exit Function instrução or para Return encerrar a iteração.
Uma função de iterador do Visual Basic ou get declaração de acessador inclui um modificador de iterador .
Os iteradores foram introduzidos no Visual Basic no Visual Studio 2012.
Nota
Para todos os exemplos no artigo, exceto o exemplo do Iterador Simples, inclua instruções Imports para os System.Collections namespaces e System.Collections.Generic .
Iterador simples
O exemplo a seguir tem uma única Yield instrução que está dentro de um For... Próximo ciclo. No Main, cada iteração do For Each corpo da instrução cria uma chamada para a função iterador, que prossegue para a próxima Yield instrução.
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
Criando uma classe de coleção
No exemplo a seguir, a DaysOfTheWeek classe implementa a IEnumerable interface, que requer um GetEnumerator método. O compilador chama implicitamente o GetEnumerator método, que retorna um IEnumeratorarquivo .
O GetEnumerator método retorna cada cadeia de caracteres uma de cada vez usando a Yield instrução e um Iterator modificador está na declaração de função.
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
O exemplo a seguir cria uma Zoo classe que contém uma coleção de animais.
A For Each instrução que se refere à instância de classe (theZoo) chama implicitamente o GetEnumerator método. As For Each instruções que se referem às Birds propriedades e Mammals usam o AnimalsForType método iterador nomeado.
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
Experimente os blocos
Visual Basic permite uma Yield instrução no Try bloco de um Try... Pegar... Finalmente Declaração. Um Try bloco que tem uma Yield instrução pode ter Catch blocos e pode ter um Finally bloco.
O exemplo a seguir inclui Try, Catch, e Finally blocos em uma função iteradora. O Finally bloco na função iterador é executado antes que a For Each iteração termine.
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
Uma Yield instrução não pode estar dentro de um Catch bloco ou de um Finally bloco.
Se o For Each corpo (em vez do método iterator) lançar uma exceção, um Catch bloco na função iterador não será executado, mas um Finally bloco na função iterador será executado. Um Catch bloco dentro de uma função iteradora captura apenas exceções que ocorrem dentro da função iterador.
Métodos Anônimos
No Visual Basic, uma função anônima pode ser uma função iteradora. O exemplo a seguir ilustra isso.
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()
O exemplo a seguir tem um método não-iterador que valida os argumentos. O método retorna o resultado de um iterador anônimo que descreve os elementos de coleção.
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, em vez disso, a validação estiver dentro da função iteradora, a validação não poderá ser executada até o início da primeira iteração do For Each corpo.
Usando iteradores com uma lista genérica
No exemplo a seguir, a Stack(Of T) classe generic implementa a IEnumerable<T> interface genérica. O Push método atribui valores a uma matriz do tipo T. O GetEnumerator método retorna os valores de matriz usando a Yield instrução.
Além do método genérico GetEnumerator , o método não genérico GetEnumerator também deve ser implementado. Isso ocorre porque IEnumerable<T> herda de IEnumerable. A implementação não genérica adia para a implementação genérica.
O exemplo usa iteradores nomeados para dar suporte a várias maneiras de iteração através da mesma coleção de dados. Esses iteradores nomeados são as propriedades e BottomToTop e TopToBottom o TopN método.
A BottomToTop declaração de propriedade inclui a palavra-chave Iterator .
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
Informações de sintaxe
Um iterador pode ocorrer como um método ou get acessador. Um iterador não pode ocorrer em um evento, construtor de instância, construtor estático ou destruidor estático.
Uma conversão implícita deve existir do tipo de expressão na Yield instrução para o tipo de retorno do iterador.
No Visual Basic, um método iterador não pode ter parâmetros ByRef .
No Visual Basic, "Yield" não é uma palavra reservada e tem significado especial apenas quando é usada em um Iterator método ou get acessador.
Implementação Técnica
Embora você escreva um iterador como um método, o compilador o traduz em uma classe aninhada que é, na verdade, uma máquina de estado. Essa classe mantém o controle da posição do iterador enquanto o For Each...Next loop no código do cliente continua.
Para ver o que o compilador faz, você pode usar a ferramenta Ildasm.exe para exibir o código de linguagem intermediária comum que é gerado para um método iterador.
Quando você cria um iterador para uma classe ou struct, não é necessário implementar a interface inteira IEnumerator . Quando o compilador deteta o iterador, ele gera automaticamente o Current, MoveNexte Dispose métodos da IEnumerator interface ou IEnumerator<T> .
Em cada iteração sucessiva do loop (ou a chamada direta para IEnumerator.MoveNext), o próximo corpo de For Each…Next código do iterador é retomado após a instrução anteriorYield. Em seguida, continua para a próxima Yield instrução até que o final do corpo iterador seja atingido, ou até que uma Exit Function instrução ou Return seja encontrada.
Os iteradores não suportam o IEnumerator.Reset método. Para repetir desde o início, você deve obter um novo iterador.
Para obter informações adicionais, consulte a especificação de linguagem Visual Basic.
Uso de iteradores
Os iteradores permitem que você mantenha a simplicidade de um For Each loop quando precisar usar código complexo para preencher uma sequência de lista. Isso pode ser útil quando você deseja fazer o seguinte:
Modifique a sequência da lista após a primeira
For Eachiteração de loop.Evite carregar totalmente uma lista grande antes da primeira iteração de um
For Eachloop. Um exemplo é uma busca paginada para carregar um lote de linhas de tabela. Outro exemplo é o EnumerateFiles método, que implementa iteradores dentro do .NET Framework.Encapsular a criação da lista no iterador. No método iterator, você pode criar a lista e, em seguida, produzir cada resultado em um loop.
