Iterator może służyć do przechodzenia przez kolekcje, takie jak listy i tablice.
Metoda iteratora lub get metoda dostępu wykonuje iterację niestandardową w kolekcji. Metoda iteratora używa instrukcji Yield , aby zwrócić każdy element pojedynczo. Yield Po osiągnięciu instrukcji zostanie zapamiętana bieżąca lokalizacja w kodzie. Wykonanie jest uruchamiane ponownie z tej lokalizacji przy następnym wywołaniu funkcji iteratora.
Iterator jest używany z kodu klienta przy użyciu elementu dla każdego... Następna instrukcja lub przy użyciu zapytania LINQ.
W poniższym przykładzie pierwsza iteracja For Each pętli powoduje kontynuowanie wykonywania w SomeNumbers metodzie iteratora do momentu osiągnięcia pierwszej Yield instrukcji. Ta iteracja zwraca wartość 3, a bieżąca lokalizacja w metodzie iteratora jest zachowywana. W następnej iteracji pętli wykonywanie w metodzie iteratora jest kontynuowane od miejsca, w którym została przerwana, ponownie zatrzymując się, gdy osiągnie instrukcję Yield . Ta iteracja zwraca wartość 5, a bieżąca lokalizacja w metodzie iteratora jest ponownie zachowywana. Pętla kończy się po osiągnięciu końca metody iteratora.
VB
Sub Main()
ForEach number AsIntegerIn SomeNumbers()
Console.Write(number & " ")
Next' Output: 3 5 8
Console.ReadKey()
EndSubPrivateIteratorFunction SomeNumbers() As System.Collections.IEnumerable
Yield3Yield5Yield8EndFunction
Możesz użyć instrukcji Exit Function or Return , aby zakończyć iterację.
Funkcja iteratora języka Visual Basic lub get deklaracja metody dostępu zawiera modyfikator iteratora .
Iteratory zostały wprowadzone w Visual Basic w programie Visual Studio 2012.
Uwaga
Dla wszystkich przykładów w artykule z wyjątkiem prostego przykładu iteratora dołącz instrukcje Import dla System.Collections przestrzeni nazw i System.Collections.Generic .
Prosty iterator
Poniższy przykład zawiera pojedynczą Yield instrukcję, która znajduje się wewnątrz elementu For... Następna pętla. W Mainpliku każda iteracja For Each treści instrukcji tworzy wywołanie funkcji iteratora, która przechodzi do następnej Yield instrukcji.
VB
Sub Main()
ForEach number AsIntegerIn EvenSequence(5, 18)
Console.Write(number & " ")
Next' Output: 6 8 10 12 14 16 18
Console.ReadKey()
EndSubPrivateIteratorFunction EvenSequence(
ByVal firstNumber AsInteger, ByVal lastNumber AsInteger) _
As System.Collections.Generic.IEnumerable(OfInteger)
' Yield even numbers in the range.For number AsInteger = firstNumber To lastNumber
If number Mod2 = 0ThenYield number
EndIfNextEndFunction
Tworzenie klasy kolekcji
W poniższym przykładzie DaysOfTheWeek klasa implementuje IEnumerable interfejs, który wymaga GetEnumerator metody. Kompilator niejawnie wywołuje metodę GetEnumerator , która zwraca IEnumeratorelement .
Metoda GetEnumerator zwraca każdy ciąg pojedynczo przy użyciu instrukcji Yield , a Iterator modyfikator znajduje się w deklaracji funkcji.
VB
Sub Main()
Dim days AsNew DaysOfTheWeek()
ForEach day AsStringIn days
Console.Write(day & " ")
Next' Output: Sun Mon Tue Wed Thu Fri Sat
Console.ReadKey()
EndSubPrivateClass DaysOfTheWeek
Implements IEnumerable
Public days =
NewString() {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}
PublicIteratorFunction GetEnumerator() As IEnumerator _
Implements IEnumerable.GetEnumerator
' Yield each day of the week.For i AsInteger = 0To days.Length - 1Yield days(i)
NextEndFunctionEndClass
Poniższy przykład tworzy klasę Zoo zawierającą kolekcję zwierząt.
Instrukcja For Each , która odwołuje się do wystąpienia klasy (theZoo) niejawnie wywołuje metodę GetEnumerator . Instrukcje For Each odwołujące się do Birds właściwości i Mammals używają metody nazwanej AnimalsForType iteratora.
VB
Sub Main()
Dim theZoo AsNew Zoo()
theZoo.AddMammal("Whale")
theZoo.AddMammal("Rhinoceros")
theZoo.AddBird("Penguin")
theZoo.AddBird("Warbler")
ForEach name AsStringIn theZoo
Console.Write(name & " ")
Next
Console.WriteLine()
' Output: Whale Rhinoceros Penguin WarblerForEach name AsStringIn theZoo.Birds
Console.Write(name & " ")
Next
Console.WriteLine()
' Output: Penguin WarblerForEach name AsStringIn theZoo.Mammals
Console.Write(name & " ")
Next
Console.WriteLine()
' Output: Whale Rhinoceros
Console.ReadKey()
EndSubPublicClass Zoo
Implements IEnumerable
' Private members.Private animals AsNew List(Of Animal)
' Public methods.PublicSub AddMammal(ByVal name AsString)
animals.Add(New Animal With {.Name = name, .Type = Animal.TypeEnum.Mammal})
EndSubPublicSub AddBird(ByVal name AsString)
animals.Add(New Animal With {.Name = name, .Type = Animal.TypeEnum.Bird})
EndSubPublicIteratorFunction GetEnumerator() As IEnumerator _
Implements IEnumerable.GetEnumerator
ForEach theAnimal As Animal In animals
Yield theAnimal.Name
NextEndFunction' Public members.PublicReadOnlyProperty Mammals As IEnumerable
GetReturn AnimalsForType(Animal.TypeEnum.Mammal)
EndGetEndPropertyPublicReadOnlyProperty Birds As IEnumerable
GetReturn AnimalsForType(Animal.TypeEnum.Bird)
EndGetEndProperty' Private methods.PrivateIteratorFunction AnimalsForType( _
ByVal type As Animal.TypeEnum) As IEnumerable
ForEach theAnimal As Animal In animals
If (theAnimal.Type = type) ThenYield theAnimal.Name
EndIfNextEndFunction' Private class.PrivateClass Animal
PublicEnum TypeEnum
Bird
Mammal
EndEnumPublicProperty Name AsStringPublicProperty Type As TypeEnum
EndClassEndClass
Bloki try
Visual Basic zezwala na Try instrukcję Yield w bloku Try... Złapać... Finally, instrukcja. Blok Try zawierający instrukcję Yield może zawierać Catch bloki i może mieć Finally blok.
Poniższy przykład obejmuje Trybloki , Catchi Finally w funkcji iteratora. Blok Finally w funkcji iteratora jest wykonywany przed zakończeniem For Each iteracji.
VB
Sub Main()
ForEach number AsIntegerIn 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()
EndSubPrivateIteratorFunction Test() As IEnumerable(OfInteger)
TryYield3Yield4ThrowNew Exception("Something happened. Yields are done.")
Yield5Yield6Catch ex As Exception
Console.WriteLine(ex.Message)
Finally
Console.WriteLine("Finally is called.")
EndTryEndFunction
Instrukcja Yield nie może znajdować się wewnątrz Catch bloku lub Finally bloku.
For Each Jeśli treść (zamiast metody iteratora) zgłasza wyjątek, Catch blok w funkcji iteratora nie jest wykonywany, ale Finally jest wykonywany blok w funkcji iteratora. Blok Catch wewnątrz funkcji iteratora przechwytuje tylko wyjątki występujące wewnątrz funkcji iteratora.
Metody anonimowe
W języku Visual Basic funkcja anonimowa może być funkcją iteratora. Ilustruje to poniższy przykład.
VB
Dim iterateSequence = IteratorFunction() _
As IEnumerable(OfInteger)
Yield1Yield2EndFunctionForEach number AsIntegerIn iterateSequence()
Console.Write(number & " ")
Next' Output: 1 2
Console.ReadKey()
Poniższy przykład zawiera metodę inną niż iterator, która weryfikuje argumenty. Metoda zwraca wynik anonimowego iteratora opisującego elementy kolekcji.
VB
Sub Main()
ForEach number AsIntegerIn GetSequence(5, 10)
Console.Write(number & " ")
Next' Output: 5 6 7 8 9 10
Console.ReadKey()
EndSubPublicFunction GetSequence(ByVal low AsInteger, ByVal high AsInteger) _
As IEnumerable
' Validate the arguments.If low < 1ThenThrowNew ArgumentException("low is too low")
EndIfIf high > 140ThenThrowNew ArgumentException("high is too high")
EndIf' Return an anonymous iterator function.Dim iterateSequence = IteratorFunction() As IEnumerable
For index = low To high
Yield index
NextEndFunctionReturn iterateSequence()
EndFunction
Jeśli walidacja znajduje się zamiast tego wewnątrz funkcji iteratora, nie można wykonać walidacji do momentu rozpoczęcia pierwszej iteracji For Each treści.
Używanie iteratorów z listą ogólną
W poniższym przykładzie Stack(Of T) klasa ogólna implementuje IEnumerable<T> interfejs ogólny. Metoda Push przypisuje wartości do tablicy typu T. Metoda GetEnumerator zwraca wartości tablicy przy użyciu instrukcji Yield .
Oprócz metody ogólnej GetEnumerator należy również zaimplementować metodę niegeneryjną GetEnumerator . Dzieje się tak, ponieważ IEnumerable<T> dziedziczy z elementu IEnumerable. Implementacja niegeneryczna odchyli się od implementacji ogólnej.
W przykładzie użyto iteratorów nazwanych do obsługi różnych sposobów iteracji za pośrednictwem tej samej kolekcji danych. Te nazwane iteratory są TopToBottom właściwościami i BottomToTop oraz TopN metodą .
Deklaracja BottomToTop właściwości zawiera Iterator słowo kluczowe .
VB
Sub Main()
Dim theStack AsNew Stack(OfInteger)
' Add items to the stack.For number AsInteger = 0To9
theStack.Push(number)
Next' Retrieve items from the stack.' For Each is allowed because theStack implements' IEnumerable(Of Integer).ForEach number AsIntegerIn 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).ForEach number AsIntegerIn theStack.TopToBottom
Console.Write("{0} ", number)
Next
Console.WriteLine()
' Output: 9 8 7 6 5 4 3 2 1 0ForEach number AsIntegerIn theStack.BottomToTop
Console.Write("{0} ", number)
Next
Console.WriteLine()
' Output: 0 1 2 3 4 5 6 7 8 9ForEach number AsIntegerIn theStack.TopN(7)
Console.Write("{0} ", number)
Next
Console.WriteLine()
' Output: 9 8 7 6 5 4 3
Console.ReadKey()
EndSubPublicClass Stack(Of T)
Implements IEnumerable(Of T)
Private values As T() = New T(99) {}
Private top AsInteger = 0PublicSub Push(ByVal t As T)
values(top) = t
top = top + 1EndSubPublicFunction Pop() As T
top = top - 1Return values(top)
EndFunction' This function implements the GetEnumerator method. It allows' an instance of the class to be used in a For Each statement.PublicIteratorFunction GetEnumerator() As IEnumerator(Of T) _
Implements IEnumerable(Of T).GetEnumerator
For index AsInteger = top - 1To0Step-1Yield values(index)
NextEndFunctionPublicIteratorFunction GetEnumerator1() As IEnumerator _
Implements IEnumerable.GetEnumerator
Yield GetEnumerator()
EndFunctionPublicReadOnlyProperty TopToBottom() As IEnumerable(Of T)
GetReturnMeEndGetEndPropertyPublicReadOnlyIteratorProperty BottomToTop As IEnumerable(Of T)
GetFor index AsInteger = 0To top - 1Yield values(index)
NextEndGetEndPropertyPublicIteratorFunction TopN(ByVal itemsFromTop AsInteger) _
As IEnumerable(Of T)
' Return less than itemsFromTop if necessary.Dim startIndex AsInteger =
If(itemsFromTop >= top, 0, top - itemsFromTop)
For index AsInteger = top - 1To startIndex Step-1Yield values(index)
NextEndFunctionEndClass
Informacje o składni
Iterator może wystąpić jako metoda lub get metoda dostępu. Iterator nie może wystąpić w przypadku zdarzenia, konstruktora wystąpienia, konstruktora statycznego lub destruktora statycznego.
Niejawna konwersja musi istnieć z typu wyrażenia w instrukcji Yield do zwracanego typu iteratora.
W języku Visual Basic metoda iteratora nie może mieć żadnych ByRef parametrów.
W języku Visual Basic "Yield" nie jest słowem zarezerwowanym i ma specjalne znaczenie tylko wtedy, gdy jest używany w Iterator metodzie lub get metodzie dostępu.
Realizacja techniczna
Mimo że iterator jest zapisywany jako metoda, kompilator tłumaczy go na klasę zagnieżdżoną, która jest w efekcie maszyną stanu. Ta klasa śledzi położenie iteratora, dopóki pętla For Each...Next w kodzie klienta będzie kontynuowana.
Aby zobaczyć, co robi kompilator, możesz użyć narzędzia Ildasm.exe, aby wyświetlić wspólny kod języka pośredniego wygenerowany dla metody iteratora.
Podczas tworzenia iteratora dla klasy lub struktury nie trzeba implementować całego IEnumerator interfejsu. Gdy kompilator wykryje iterator, automatycznie generuje Currentmetody , MoveNexti Dispose interfejsu IEnumerator .IEnumerator<T>
W każdej kolejnej For Each…Next iteracji pętli (lub wywołania bezpośredniego do IEnumerator.MoveNext), następna treść kodu iteratora zostanie wznowione po poprzedniej Yield instrukcji. Następnie kontynuuje kolejną Yield instrukcję do końca treści iteratora lub do momentu Exit Function napotkania instrukcji or Return .
Iteratory nie obsługują IEnumerator.Reset metody . Aby ponownie wykonać iterację od początku, należy uzyskać nowy iterator.
Aby uzyskać dodatkowe informacje, zobacz Specyfikację języka Visual Basic.
Korzystanie z iteratorów
Iteratory umożliwiają utrzymanie prostoty pętli, gdy trzeba użyć złożonego For Each kodu do wypełnienia sekwencji listy. Może to być przydatne, jeśli chcesz wykonać następujące czynności:
Zmodyfikuj sekwencję listy po iteracji pierwszej For Each pętli.
Unikaj pełnego ładowania dużej listy przed pierwszą For Each iterację pętli. Przykładem jest pobieranie stronicowane w celu załadowania partii wierszy tabeli. Innym przykładem jest EnumerateFiles metoda, która implementuje iteratory w programie .NET Framework.
Hermetyzowanie tworzenia listy w iteratorze. W metodzie iteratora można utworzyć listę, a następnie uzyskać każdy wynik w pętli.
Źródło tej zawartości można znaleźć w witrynie GitHub, gdzie można również tworzyć i przeglądać problemy i żądania ściągnięcia. Więcej informacji znajdziesz w naszym przewodniku dla współtwórców.
Opinia o produkcie .NET
.NET to projekt typu open source. Wybierz link, aby przekazać opinię:
Dołącz do serii meetup, aby tworzyć skalowalne rozwiązania sztucznej inteligencji oparte na rzeczywistych przypadkach użycia z innymi deweloperami i ekspertami.