C#のIEnumerableとは？使い方（foreachでの要素取り出し）を順を追って解説

＜目次＞

C#のインターフェイスでカスタム配列への対話的なアクセス（foreachによるアクセス）を可能にします。

■IEnumerableの概要
IEnumerableインターフェイスは抽象メソッドGetEnumerator()メソッドのみを持つインターフェイスで、戻り値は「IEnumerator」インターフェイスを返却します。この「IEnumerator」インターフェイスを使うとカスタム配列の要素に対して、繰り返し処理でアクセスできる様になります。

（図１１１）

■IEnumeratorで出来る事・出来ない事
IEnumeratorインターフェイスは３つメソッドMoveNext()とReset()とCurrentがあります。「IEnumerable」を実装すると、foreachでループして要素を取得できるようになります。注意点として「IEnumerator」インターフェイスは要素に対してアクセスはできますが、変更する事はできません。

■IEnumeratorで配列にアクセスする際のお作法
通常、配列の要素にアクセスする際は「インデックス」を使いまが、IEnumeratorではインデックスの代わりに3つの抽象メソッド「Reset()」と「MoveNext()」と「Current()」を使って要素にアクセスします。

＞目次にもどる

public IEnumerator GetEnumerator()
{
	return (IEnumerator)this;
}

// IEnumeratorインターフェイスのメソッドシグニチャ
void Reset()
bool MoveNext()
object Current

public void Reset()
{
	[現在位置変数名] = -1;
}

public bool MoveNext()
{
	if ([現在位置変数名] < [配列名].Count - 1)
	{
		++[現在位置変数名];
		return true;
	}
	return false;
}

public object Current
{
	get
	{
		return PersonList[CurrPosition];
	}
}

理解を深めるために、サンプルプログラムを用いて実装の流れをご紹介します。例として以下のようなサンプルプログラムに対してforeachを使いたいと仮定します。

このプログラムは個人（Person）の情報を保持する自作クラスと、そのPersonを複数集めた「集団」を表すPeopleクラス（Personクラスの配列）の２つが主にあります。

そしてMain文の中で、Personインスタンスを作ってPeopleに追加した後に「foreach」を使ってアクセスしようとしています。

（サンプルプログラム：初期状態）

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace IEnumeratorTest
{
  //①個人を管理するPersonクラス
  class Person
  {
    private string FirstName;
    private string LastName;
    private int Age;
    public Person(string firstName, string lastName, int age)
    {
      this.FirstName = firstName;
      this.LastName = lastName;
      this.Age = age;
    }
    public override string ToString()
    {
      return "Name:" + FirstName + " " + LastName + " Age: " + Age.ToString();
    }
  }
  //②複数人の集団を管理するPeopleクラス
  class People
  {
    ArrayList PersonList = new ArrayList();
    public void AddPerson(Person oPeople)
    {
      PersonList.Add(oPeople);
    }
  }

  class Program
  {
    static void Main(string[] args)
    {
      //Peopleクラス（複数人の集団）のインスタンス作成
      People plist = new People();
      //Personクラス（個人）のインスタンス作成
      Person p1 = new Person("Suzuki", "Hanako", 29);
      Person p2 = new Person("Yamada", "Taro", 19);
      //People（集団）にPerson（個人）を追加
      plist.AddPerson(p1);
      plist.AddPerson(p2);
      Console.WriteLine("### foreachを用いてPersonsを数え上げ開始 ###");
      foreach (Person person in plist)
      {
        Console.WriteLine(person);
      }
    }
  }
}

ただし、このサンプルは前述の「IEnumerable」や「IEnumerator」を実装していないため、次のようにエラーになります。

エラー	CS1579	foreach ステートメントは、'People' が 'GetEnumerator' のパブリック インスタンス定義を含んでいないため、型 'People' の変数に対して使用できません	

（図１３１）エラー

 

 

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace IEnumeratorTest2
{
  //①個人を管理するPersonクラス
  class Person
  {
    private string FirstName;
    private string LastName;
    private int Age;
    public Person(string firstName, string lastName, int age)
    {
      this.FirstName = firstName;
      this.LastName = lastName;
      this.Age = age;
    }
    public override string ToString()
    {
      return "Name:" + FirstName + " " + LastName + " Age: " + Age.ToString();
    }
  }
  //②複数人の集団を管理するPeopleクラス
  class People : IEnumerable, IEnumerator
  {
    ArrayList PersonList = new ArrayList();
    public void AddPerson(Person oPeople)
    {
      PersonList.Add(oPeople);
    }
    // (1) IEnumerableの実装（★追記）
    public IEnumerator GetEnumerator()
    {
      return (IEnumerator)this;
    }
    // (2) IEnumeratorの実装（★追記）
    //　現在位置（カレントポジション）の変数定義
    private int CurrPosition = -1;
    // (2-1) void Reset()メソッド（★追記）
    public bool MoveNext()
    {
      if (CurrPosition < PersonList.Count - 1)
      {
        ++CurrPosition;
        return true;
      }
      return false;
    }
    // (2-2) bool MoveNext()メソッドの実装（★追記）
    public void Reset()
    {
      CurrPosition = -1;
    }
    // (2-3) object Current()メソッドの実装（★追記）
    public object Current
    {
      get
      {
        return PersonList[CurrPosition];
      }
    }
  }

  class Program
  {
    static void Main(string[] args)
    {
      //Peopleクラス（複数人の集団）のインスタンス作成
      People plist = new People();
      //Personクラス（個人）のインスタンス作成
      Person p1 = new Person("Suzuki", "Hanako", 29);
      Person p2 = new Person("Yamada", "Taro", 19);
      //People（集団）にPerson（個人）を追加
      plist.AddPerson(p1);
      plist.AddPerson(p2);
      Console.WriteLine("### foreachを用いてPersonsを数え上げ開始 ###");
      foreach (Person person in plist)
      {
        Console.WriteLine(person);
      }
    }
  }
}