迭代器模式

迭代器模式结构：

 

 

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DesignPattern.BehavioralPattern
{
    #region 迭代器模式要点
    //定义：提供顺序访问聚合对象内部元素的方式，而又无需暴露其内部表示。
    //主要思想是将集合的遍历行为抽取为单独的迭代器对象。
    //应用场景：
    //1.当集合背后为复杂的数据结构，且你希望对客户端隐藏其复杂性时（出于使用便利性或安全性的考虑）。
    //2.使用该模式可以减少程序中重复的遍历代码。
    //3. 如果你希望代码能够遍历不同的甚至是无法预知的数据结构，该模式为集合和迭代器提供了一些通用接口。
    //
    //实现方式：
    //1.声明迭代器接口。 该接口必须提供至少一个方法来获取集合中的下个元素。
    //还可以添加其他方法，获取前一个元素、记录当前位置和判断迭代是否已结束。

    //2.声明集合接口并描述一个获取迭代器的方法。 其返回值必须是迭代器接口。
    //如果你计划拥有多组不同的迭代器， 则可以声明多个类似的方法。

    //3.为希望使用迭代器进行遍历的集合实现具体迭代器类。
    //迭代器对象必须与单个集合实体链接，通常将聚合对象作为迭代器的构造函数参数传入的方式来建立。

    //4.在你的集合类中实现集合接口。其主要思想是针对特定集合为客户端代码提供创建迭代器的快捷方式。
    //其中集合对象必须将自身传递给迭代器的构造函数来创建两者之间的链接。

    //5.检查客户端代码， 使用迭代器替代所有集合遍历代码。
    //每当客户端需要遍历集合元素时都会获取一个新的迭代器。
    //

    #endregion

    //集合 （Collection） 接口声明一个或多个方法来获取与集合兼容的迭代器。
    //返回方法的类型必须被声明为迭代器接口， 因此具体集合可以返回各种不同种类的迭代器。
    public interface IteratorPattern<T>
    {
        Iterator<T> GetIterator();
    }

    //迭代器 （Iterator） 接口声明了遍历集合所需的操作： 获取下一个元素、 获取当前位置和重新开始迭代等。
    public abstract class Iterator<T>
    {
        public abstract T Current { get; }
        public abstract bool MoveNext();
        public abstract void Reset();
        public abstract int GetIndex();
    }

    //具体集合 （Concrete Collections） 会在客户端请求迭代器时返回一个特定的具体迭代器类实体。
    public class ConcreteIteratorPattern<T> : IteratorPattern<T>
    {
        List<T> _objList = new List<T>();
        public ConcreteIteratorPattern(T[] objs)
        {
            _objList.AddRange(objs);
        }

        public Iterator<T> GetIterator()
        {
            return new ConcreteIterator<T>(_objList);
        }
    }

    //具体迭代器 （Concrete Iterators） 实现遍历集合的一种特定算法。
    //迭代器对象必须跟踪自身遍历的进度。 这使得多个迭代器可以相互独立地遍历同一集合。
    public class ConcreteIterator<T> : Iterator<T>
    {
        private List<T> _objList;
        private int _index = -1;

        public ConcreteIterator(List<T> objList)
        {
            this._objList = objList;
        }

        public override T Current => GetCurrent();
        private T GetCurrent()
        {
            return _objList[_index];
        }

        public override int GetIndex()
        {
            return _index;
        }

        public override bool MoveNext()
        {
            _index++;
            if (_index < _objList.Count())
            {
                return true;
            }

            return false;
        }

        public override void Reset()
        {
            _index = 0;
        }
    }

    //客户端 （Client） 通过集合和迭代器的接口与两者进行交互。
    //这样一来客户端无需与具体类进行耦合， 允许同一客户端代码使用各种不同的集合和迭代器。
    //客户端通常不会自行创建迭代器， 而是会从集合中获取。但当客户端需要自定义特殊迭代器时例外。
    public class IteratorPatternClient
    {
        public static void Test()
        {
            int[] arr = new int[] { 2, 5, 6, 8, 9 };
            IteratorPattern<int> iteratorPattern = new ConcreteIteratorPattern<int>(arr);
            Iterator<int> iterator = iteratorPattern.GetIterator();

            while (iterator.MoveNext())
            {
                Console.WriteLine($"current = {iterator.Current},index = {iterator.GetIndex()}");
            }
        }
    }
}