在C#語言中提供 foreach 查詢操作,foreach 大大的簡化了要編寫的代碼,但是foreach 只能用來遍歷一個可枚舉的集合(enumable),可枚舉的集合就是實現了System.Collections.IEnumerable接口的一個集合。
但是foreach 返回的是可枚舉對象的一個只讀集合,不可以通過foreach 來修改可枚舉對象。
簡單的一個例子:
int[] number_array = new int[] { 1,2,3,4,5,6};
foreach (int k in number_array)
{
Console.WriteLine(k);
}
int 類型,繼承了IEnumerable<T> 接口,所有可以用foreach 來遍歷。如果我們自己寫的一個類,沒有實現IEnumerable<T> 接口,用foreach 就不能進行迭代了,編譯器會報錯。
例如:
自己寫的一個類:
class Student: IComparable<Student>
{
public Student()
{
// nothing
}
private int age;
public int Age
{
get { return this.age;}
set { this.age = value; }
}
public int CompareTo(Student other)
{
//throw new NotImplementedException();
if (this.age == other.age)
{
return 0;
}
else if (this.age < other.age)
{
return -1;
}
else
{
return 1;
}
}
}
這個類實現了 IComparable<T> 接口,但是沒有實現 IEnumerable<T> 接口,不能用foreach 遍歷。
下面的代碼對這個沒有實現 IEnumerable<T> 接口的類進行foreach 遍歷結果發生編譯錯誤。
//Student[] student=new Student[5];
//student.test();
//foreach (Student t in student)
//{
//}
下面我們將自己手動的給上面那個簡單的類實現枚舉器,通過foreach來遍歷這個類。
在 IEnumerable接口中,包括一個GetEnumerator的方法:
IEnumerator GetEnumertor();
這個方法返回一個枚舉器對象。
IEnumerator 接口中規定了以下方法和屬性:
object Current {get;}
bool MoveNext();
void Reset();
最初枚舉器的指針指向枚舉集合的第一個元素的前面,在獲取 Current之前先要調用MoveNext() 使指針指向下一個元素。
以上所說的接口, 都有他們對應的泛型接口,在接下來的實現中,都會使用泛型接口。
當我們給要枚舉的類實現了IEnumerable<T>接口後,foreach語句會自動的讓生成一個枚舉器,並通過枚舉器中的Current, MoveNext等獲取下一個數據,這一切過程對於foreach的使用者都是透明的。
下面,先給出本實例的所有代碼,然後進行分析講解。
所有原碼如下:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace EnumerableTest
{
class Program
{
static void Main(string[] args)
{
int[] number_array = new int[] { 1,2,3,4,5,6};
foreach (int k in number_array)
{
Console.WriteLine(k);
}
//Student[] student=new Student[5];
////student.test();
//foreach (Student t in student)
//{
//}
Student[] student = new Student[5];
student[0] = new Student();
student[0].Age = 12;
student[1] = new Student();
student[1].Age = 13;
student[2] = new Student();
student[2].Age = 74;
student[3] = new Student();
student[3].Age = 34;
student[4] = new Student();
student[4].Age = 32;
Console.WriteLine("/////////////////////////////////////");
Sector<Student> sector = new Sector<Student>(student);
foreach (Student t in sector)
{
Console.WriteLine(t.Age);
}
}
}
class Sector<T> : IEnumerable<T>
where T : IComparable<T>
{
T[] student;
public Sector(T[] t)
{
student = t;
}
public IEnumerator<T> GetEnumerator()
{
return new SectorEnumator<T>(student);
//throw new NotImplementedException();
}
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
{
//throw new NotImplementedException();
return null;
}
}
class SectorEnumator<T> : IEnumerator<T>
where T : IComparable<T>
{
private T[] student;
private Queue<T> MyQueue;
private T currentItem;
public SectorEnumator(T[] s)
{
this.student = s;
}
public T Current
{
get { return this.currentItem; }
}
public void Dispose()
{
// simply do nothing
//throw new NotImplementedException();
}
object System.Collections.IEnumerator.Current
{
get { throw new NotImplementedException(); }
}
public bool MoveNext()
{
if (this.MyQueue == null)
{
MyQueue = new Queue<T>();
populate(student);
}
if (this.MyQueue.Count > 0)
{
this.currentItem = MyQueue.Dequeue();
return true;
}
return false;
//throw new NotImplementedException();
}
public void Reset()
{
//throw new NotImplementedException();
MyQueue.Clear();
populate(student);
}
private void populate(T[] s)
{
int num = s.Length;
for (int i = 0; i < num; i++)
{
MyQueue.Enqueue(s[i]);
}
}
}
class Student: IComparable<Student>
{
public Student()
{
// nothing
}
private int age;
public int Age
{
get { return this.age;}
set { this.age = value; }
}
public int CompareTo(Student other)
{
//throw new NotImplementedException();
if (this.age == other.age)
{
return 0;
}
else if (this.age < other.age)
{
return -1;
}
else
{
return 1;
}
}
}
}
首先,我們定義了一個Student 類,並實現了IComparable<T> 接口,我們程序的目的就是在使用Student類的時候,可以通過foreach 來遍歷Student數組中的每個成員,但是默認情況下Student類並沒有實現IEnumberable<T>接口,所有在直接用foreach 遍歷的時候會編譯報錯。
為了遍歷Student類,我們手動實現了一個枚舉器。
class SectorEnumator<T> : IEnumerator<T>
where T : IComparable<T>
{
private T[] student;
private Queue<T> MyQueue;
private T currentItem;
public SectorEnumator(T[] s)
{
this.student = s;
}
public T Current
{
get { return this.currentItem; }
}
public void Dispose()
{
// simply do nothing
//throw new NotImplementedException();
}
object System.Collections.IEnumerator.Current
{
get { throw new NotImplementedException(); }
}
public bool MoveNext()
{
if (this.MyQueue == null)
{
MyQueue = new Queue<T>();
populate(student);
}
if (this.MyQueue.Count > 0)
{
this.currentItem = MyQueue.Dequeue();
return true;
}
return false;
//throw new NotImplementedException();
}
public void Reset()
{
//throw new NotImplementedException();
MyQueue.Clear();
populate(student);
}
private void populate(T[] s)
{
int num = s.Length;
for (int i = 0; i < num; i++)
{
MyQueue.Enqueue(s[i]);
}
}
}
在MOveNext() 中,如果這個枚舉器的MyQueue為null,則new 一個Queue, 用MyQueue存放給枚舉器傳進來的對象數組。每一次MoveNext() 都會造成一個對象出隊。
然後給一個類實現IEnumerable<T> 接口,通過GetEnumerator() 方法獲取枚舉器:
class Sector<T> : IEnumerable<T>
where T : IComparable<T>
{
T[] student;
public Sector(T[] t)
{
student = t;
}
public IEnumerator<T> GetEnumerator()
{
return new SectorEnumator<T>(student);
//throw new NotImplementedException();
}
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
{
//throw new NotImplementedException();
return null;
}
}
這樣,在我們以後創建一個Sector 對象以後,就可以直接用foreach 對Sector對象中的Student 對象進行枚舉:
Sector<Student> sector = new Sector<Student>(student);
foreach (Student t in sector)
{
Console.WriteLine(t.Age);
}
作者“Watkins.Song”