Інтерфейси IEnumerable та IEnumerator
Для початку вивчення процесу реалізації існуючих інтерфейсів .NET, спочатку розглянемо роль IEnumerable та IEnumerator. Нагадаємо, що C # підтримує ключове слово з назвою foreach, яке дозволяє перебирати вміст будь-якого типу масиву:
// Iterate over an array of items.
int[] myArrayOfInts = {10, 20, 30, 40};
foreach(int i in myArrayOfInts)
{
Console.WriteLine(i);
}
Хоча може здатися, що лише такі типи масивів можуть використовувати цю конструкцію, правда полягає в тому, що будь-який тип, що підтримує метод, який називається GetEnumerator (), може бути оцінений конструктом foreach. Для ілюстрації слідкуйте за мною!
Припустимо, у нас є клас Гараж:
// Garage contains a set of Car objects.
public class Garage
{
private Car[] carArray = new Car[4];
// Fill with some Car objects upon startup.
public Garage()
{
carArray[0] = new Car("Rusty", 30);
carArray[1] = new Car("Clunker", 55);
carArray[2] = new Car("Zippy", 30);
carArray[3] = new Car("Fred", 30);
}
}
В ідеалі було б зручно перебирати підпункти об'єкта Garage за допомогою конструкції foreach, як і масив значень даних:
// This seems reasonable ...
public class Program
{
static void Main(string[] args)
{
Console.WriteLine("***** Fun with IEnumerable / IEnumerator *****\n");
Garage carLot = new Garage();
// Hand over each car in the collection?
foreach (Car c in carLot)
{
Console.WriteLine("{0} is going {1} MPH",
c.PetName, c.CurrentSpeed);
}
Console.ReadLine();
}
}
На жаль, компілятор повідомляє вам, що клас Garage не реалізує метод на ім'я GetEnumerator (). Цей метод формалізований інтерфейсом IEnumerable, який виявляється хованим у просторі імен System.Collections. Класи або структури, що підтримують таку поведінку, рекламують, що вони здатні викривати містять підпункти для абонента (у цьому прикладі саме ключове слово foreach). Ось визначення цього стандартного інтерфейсу .NET:
// This interface informs the caller
// that the object's subitems can be enumerated.
public interface IEnumerable
{
IEnumerator GetEnumerator();
}
Як бачите, метод GetEnumerator () повертає посилання на ще один інтерфейс під назвою System.Collections.IEnumerator. Цей інтерфейс забезпечує інфраструктуру, що дозволяє абоненту перетинати внутрішні об'єкти, що містяться в IEnumerable-сумісному контейнері:
// This interface allows the caller to
// obtain a container's subitems.
public interface IEnumerator
{
bool MoveNext (); // Advance the internal position of the cursor.
object Current { get;} // Get the current item (read-only property).
void Reset (); // Reset the cursor before the first member.
}
Якщо ви хочете оновити тип Garage для підтримки цих інтерфейсів, ви можете пройти довгу дорогу та реалізувати кожен метод вручну. Хоча ви, безперечно, можете надати спеціалізовані версії GetEnumerator (), MoveNext (), Current і Reset (), є більш простий спосіб. Оскільки тип System.Array (як і багато інших класів колекції) вже реалізує IEnumerable та IEnumerator, ви можете просто делегувати запит System.Array таким чином:
using System.Collections;
...
public class Garage : IEnumerable
{
// System.Array already implements IEnumerator!
private Car[] carArray = new Car[4];
public Garage()
{
carArray[0] = new Car("FeeFee", 200);
carArray[1] = new Car("Clunker", 90);
carArray[2] = new Car("Zippy", 30);
carArray[3] = new Car("Fred", 30);
}
public IEnumerator GetEnumerator()
{
// Return the array object's IEnumerator.
return carArray.GetEnumerator();
}
}
Після оновлення типу Garage ви можете сміливо використовувати тип у конструкції forex C #. Крім того, враховуючи, що метод GetEnumerator () визначений публічно, користувач об'єкта також може взаємодіяти з типом IEnumerator:
// Manually work with IEnumerator.
IEnumerator i = carLot.GetEnumerator();
i.MoveNext();
Car myCar = (Car)i.Current;
Console.WriteLine("{0} is going {1} MPH", myCar.PetName, myCar.CurrentSpeed);
Однак якщо ви віддаєте перевагу приховати функціональність IEnumerable від об'єктного рівня, просто скористайтеся явною реалізацією інтерфейсу:
IEnumerator IEnumerable.GetEnumerator()
{
// Return the array object's IEnumerator.
return carArray.GetEnumerator();
}
Роблячи це, випадковий користувач об'єкта не знайде метод GetEnumerator () Garage, тоді як конструкція foreach отримає інтерфейс у фоновому режимі при необхідності.
Адаптовано з Pro C # 5.0 та .NET 4.5 Framework
