浅析foreach原理

      在日常开发工作中，我们发现很多对象都能通过foreach来遍历，比如HashTable、Dictionary、数组等数据类型。那为何这些对象能通过foreach来遍历呢？如果写一个普通的Person类，也希望它能通过foreach来遍历应该怎么做？通过查看，发现HashTable、Dictionary、数组等数据类型都实现了一个叫IEnumerable（或其泛型版本）的接口。现在也来尝试下，让Person类实现这个接口（其实实不实现IEnumerable接口不是必须的，只要类型中有public IEnumerator GetEnumerator()这个方法即可）：

class Person:IEnumerable
    {
        public string[] _Name = new string[] { "sk", "jk", "yzk","wcw","ml" };
        public string Name { get; set; }
        public int Age { get; set; }

        public IEnumerator GetEnumerator()
        {
            return new PersonEnumerator(_Name);
        }
    }

可以看到GetEnumerator()方法需要一个返回值类型为实现了IEnumerator的类型，那就写个类，让其实现IEnumerator接口：

class PersonEnumerator:IEnumerator
    {
        public PersonEnumerator(string[] name)
        {
            this._names = name;
        }

        public string[] _names { get; set; }
        public int Index = -1;

        public object Current
        {
            get { return _names[Index]; }
        }

        public bool MoveNext()
        {
            Index++;
            if (Index>=_names.Length)
            {
                return false;
            }
            else
            {
                return true;
            }
        }

        public void Reset()
        {
            Index = -1;
        }
    }

此时再运行程序，就发现Person类可以遍历了。运行结果如下：

总结，一种类型要想通过foreach遍历，其内部必须有public IEnumerator GetEnumerator()这个方法，而通常的做法是让类型实现IEnumerable接口。

上面的代码还有一个问题，就是Person对象通过foreach遍历时，var并没有推断出是string类型而是object类型，这是因为Current就是object导致的，解决的方案就是泛型，看下面的代码：

class Person
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public string[] _Name = new string[] { "zxh", "jk", "ml", "wcw", "sk", "yzk","lmn" };

        public IEnumerator<string> GetEnumerator()
        {
            return new MyClass<string>(_Name);
        }
    }

    class MyClass<T>:IEnumerator<T>
    {
        public MyClass(T[] _Names)
        {
            this.names = _Names;
        }
        public T Current
        {
            get { return names[Index]; }
        }

        private T[] names { get; set; }
        private int Index = -1;

        public void Dispose()
        {
            //throw new NotImplementedException();
        }

        object IEnumerator.Current
        {
            get { throw new NotImplementedException(); }
        }

        public bool MoveNext()
        {
            Index++;
            if (Index>=names.Length)
            {
                return false;
            }
            else
            {
                return true;
            }
        }

        public void Reset()
        {
            Index = -1;
        }
    }

使用的方法如下：

           Person p1 = new Person();
            foreach (var item in p1)
            {
                Console.WriteLine(item);
            }

可以看到var已经被推断成string.

 

下面看一下，自己写的foreach遍历，还是那个Person类(必须有IEnumerator GetEnumerator()这个方法)：

把foreach遍历换成下面的代码：

           Person p1 = new Person();
            IEnumerator enumer = p1.GetEnumerator();
            while (enumer.MoveNext())
            {
                Console.WriteLine(enumer.Current);
            }

上面的代码也是能够正常执行的。

扩展：

            List<string> strLst = new List<string>();   //查看定义得知，其实现了IEnumerable<T>和IEnumerable2个接口
            strLst.AddRange(new string[] { "sk", "jk", "yzk" });
            IEnumerator enumer = strLst.GetEnumerator();
            while (enumer.MoveNext())
            {
                Console.WriteLine(enumer.Current);
            }

一般没人会这么写，遍历一个对象还是直接写foreach。这只不过是其原理。

            Dictionary<int, char> dic = new Dictionary<int, char>();
            dic.Add(1, '壹');
            dic.Add(2, '贰');
            dic.Add(3, '叁');
            dic.Add(4, '肆');
            dic.Add(5, '伍');
            dic.Add(6, '陆');
            dic.Add(7,'柒');
            dic.Add(8,'扒');
            dic.Add(9,'玖');

            IEnumerator iEnumer = dic.GetEnumerator();
            while (iEnumer.MoveNext())
            {
                KeyValuePair<int, char> item = (KeyValuePair<int, char>)iEnumer.Current;
                Console.WriteLine(item.Key+"   "+item.Value);
            }