一、示例:
在C#中,凡是实现了IEnumerator接口的数据类型都可以用foreach语句进行迭代访问,可是,对于自定义类型如何实现这个接口以支持foreach的迭代呢?
* 要实现这个功能,先来看看IEnumerable和IEnumerator接口的定义:
public interface IEnumerable { //IEnumerable只有一个方法,返回可循环访问集合的枚举数。 IEnumerator GetEnumerator() ; } public interface IEnumerator { // 方法 //移到集合的下一个元素。如果成功则返回为 true;如果超过集合结尾,则返回false。 bool MoveNext(); // 将集合设置为初始位置,该位置位于集合中第一个元素之前 void Reset(); // 属性:获取集合中的当前元素 object Current { get; } } namespace IEnumberableTest { class Program { static void Main(string[] args) { myEnum enum1 = new myEnum(20); foreach (point p in enum1) { Console.WriteLine("(" + p.x.ToString() + "," + p.y.ToString() + "," + p.z.ToString() + ")"); } Console.Read(); } } //一个结构体,用于类myEnum struct point { public int x; public int y; public int z; } //一个派生于IEnumerable和IEnumerator接口的自定义类 class myEnum : IEnumerable, IEnumerator { //定义索引 private int index; //定义一个point结构的数组 private point[] points; //类的构造函数,用于初始化point结构数组 public myEnum(int numofpoint) { this.index = -1; points = new point[numofpoint]; for (int i = 0; i < points.Length; i++) { points[i].x = i; points[i].y = i * i; points[i].z = i * i * i; } } //实现IEnumerable接口的GetEnumerator方法,返回一个IEnumerator,这里返回我们的自定义类,因为要对这个类的对象进行迭代 public IEnumerator GetEnumerator() { return (IEnumerator)this; } //实现IEnumerator接口的Reset方法,将集合索引置于第一个元素之前 public void Reset() { index = -1; } //实现IEnumerator接口的Current属性,返回一个自定义的point结构,即point数组的第index元素 public object Current { get { return points[index]; } } //实现IEnumerator接口的MoveNext方法,用于向前访问集合元素,如果超出集合范围,返回false public bool MoveNext() { index++; return index >= points.Length ? false : true; } } } |
二、区别:
IEnumerable和IEnumerator有什么区别?这是一个很让人困惑的问题(在很多forum里都看到有人在问这个问题)。研究了半天,得到以下几点认识:
1、一个Collection要支持foreach方式的遍历,必须实现IEnumerable接口(亦即,必须以某种方式返回IEnumerator object)。
2、IEnumerator object具体实现了iterator(通过MoveNext(),Reset(),Current)。
3、从这两个接口的用词选择上,也可以看出其不同:IEnumerable是一个声明式的接口,声明实现该接口的class是“可枚举(enumerable)”的,但并没有说明如何实现枚举器(iterator);IEnumerator是一个实现式的接口,IEnumerator object就是一个iterator。
4、IEnumerable和IEnumerator通过IEnumerable的GetEnumerator()方法建立了连接,client可以通过IEnumerable的GetEnumerator()得到IEnumerator object,在这个意义上,将GetEnumerator()看作IEnumerator object的factory method也未尝不可。
IEnumerator 是所有枚举数的基接口。
枚举数只允许读取集合中的数据。枚举数无法用于修改基础集合。
最初,枚举数被定位于集合中第一个元素的前面。Reset 也将枚举数返回到此位置。在此位置,调用 Current 会引发异常。因此,在读取 Current 的值之前,必须调用 MoveNext 将枚举数提前到集合的第一个元素。
在调用 MoveNext 或 Reset 之前,Current 返回同一对象。MoveNext 将 Current 设置为下一个元素。
在传递到集合的末尾之后,枚举数放在集合中最后一个元素后面,且调用 MoveNext 会返回 false。如果最后一次调用 MoveNext 返回 false,则调用 Current 会引发异常。若要再次将 Current 设置为集合的第一个元素,可以调用 Reset,然后再调用 MoveNext。
只要集合保持不变,枚举数就将保持有效。如果对集合进行了更改(例如添加、修改或删除元素),则该枚举数将失效且不可恢复,并且下一次对 MoveNext 或 Reset 的调用将引发 InvalidOperationException。如果在 MoveNext 和 Current 之间修改集合,那么即使枚举数已经无效,Current 也将返回它所设置成的元素。
枚举数没有对集合的独占访问权;因此,枚举一个集合在本质上不是一个线程安全的过程。甚至在对集合进行同步处理时,其他线程仍可以修改该集合,这会导致枚举数引发异常。若要在枚举过程中保证线程安全,可以在整个枚举过程中锁定集合,或者捕捉由于其他线程进行的更改而引发的异常。