【迭代器模式在.NET中的应用】

 

迭代器模式

　　定义参考 wiki: Iterator pattern

　　迭代器模式就是分离了集合对象的遍历行为，抽象出一个迭代器类来负责，这样既可以做到不暴露集合的内部结构，又可让外部代码透明地访问集合内部的数据。   ------- 节选自 《大话设计模式》P207 

　　我们可以将迭代器模式抽离出几个重要组成部分：

　　1. 迭代器抽象类

　　2. 聚集抽象类

　　3. 具体迭代器类

　　4. 具体聚集类

 

1. 迭代器抽象类

public interface IEnumerator
{
        bool MoveNext();
    
        Object Current {
            get; 
        }
    
        void Reset();
}

reference: .NET IEnumerator

 

2. 聚集抽象类

public interface IEnumerable
{
        IEnumerator GetEnumerator();
}

reference: .NET IEnumerable

 

3. 具体迭代器类

通过查看.NET代码可以知道，在List、Dictionary类中都声明了具体的迭代器struct Enumerator，List中Enumerator代码如下：

[Serializable]
public struct Enumerator : IEnumerator<T>,
System.Collections.IEnumerator
{
            private List<T> list;
            private int index;
            private int version;
            private T current;
 
            internal Enumerator(List<T> list) {
                this.list = list;
                index = 0;
                version = list._version;
                current = default(T);
            }
 
            public void Dispose() {
            }
 
            public bool MoveNext() {
 
                List<T> localList = list;
 
                if (version == localList._version && ((uint)index < (uint)localList._size)) 
                {                                                     
                    current = localList._items[index];                    
                    index++;
                    return true;
                }
                return MoveNextRare();
            }
 
            private bool MoveNextRare()
            {                
                if (version != list._version) {
                    ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumFailedVersion);
                }
 
                index = list._size + 1;
                current = default(T);
                return false;                
            }
 
            public T Current {
                get {
                    return current;
                }
            }
 
            Object System.Collections.IEnumerator.Current {
                get {
                    if( index == 0 || index == list._size + 1) {
                         ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumOpCantHappen);
                    }
                    return Current;
                }
            }
    
            void System.Collections.IEnumerator.Reset() {
                if (version != list._version) {
                    ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumFailedVersion);
                }
                
                index = 0;
                current = default(T);
            }
}

reference: .NET List Enumerator

 

4. 具体聚集类

同样以List为例，reference: .NET List

 

5. 利用 foreach 来遍历对象

foreach(int i in obj) {...}经过编译器转换将会变成如下:

var tmp = obj.GetEnumerator();
int i;
while (tmp.MoveNext()) {
　　　　　　i = tmp.Current;
          {...} // your code
}

所以可以知道，只要我们实现了迭代器类和聚集类，那么就可以通过foreach来进行遍历了。

 

参考

1. How do foreach loops work in C#?

2. Foreach On IEnumerable

3. 详解C# 迭代器

4. .Net学习难点讨论系列11 - foreach与迭代器