Iterator (C#)
Iterator dapat digunakan untuk menelusuri koleksi seperti daftar dan larik.
Metode iterator atau pengakses get melakukan iterasi kustom pada koleksi. Metode iterator menggunakan pernyataan yield return untuk mengembalikan setiap elemen satu per satu. Saat pernyataan yield return pengembalian tercapai, lokasi saat ini dalam kode diingat. Eksekusi dimulai ulang dari lokasi tersebut pada saat fungsi iterator dipanggil.
Anda menggunakan iterator dari kode klien dengan menggunakan pernyataan foreach atau dengan menggunakan kueri LINQ.
Dalam contoh berikut, iterasi pertama perulangan foreach menyebabkan eksekusi dilanjutkan dalam metode iterator SomeNumbers hingga pernyataan yield return pertama tercapai. Iterasi ini mengembalikan nilai 3, dan lokasi saat ini dalam metode iterator dipertahankan. Pada iterasi perulangan berikutnya, eksekusi dalam metode iterator berlanjut dari tempat ia berhenti, dan berhenti lagi saat mencapai pernyataan yield return. Iterasi ini mengembalikan nilai 5, dan lokasi saat ini dalam metode iterator kembali dipertahankan. Perulangan selesai ketika akhir metode iterator tercapai.
static void Main()
{
foreach (int number in SomeNumbers())
{
Console.Write(number.ToString() + " ");
}
// Output: 3 5 8
Console.ReadKey();
}
public static System.Collections.IEnumerable SomeNumbers()
{
yield return 3;
yield return 5;
yield return 8;
}
Jenis pengembalian metode iterator atau pengakses get dapat berupa IEnumerable, IEnumerable<T>, IEnumerator, atau IEnumerator<T>.
Anda dapat menggunakan pernyataan yield break untuk mengakhiri iterasi.
Catatan
Untuk semua contoh dalam topik ini kecuali contoh Simple Iterator, sertakan penggunaan direktif untuk namespace layanan System.Collections dan System.Collections.Generic.
Iterator Sederhana
Contoh berikut memiliki satu pernyataan yield return yang ada di dalam perulangan for. Dalam Main, setiap iterasi isi pernyataan foreach membuat panggilan ke fungsi iterator, yang berlanjut ke pernyataan yield return berikutnya.
static void Main()
{
foreach (int number in EvenSequence(5, 18))
{
Console.Write(number.ToString() + " ");
}
// Output: 6 8 10 12 14 16 18
Console.ReadKey();
}
public static System.Collections.Generic.IEnumerable<int>
EvenSequence(int firstNumber, int lastNumber)
{
// Yield even numbers in the range.
for (int number = firstNumber; number <= lastNumber; number++)
{
if (number % 2 == 0)
{
yield return number;
}
}
}
Membuat Kelas Koleksi
Dalam contoh berikut, kelas DaysOfTheWeek mengimplementasikan antarmuka IEnumerable, yang memerlukan metode GetEnumerator. Pengompilasi secara implisit memanggil metode GetEnumerator, yang mengembalikan IEnumerator.
Metode GetEnumerator mengembalikan setiap string satu per satu menggunakan pernyataan yield return.
static void Main()
{
DaysOfTheWeek days = new DaysOfTheWeek();
foreach (string day in days)
{
Console.Write(day + " ");
}
// Output: Sun Mon Tue Wed Thu Fri Sat
Console.ReadKey();
}
public class DaysOfTheWeek : IEnumerable
{
private string[] days = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
public IEnumerator GetEnumerator()
{
for (int index = 0; index < days.Length; index++)
{
// Yield each day of the week.
yield return days[index];
}
}
}
Contoh berikut membuat kelas Zoo yang berisi kumpulan hewan.
Pernyataan foreach yang mengacu pada instans kelas (theZoo) secara implisit memanggil metode GetEnumerator. Pernyataan foreach yang merujuk ke properti Birds dan Mammals menggunakan metode iterator bernama AnimalsForType.
static void Main()
{
Zoo theZoo = new Zoo();
theZoo.AddMammal("Whale");
theZoo.AddMammal("Rhinoceros");
theZoo.AddBird("Penguin");
theZoo.AddBird("Warbler");
foreach (string name in theZoo)
{
Console.Write(name + " ");
}
Console.WriteLine();
// Output: Whale Rhinoceros Penguin Warbler
foreach (string name in theZoo.Birds)
{
Console.Write(name + " ");
}
Console.WriteLine();
// Output: Penguin Warbler
foreach (string name in theZoo.Mammals)
{
Console.Write(name + " ");
}
Console.WriteLine();
// Output: Whale Rhinoceros
Console.ReadKey();
}
public class Zoo : IEnumerable
{
// Private members.
private List<Animal> animals = new List<Animal>();
// Public methods.
public void AddMammal(string name)
{
animals.Add(new Animal { Name = name, Type = Animal.TypeEnum.Mammal });
}
public void AddBird(string name)
{
animals.Add(new Animal { Name = name, Type = Animal.TypeEnum.Bird });
}
public IEnumerator GetEnumerator()
{
foreach (Animal theAnimal in animals)
{
yield return theAnimal.Name;
}
}
// Public members.
public IEnumerable Mammals
{
get { return AnimalsForType(Animal.TypeEnum.Mammal); }
}
public IEnumerable Birds
{
get { return AnimalsForType(Animal.TypeEnum.Bird); }
}
// Private methods.
private IEnumerable AnimalsForType(Animal.TypeEnum type)
{
foreach (Animal theAnimal in animals)
{
if (theAnimal.Type == type)
{
yield return theAnimal.Name;
}
}
}
// Private class.
private class Animal
{
public enum TypeEnum { Bird, Mammal }
public string Name { get; set; }
public TypeEnum Type { get; set; }
}
}
Menggunakan Iterator dengan Daftar Generik
Dalam contoh berikut, kelas generik Stack<T> mengimplementasikan antarmuka generik IEnumerable<T>. Metode Push menetapkan nilai ke larik jenis T. Metode GetEnumerator mengembalikan nilai larik dengan menggunakan pernyataan yield return.
Selain metode GetEnumerator generik, metode GetEnumerator non-generik juga harus diimplementasikan. Ini karena IEnumerable<T> mewarisi dari IEnumerable. Implementasi non-generik tunduk kepada implementasi generik.
Contoh ini menggunakan iterator bernama untuk mendukung berbagai cara iterasi melalui pengumpulan data yang sama. Iterator bernama ini adalah properti TopToBottom dan BottomToTop, dan metode TopN.
Properti BottomToTop menggunakan iterator di pengakses get.
static void Main()
{
Stack<int> theStack = new Stack<int>();
// Add items to the stack.
for (int number = 0; number <= 9; number++)
{
theStack.Push(number);
}
// Retrieve items from the stack.
// foreach is allowed because theStack implements IEnumerable<int>.
foreach (int number in theStack)
{
Console.Write("{0} ", number);
}
Console.WriteLine();
// Output: 9 8 7 6 5 4 3 2 1 0
// foreach is allowed, because theStack.TopToBottom returns IEnumerable(Of Integer).
foreach (int number in theStack.TopToBottom)
{
Console.Write("{0} ", number);
}
Console.WriteLine();
// Output: 9 8 7 6 5 4 3 2 1 0
foreach (int number in theStack.BottomToTop)
{
Console.Write("{0} ", number);
}
Console.WriteLine();
// Output: 0 1 2 3 4 5 6 7 8 9
foreach (int number in theStack.TopN(7))
{
Console.Write("{0} ", number);
}
Console.WriteLine();
// Output: 9 8 7 6 5 4 3
Console.ReadKey();
}
public class Stack<T> : IEnumerable<T>
{
private T[] values = new T[100];
private int top = 0;
public void Push(T t)
{
values[top] = t;
top++;
}
public T Pop()
{
top--;
return values[top];
}
// This method implements the GetEnumerator method. It allows
// an instance of the class to be used in a foreach statement.
public IEnumerator<T> GetEnumerator()
{
for (int index = top - 1; index >= 0; index--)
{
yield return values[index];
}
}
IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
public IEnumerable<T> TopToBottom
{
get { return this; }
}
public IEnumerable<T> BottomToTop
{
get
{
for (int index = 0; index <= top - 1; index++)
{
yield return values[index];
}
}
}
public IEnumerable<T> TopN(int itemsFromTop)
{
// Return less than itemsFromTop if necessary.
int startIndex = itemsFromTop >= top ? 0 : top - itemsFromTop;
for (int index = top - 1; index >= startIndex; index--)
{
yield return values[index];
}
}
}
Informasi Sintaks
Iterator dapat terjadi sebagai metode atau pengakses get. Iterator tidak dapat terjadi dalam suatu peristiwa, konstruktor instans, konstruktor statik, atau pengakhir statik.
Konversi implisit harus ada dari jenis ekspresi dalam pernyataan yield return hingga argumen jenis untuk IEnumerable<T> yang dikembalikan oleh iterator.
Dalam C#, metode iterator tidak boleh memiliki parameter in, ref, atau out.
Dalam C#, yield bukan kata khusus dan memiliki arti khusus hanya ketika digunakan sebelum kata kunci return atau break.
Implementasi teknis
Meskipun Anda menulis iterator sebagai metode, pengompilasi menerjemahkannya ke dalam kelas berlapis yang, pada dasarnya, adalah mesin status. Kelas ini melacak posisi iterator selama perulangan foreach 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 antarmuka IEnumerator. Ketika pengompilasi mendeteksi iterator, pengompilasi secara otomatis menghasilkan metode Current, MoveNext, dan Dispose dari antarmuka IEnumerator atau IEnumerator<T>.
Pada setiap iterasi berturut-turut dari perulangan foreach (atau panggilan langsung ke IEnumerator.MoveNext), isi kode iterator berikutnya dilanjutkan setelah pernyataan yield return sebelumnya. Kemudian berlanjut ke pernyataan yield return berikutnya sampai akhir isi iterator tercapai, atau sampai pernyataan yield break ditemui.
Iterator tidak mendukung metode IEnumerator.Reset. Untuk mengulangi dari awal, Anda harus mendapatkan iterator baru. Memanggil Reset pada iterator yang dikembalikan oleh metode iterator melempar NotSupportedException.
Untuk informasi selengkapnya, lihat Spesifikasi Bahasa C#.
Penggunaan Iterator
Iterator memungkinkan Anda untuk mempertahankan kesederhanaan perulangan foreach ketika Anda perlu menggunakan kode kompleks untuk mengisi urutan daftar. Ini berguna ketika Anda ingin melakukan hal berikut:
Mengubah urutan daftar setelah iterasi perulangan
foreachpertama.Hindari memuat daftar besar sepenuhnya sebelum iterasi pertama perulangan
foreach. Contohnya adalah pengambilan berhalaman untuk memuat satu batch baris tabel. Contoh lain adalah metode EnumerateFiles, yang mengimplementasikan iterator di .NET.Enkapsulasi pembangunan daftar di iterator. Dalam metode iterator, Anda dapat membangun daftar kemudian menangguhkan setiap hasil dalam satu perulangan.
Lihat juga
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk