IEnumerable和IEnumerator

概述

IEnumerable和IEnumerator接口存在的意义：用来实现迭代的功能！

    public interface IEnumerable
    {
        IEnumerator GetEnumerator();
    }

    public interface IEnumerator
    {
        object Current { get; }

        bool MoveNext();

        void Reset();
    }

迭代的原理

首先来说一下集合实现的原理：对于ArrayList、List<T>等集合，类中有一个私有的数组类型字段，向集合中添加数据时调用Add方法（将数据元素添加到私有数组字段中），而调用类的其他方法时，其实就是对私有数组类型字段的操作。

 public class ArrayList : IList, ICollection, IEnumerable, ICloneable
 {
     //省略其他代码
     private object[] _items;

     public virtual int Add(object value)
     {
         if (this._size == this._items.Length)
         {
             this.EnsureCapacity(this._size + );
         }
         this._items[this._size] = value;
         this._version++;
         return this._size++;
     }
 }

ArrayList

 public class List<T> : IList<T>, ICollection<T>, IList, ICollection, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable
 {
     //省略其他代码
     private T[] _items;

     public void Add(T item)
     {
         if (this._size == this._items.Length)
         {
             this.EnsureCapacity(this._size + );
         }
         this._items[this._size++] = item;
         this._version++;
     }
 }

List

所以对于这些集合来说，本质上集合中的所有元素都是保存在一个私有数组类型的字段中，众所周知，对于ArrayList或者List<T>都可以使用foreach进行迭代，查看集合中的元素。

        static void Main(string[] args)
        {
            List<string> strs=new List<string>();
            strs.Add("DD");
            strs.Add("FF");
            strs.Add("VV");
            strs.Add("WW");
            foreach (String str in strs)
            {
                Console.WriteLine(str);
            }
            Console.ReadKey();
        }

上述这个foreach的迭代的过程是如何实现的呢？foreach为什么可以逐个遍历所以集合中的元素呢？下面我们就用IL反汇编程序来查看上述代码的foreach部分的IL！

  IL_0039:  callvirt   instance valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator<!0> class [mscorlib]System.Collections.Generic.List`1<string>::GetEnumerator()
  IL_003e:  stloc.2
  .try
  {
    IL_003f:  br.s       IL_0052
    IL_0041:  ldloca.s   CS$5$0000
    IL_0043:  call       instance !0 valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator<string>::get_Current()
    IL_0048:  stloc.1
    IL_0049:  nop
    IL_004a:  ldloc.1
    IL_004b:  call       void [mscorlib]System.Console::WriteLine(string)
    IL_0050:  nop
    IL_0051:  nop
    IL_0052:  ldloca.s   CS$5$0000
    IL_0054:  call       instance bool valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator<string>::MoveNext()
    IL_0059:  stloc.3
    IL_005a:  ldloc.3
    IL_005b:  brtrue.s   IL_0041
    IL_005d:  leave.s    IL_006e
  }  // end .try
  finally
  {
    IL_005f:  ldloca.s   CS$5$0000
    IL_0061:  constrained. valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator<string>
    IL_0067:  callvirt   instance void [mscorlib]System.IDisposable::Dispose()
    IL_006c:  nop
    IL_006d:  endfinally
  }

看不懂？没关系啦，那么我们就来大致的猜想一下，我们的foreach生成了这么一大坨的IL中居然有Enumerator什么的，难道跟这个有关系吗？恰巧听说IEnumerable和IEnumrator用来实现迭代，恰恰巧我们的ArrayList、List<T>集合都是实现了IEnumerable接口。那么我们就来做的大胆的假设，foreach其实就是执行跟IEnumerable和IEnumrator接口相关的代码，并对保存集合的私有数组字段的索引进行操作，从而来实现迭代的功能。

static void Main(string[] args)
{
	List<string> strs=new List<string>();
	strs.Add("DD");
	strs.Add("FF");
	strs.Add("VV");
	strs.Add("WW");
	IEnumerator<string> items = strs.GetEnumerator();
	while (items.MoveNext())
	{
		Console.WriteLine(items.Current);
	}
	Console.ReadKey();
}

这段代码也同样实现了对集合元素迭代的功能！在来看一下这个迭代生成的相关IL。

  IL_0038:  callvirt   instance valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator<!0> class [mscorlib]System.Collections.Generic.List`1<string>::GetEnumerator()
  IL_003d:  box        valuetype [mscorlib]System.Collections.Generic.List`1/Enumerator<string>
  IL_0042:  stloc.1
  IL_0043:  br.s       IL_0053
  IL_0045:  nop
  IL_0046:  ldloc.1
  IL_0047:  callvirt   instance !0 class [mscorlib]System.Collections.Generic.IEnumerator`1<string>::get_Current()
  IL_004c:  call       void [mscorlib]System.Console::WriteLine(string)
  IL_0051:  nop
  IL_0052:  nop
  IL_0053:  ldloc.1
  IL_0054:  callvirt   instance bool [mscorlib]System.Collections.IEnumerator::MoveNext()
  IL_0059:  stloc.2
  IL_005a:  ldloc.2
  IL_005b:  brtrue.s   IL_0045

