Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
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 pengembalian hasil untuk mengembalikan setiap elemen satu per satu. Ketika pernyataan yield return dicapai, lokasi saat ini dalam kode disimpan. Eksekusi dimulai ulang dari lokasi tersebut saat fungsi iterator dipanggil berikutnya.
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 SomeNumbers metode iterator hingga pernyataan pertama yield return 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 return pernyataan. Perulangan 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 get aksesor dapat berupa IEnumerable, , IEnumerable<T>IEnumerator, atau IEnumerator<T>.
Anda dapat menggunakan yield break pernyataan untuk mengakhiri iterasi.
Nota
Untuk semua contoh dalam topik ini, kecuali contoh Iterator Sederhana, sertakan direktif using untuk namespace System.Collections dan System.Collections.Generic.
Iterator Sederhana
Contoh berikut memiliki satu yield return pernyataan yang terdapat dalam perulangan for. Dalam Main, setiap iterasi dari isi pernyataan foreach menciptakan panggilan ke fungsi iterator, yang kemudian melanjutkan ke pernyataan berikutnya yield return.
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, DaysOfTheWeek kelas mengimplementasikan IEnumerable antarmuka, yang memerlukan GetEnumerator metode. Kompilator memanggil metode GetEnumerator secara implisit, yang mengembalikan IEnumerator.
Metode GetEnumerator mengembalikan setiap string satu per satu dengan 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 Zoo kelas 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, Stack<T> kelas generik mengimplementasikan IEnumerable<T> antarmuka generik. Metode Push menetapkan nilai ke array bertipe T. Metode GetEnumerator mengembalikan nilai array dengan menggunakan yield return 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.
Properti BottomToTop menggunakan iterator dalam metode akses 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 berupa metode atau get aksesor. Iterator tidak dapat ada dalam event, konstruktor instans, konstruktor statis, atau finalisasi statis.
Konversi implisit harus ada dari tipe ekspresi dalam pernyataan yield return ke tipe argumen untuk IEnumerable<T> yang dikembalikan oleh iterator.
Dalam C#, metode iterator tidak dapat memiliki parameter in, ref, atau out apa pun.
Dalam C#, yield bukan kata cadangan dan hanya memiliki arti khusus ketika digunakan sebelum kata kunci return atau break.
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 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 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 foreach (atau panggilan langsung ke IEnumerator.MoveNext), badan kode iterator berikutnya berlanjut 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 menegaskan kembali sejak awal, Anda harus mendapatkan iterator baru. Memanggil Reset pada iterator yang dikembalikan oleh metode iterator akan menyebabkan NotSupportedException dilempar.
Untuk informasi tambahan, lihat Spesifikasi Bahasa C#.
Penggunaan Iterator
Iterator memungkinkan Anda untuk mempertahankan kesederhanaan foreach 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
foreachloop.Hindari memuat daftar besar sepenuhnya sebelum iterasi pertama perulangan
foreach. Contohnya adalah pengambilan halaman untuk memuat batch baris tabel. Contoh lain adalah EnumerateFiles metode , yang mengimplementasikan iterator di .NET.Merangkum pembuatan daftar di iterator. Dalam metode iterator, Anda dapat membuat daftar dan kemudian menghasilkan setiap hasil dalam perulangan.
Lihat juga
Berkolaborasi dengan kami di GitHub
Sumber untuk konten ini dapat ditemukan di GitHub, yang juga dapat Anda gunakan untuk membuat dan meninjau masalah dan menarik permintaan. Untuk informasi selengkapnya, lihat panduan kontributor kami.
