2021年了,`IEnumerator`、`IEnumerable`接口还傻傻分不清楚?

简介: IEnumerator、IEnumerable这两个接口单词相近、含义相关,傻傻分不清楚。入行多年,一直没有系统性梳理这对李逵李鬼。

IEnumerator


IEnumerator、IEnumerable接口有相似的名称,这两个接口通常也在一起使用,它们有不同的用途。


IEnumerator接口为类内部的集合提供了迭代方式, IEnumerator 要求你实现三个方法:


  • MoveNext方法:该方法将集合索引加1,并返回一个bool值,指示是否已到达集合的末尾。


  • Reset方法:它将集合索引重置为其初始值-1,这会使枚举数无效。


  • Current方法: 返回position位置的当前对象


IEnumerable


IEnumerable接口为foreach迭代提供了支持,IEnumerable要求你实现GetEnumerator方法。


public IEnumerator GetEnumerator()
{
    return (IEnumerator)this;
}


该用哪一个接口?


仅凭以上辞藻,很难区分两个接口的使用场景。


IEnumerator接口定义对类中的集合类型对象的迭代方式


IEnumerable接口允许使用foreach循环进行枚举。


因此IEnumerable接口的GetEnumerator方法会返回一个IEnumerator接口。要实现IEnumerable,你还必须实现IEnumerator


从英文词根上讲:

IEnumerator接口代表了枚举器,里面定义了枚举方式,是名词。

IEnumerable接口代表该对象具备了可被枚举的性质,是形容词。


总之,如果您想提供对foreach的支持,那么就先让对象可枚举,再谈论枚举方式,也就是说实现这两个接口。


最佳实践


  • 在嵌套类中实现IEnumerator,这样你可以创建多个枚举器。


  • 为IEnumerator的Current方法提供异常处理。


为什么要这么做?


如果集合的内容发生变化,则
reset方法将被调用,紧接着当前枚举数无效,您将收到一个IndexOutOfRangeException异常(其他情况也可能导致此异常)。所以执行一个Try…Catch块来捕获这个异常并引发InvalidOperationException异常, 提示在迭代时不允许修改集合内容


这也正是我们常见的在foreach 里面尝试修改迭代对象会报InvalidOperationException异常的原因。


下面以汽车列表为例实现IEnumerator IEnumerable接口


using System;
using System.Collections;
namespace ConsoleEnum
{
    public class cars : IEnumerable
    {
        private car[] carlist;
        //Create internal array in constructor.
        public cars()
        {
            carlist= new car[6]
            {
                new car("Ford",1992),
                new car("Fiat",1988),
                new car("Buick",1932),
                new car("Ford",1932),
                new car("Dodge",1999),
                new car("Honda",1977)
            };
        }
        //private enumerator class
        private class  MyEnumerator:IEnumerator
        {
            public car[] carlist;
            int position = -1;
            //constructor
            public MyEnumerator(car[] list)
            {
                carlist=list;
            }
            private IEnumerator getEnumerator()
            {
                return (IEnumerator)this;
            }
            //IEnumerator
            public bool MoveNext()
            {
                position++;
                return (position < carlist.Length);
            }
            //IEnumerator
            public void Reset()
            {
                position = -1;
            }
            //IEnumerator
            public object Current
            {
                get
                {
                    try
                    {
                        return carlist[position];
                    }
                    catch (IndexOutOfRangeException)
                    {
                        throw new InvalidOperationException();
                    }
                }
            }
        }  //end nested class
      public IEnumerator GetEnumerator()
      {
          return new MyEnumerator(carlist);
      }
    }
}


foreach cars的时候,可以明显看到


  • foreach语法糖初次接触可枚举的cars, 实际会访问cars实现的 GetEnumerator()方法,拿到迭代器


  • foreach每次迭代,实际会访问迭代器的Current属性
相关文章
HashMap中傻傻分不清楚的那些概念
很多人在通过阅读源码的方式学习Java,这是个很好的方式。而JDK的源码自然是首选。在JDK的众多类中,我觉得HashMap及其相关的类是设计的比较好的。很多人读过HashMap的代码,不知道你们有没有和我一样,觉得HashMap中关于容量相关的参数定义的太多了,傻傻分不清楚。
HashMap中傻傻分不清楚的那些概念
|
设计模式 Java
快速分清抽象类与接口 | 带你学《Java面向对象编程》之六十一
本节结合实际情景,直观地为读者列表展示了抽象类与接口在不同维度上的区别。
快速分清抽象类与接口   | 带你学《Java面向对象编程》之六十一
|
设计模式 Java
迅速了解多例模式竞争者-枚举 | 带你学《Java面向对象编程》之七十四
本节向读者展示了其他实现有限个数量实例的办法-定义枚举类,并详细介绍了调用方法以及枚举较多例设计模式的不同。
|
安全 Java
初识“多继承小帮手”-接口 | 带你学《Java面向对象编程》之五十七
众所周知,Java中只允许单继承,但在实际应用中不免会有多继承的要求,此时,接口便应运而生了。
比较无处不在-灵活覆写equals方法 | 带你学《Java面向对象编程》之五十一
本节通过对比简单比较的实现代码与覆写Object类的比较方法实现比较逻辑,体现了Java精益求精的理念。
|
Java 数据库 数据安全/隐私保护
规则之间-方法覆写限制 | 带你学《Java面向对象编程》之四十
本节向读者介绍了覆写方法过程中的一些限制,并拓宽读者对访问权限控制符的认识,帮助读者进行有效的方法覆写。
|
Java 数据库
后浪拍前浪-覆写父类方法 | 带你学《Java面向对象编程》之三十九
既然出现了继承的关系,那么就存在子类和父类的联系,而在子类之中有可能定义和父类完全相同的方法或属性的名称,这个时候就称为覆写。
后浪拍前浪-覆写父类方法   | 带你学《Java面向对象编程》之三十九
|
Java 数据库
再生与终结-初识属性覆盖与final | 带你学《Java面向对象编程》之四十一
本节将为读者介绍属性覆盖和final关键字相关内容,并为读者展示如何在Java中定义一个“常量”。
方圆之内-继承相关限制 | 带你学《Java面向对象编程》之三十八
本节结合案例着重介绍了继承的两个限制,分别为多重继承在Java中不可行,继承类无法直接访问父类私有属性。
青出于蓝-了不起的继承类 | 带你学《Java面向对象编程》之三十六
本节带领读者提出问题,引出疑惑后,提出了解决问题的方法-继承,为读者首次介绍了面向对象的第二大特征-继承性。
青出于蓝-了不起的继承类   | 带你学《Java面向对象编程》之三十六

热门文章

最新文章