嘿嘿，对比两者生成的IL，目测他们的执行过程中调用的IL指令大体上是一致的（IL指令啥的暂时我也不是很了解），所以我们的猜想应该是正确的，foreach在本质上其实就是通过ArrayList、List<T>中定义的GetEnumerator方法，以及后续的代码实现的！下面就来看看List<T>中是如何定义的。

public class List<T> : IList<T>, ICollection<T>, IList, ICollection, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable
{
    private T[] _items;
    public List<T>.Enumerator GetEnumerator()
    {
        return new List<T>.Enumerator(this);
    }
    public struct Enumerator : IEnumerator<T>, IDisposable, IEnumerator
    {
        private List<T> list;
        private int index;
        private int version;
        private T current;

        public T Current
        {

            get
            {
                return this.current;
            }
        }

        object IEnumerator.Current
        {

            get
            {
                if (this.index ==  || this.index == this.list._size + )
                {
                    ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumOpCantHappen);
                }
                return this.Current;
            }
        }
        internal Enumerator(List<T> list)
        {
            this.list = list;
            this.index = ;
            this.version = list._version;
            this.current = default(T);
        }

        public void Dispose()
        {
        }

        public bool MoveNext()
        {
            List<T> list = this.list;
            if (this.version == list._version && this.index < list._size)
            {
                this.current = list._items[this.index];
                this.index++;
                return true;
            }
            return this.MoveNextRare();
        }
        private bool MoveNextRare()
        {
            if (this.version != this.list._version)
            {
                ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumFailedVersion);
            }
            this.index = this.list._size + ;
            this.current = default(T);
            return false;
        }

        void IEnumerator.Reset()
        {
            if (this.version != this.list._version)
            {
                ThrowHelper.ThrowInvalidOperationException(ExceptionResource.InvalidOperation_EnumFailedVersion);
            }
            this.index = ;
            this.current = default(T);
        }
    }
}
        

List<T>

哇哦，原来迭代器是这样的呀！！！！

自定义一个简单的支持迭代的集合

下面我们就来自定义一个支持迭代器的集合

public class UserDefinedCollection<T>:IEnumerable<T>
    {
        private List<T> list = new List<T>();

        public UserDefinedCollection(List<T> param)
        {
            list = param;
        }
        public IEnumerator<T> GetEnumerator()
        {
            return new UserDefinedEnum<T>(list);
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            return GetEnumerator();
        }

        private sealed class UserDefinedEnum<T>:IEnumerator<T>
        {
            private List<T> list = null;
            private int _CurrentIndex;
            private T _CurrentElement;

            public UserDefinedEnum(List<T> param)
            {
                this.list = param;
                this._CurrentIndex = ;
                _CurrentElement = default(T);

            }

            public T Current
            {
                get
                {
                    return _CurrentElement;
                }
            }

            object IEnumerator.Current
            {
                get { return Current; }
            }

            public bool MoveNext()
            {
                if (this._CurrentIndex < this.list.Count)
                {
                    this._CurrentElement = this.list[this._CurrentIndex++];
                    return true;
                }
                return false;
            }

            public void Reset()
            {
                this._CurrentElement = default(T);
                this._CurrentIndex = ;
            }
            public void Dispose()
            {

            }
        }

    }

测试自定义集合的迭代功能：

            List<string> strs=new List<string>();
            strs.Add("DD");
            strs.Add("FF");
            strs.Add("VV");
            strs.Add("WW");
            UserDefinedCollection<String> user = new UserDefinedCollection<string>(strs);
            IEnumerator<string> iEnumerator = user.GetEnumerator();

            while (iEnumerator.MoveNext())
            {
                Console.WriteLine(iEnumerator.Current);
            }

            foreach (String str in user)
            {
                Console.WriteLine(str);
            }

扩展：由模型绑定中，绑定泛型类型时学习到泛型相关的知识！

//调用1
　　　　ExtraGenericInterface(typeof(List<User>),typeof(IEnumerable<>))
　　　　//调用2
　　　　ExtraGenericInterface(typeof(IEnumerable<User>),typeof(IEnumerable<>))

　　　　public Type ExtraGenericInterface(Type queryType, Type interfaceType)
        {
            //当前类型queryType是否是泛型
            bool b = queryType.IsGenericType;
            //返回可以构造当前泛型类型的一个泛型类型，即：由IEnumerable<User>得到 IEnumerable<>
            Type tt = queryType.GetGenericTypeDefinition();

            bool ttt = tt == interfaceType ? true : false;

            Func<Type, bool> predicate = t => t.IsGenericType && (t.GetGenericTypeDefinition() == interfaceType);
            //Func<Type, bool> predicate = delegate(Type queryType2){return false;};
            //如果当前类型是泛型，并且该发行是由interfaceType类型构造的。
            if (predicate(queryType))
            {
                return queryType;
            }
            else
            {
                //获取当前类实现的所有类和接口
                Type[] types = queryType.GetInterfaces();
                //在数组中找，并返回满足 predicate 条件的第一个元素
                //也就是在所有父类或实现的接口中找到是泛型并且构造此泛型的类型是interfaceType类型的第一个元素
　　　　　　　　　//FirstOrDefault<Type>中Type是后面委托predicate的参数类型　
                Type tttt = types.FirstOrDefault<Type>(predicate);

                return queryType.GetInterfaces().FirstOrDefault<Type>(predicate);
            }

        }