Итераторы (C#)
Итератор можно использовать для прохода по коллекции, такой как список или массив.
Метод итератора или метод доступа get выполняет настраиваемую итерацию по коллекции. Метод итератора использует оператор yield return для поочередного возврата каждого элемента. При достижении инструкции yield return текущее расположение в коде запоминается. При следующем вызове функции итератора выполнение возобновляется с этого места.
Итератор используется из клиентского кода с помощью оператора foreach или с помощью запроса LINQ.
В приведенном ниже примере первая итерация цикла foreach приводит к вызову метода итератора SomeNumbers, пока не будет достигнут первый оператор yield return. Эта итерация возвращает значение 3. Текущее расположение в методе итератора сохраняется. В следующей итерации цикла выполнение метода итератора возобновляется с того же места и снова приостанавливается при достижении оператора yield return. Эта итерация возвращает значение 5. Текущее расположение в методе итератора снова сохраняется. Цикл завершается при достижении конца метода итератора.
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;
}
Типом возвращаемого метода итератора или метода доступа get может быть IEnumerable, IEnumerable<T>, IEnumerator или IEnumerator<T>.
Для завершения итерации можно использовать оператор yield break.
Примечание.
Все примеры в этом разделе, кроме примера простого итератора, включают директивы using для пространств имен System.Collections и System.Collections.Generic.
Простой итератор
В следующем примере имеется один оператор yield return, который находится внутри цикла for. В методе Main каждая итерация оператора foreach создает вызов функции итератора, которая выполняет следующий оператор 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;
}
}
}
Создание класса коллекции
В следующем примере класс DaysOfTheWeek реализует интерфейс IEnumerable, которому требуется метод GetEnumerator. Компилятор неявно вызывает метод GetEnumerator, который возвращает IEnumerator.
Метод GetEnumerator возвращает каждую строку поочередно с помощью оператора 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];
}
}
}
В приведенном ниже примере создается класс Zoo, содержащий коллекцию животных.
Оператор foreach, который обращается к экземпляру класса (theZoo), неявно вызывает метод GetEnumerator. Операторы foreach, которые обращаются к свойствам Birds и Mammals, используют метод итератора с именем 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; }
}
}
Использование итераторов с универсальным списком
В следующем примере универсальный класс Stack<T> также реализует универсальный интерфейс IEnumerable<T>. Метод Push присваивает значения массиву типа T. Метод GetEnumerator возвращает массив значений с помощью оператора yield return.
Помимо универсального метода GetEnumerator должен быть реализован и неуниверсальный метод GetEnumerator. Это связано с тем, что IEnumerable<T> наследуется от IEnumerable. Неуниверсальная реализация подчиняется универсальной реализации.
В этом примере используются именованные итераторы для поддержки различных способов итерации по одной и той же коллекции данных. Эти именованные итераторы являются свойствами TopToBottom и BottomToTop и методом TopN.
Свойство BottomToTop использует итератор в методе доступа 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];
}
}
}
Сведения о синтаксисе
Итератор может являться методом или методом доступа get. Итератор не может использоваться в событии, конструкторе экземпляра, статическом конструкторе или статическом методе завершения.
Должно существовать неявное преобразование типа выражения в операторе yield return в аргумент типа для IEnumerable<T>, возвращаемого итератором.
В C# метод итератора не может иметь параметры in, ref или out.
В C# yield не является зарезервированным словом и имеет специальное значение, только если используется перед ключевым словом return или break.
Техническая реализация
Хотя итератор создается как метод, компилятор переводит его во вложенный класс, который фактически является конечным автоматом. Этот класс отслеживает положение итератора, пока в клиентском коде выполняется цикл foreach.
Чтобы узнать, что делает компилятор, можно использовать средство Ildasm.exe для просмотра кода общего промежуточного языка, созданного для метода итератора.
При создании итератора для класса или структуры реализация всего интерфейса IEnumerator не требуется. Когда компилятор обнаруживает итератор, он автоматически создает методы Current, MoveNext и Dispose интерфейса IEnumerator или IEnumerator<T>.
В каждой последовательной итерации цикла foreach (или непосредственном вызове метода IEnumerator.MoveNext) код тела следующего итератора возобновляет выполнение после предыдущего оператора yield return. Затем он выполняется до следующего оператора yield return до тех пор, пока не будет достигнут конец тела итератора или пока не будет обнаружен оператор yield break.
Итераторы не поддерживают метод IEnumerator.Reset. Для повторной итерации сначала необходимо получить новый итератор. Вызов Reset в итераторе, который возвращается методом итератора, вызывает исключение NotSupportedException.
Дополнительные сведения см. в спецификации языка C#.
Использование итераторов
Итераторы позволяют поддерживать простоту цикла foreach, когда необходимо использовать сложный код для заполнения последовательности списков. Это может оказаться полезным в следующих случаях:
Изменение последовательности списков после первой итерации цикла
foreach.Если необходимо избежать полной загрузки большого списка перед первой итерацией цикла
foreach. Пример: при постраничной загрузке пакета строк таблицы. Другой пример — метод EnumerateFiles, реализующий итераторы в .NET.Инкапсулирование построения списка в итераторе. В методе итератора можно построить список, а затем выдавать каждый результат в цикле.
