C#設計模式學習筆記：(15)迭代器模式

    本筆記摘抄自：https://www.cnblogs.com/PatrickLiu/p/7903617.html，記錄一下學習過程以備后續查用。

    一、引言

    今天我們要講行為型設計模式的第三個模式--迭代器模式，先從名字上來看。迭代是遍歷的意思，迭代器可以理解為是遍歷某某的工具，遍歷什么呢？在軟

件設計中，當然遍歷的是集合對象，所以說迭代器模式是遍歷集合的一種通用的算法。如果集合只有一種類型，那這個模式就沒用了，就是因為集合對象包含

數組、列表、字典和哈希表等各種對象。如果為每一種集合對象都實現一套遍歷算法，也不太現實，因此為了解決遍歷集合有一個統一的接口這個事情，所以

就提出了“迭代器”這個模式。

    二、迭代器模式介紹

    迭代器模式：英文名稱--Iterator Pattern；分類--行為型。

    2.1、動機（Motivate）

    在軟件構建過程中，集合對象內部結構常常變化各異。但對於這些集合對象，我們希望在不暴露其內部結構的同時，可以讓外部客戶代碼透明地訪問其中包

含的元素，同時這種“透明遍歷”也為“同一種算法在多種集合對象上進行操作”提供了可能。

    使用面向對象技術將這種遍歷機制抽象為“迭代器對象”為“應對變化中的集合對象”提供了一種優雅的方式。

    2.2、意圖（Intent）

    提供一種方法順序訪問一個聚合對象中的各個元素，而又不暴露該對象的內部表示。——《設計模式》GoF

    2.3、結構圖

    2.4、模式的組成

    從迭代器模式的結構圖可以看出，它涉及到四個角色，它們分別是：

    1）抽象迭代器(Iterator)：抽象迭代器定義了訪問和遍歷元素的接口，一般聲明以下方法：用於獲取第一個元素的first()、用於訪問下一個元素的next()、用於

判斷是否還有下一個元素的hasNext()、用於獲取當前元素的currentItem()，在其子類中將實現這些方法。

    2）具體迭代器(ConcreteIterator)：具體迭代器實現了抽象迭代器接口，完成對集合對象的遍歷，同時在對聚合進行遍歷時跟蹤其當前位置。

    3）抽象聚合類(Aggregate)：抽象聚合類用於存儲對象，並定義創建相應迭代器對象的接口，聲明一個createIterator()方法用於創建一個迭代器對象。

    4）具體聚合類(ConcreteAggregate)：具體聚合類實現了創建相應迭代器的接口，實現了在抽象聚合類中聲明的createIterator()方法，並返回一個與該具體聚

合相對應的具體迭代器ConcreteIterator實例。

    2.5、迭代器模式的具體實現

    迭代器模式在現實生活中也有類似的例子，比如：在部隊中，我們可以讓某一隊伍當中的某人出列，或者讓隊列里面的每個人依次報名，其實這個過程就是

一個遍歷的過程。具體實現代碼如下：

    class Program
    {
        /// <summary>
        /// 部隊隊列的抽象聚合類--該類型相當於抽象聚合類Aggregate
        /// </summary>
        public interface ITroopQueue
        {
            IIterator GetIterator();
        }

        /// <summary>
        /// 迭代器抽象類
        /// </summary>
        public interface IIterator
        {
            bool MoveNext();
            object GetCurrent();
            void Next();
            void Reset();
        }

        /// <summary>
        /// 部隊隊列具體聚合類--相當於具體聚合類ConcreteAggregate
        /// </summary>
        public sealed class ConcreteTroopQueue : ITroopQueue
        {
            private string[] collection;

            public ConcreteTroopQueue()
            {
                collection = new string[] { "黃飛鴻", "方世玉", "洪熙官", "嚴詠春" };
            }

            public IIterator GetIterator()
            {
                return new ConcreteIterator(this);
            }

            public int Length
            {
                get { return collection.Length; }
            }

            public string GetElement(int index)
            {
                return collection[index];
            }
        }

        /// <summary>
        /// 具體迭代器類
        /// </summary>
        public sealed class ConcreteIterator : IIterator
        {
            //迭代器要對集合對象進行遍歷操作，自然就需要引用集合對象。
            private ConcreteTroopQueue _list;
            private int _index;

            public ConcreteIterator(ConcreteTroopQueue list)
            {
                _list = list;
                _index = 0;
            }

            public bool MoveNext()
            {
                if (_index < _list.Length)
                {
                    return true;
                }
                return false;
            }

            public Object GetCurrent()
            {
                return _list.GetElement(_index);
            }

            public void Reset()
            {
                _index = 0;
            }

            public void Next()
            {
                if (_index < _list.Length)
                {
                    _index++;
                }
            }
        }

        static void Main(string[] args)
        {
            #region 迭代器模式
            IIterator iterator;
            ITroopQueue list = new ConcreteTroopQueue();
            iterator = list.GetIterator();
            while (iterator.MoveNext())
            {
                string name = (string)iterator.GetCurrent();
                Console.WriteLine(name);
                iterator.Next();
            }

            Console.Read();
            #endregion
        }
    }

    運行結果如下：

    三、迭代器模式的實現要點

    1）迭代抽象：訪問一個聚合對象的內容而無需暴露它的內部表示。

    2）迭代多態：為遍歷不同的集合結構提供一個統一的接口，從而支持同樣的算法在不同的集合結構上進行操作。

    3）迭代器的健壯性考慮：遍歷的同時更改迭代器所在的集合結構，會導致問題。

    3.1、迭代器模式的優點

    1）迭代器模式使得訪問一個聚合對象的內容而無需暴露它的內部表示，即迭代抽象。

    2）迭代器模式為遍歷不同的集合結構提供了一個統一的接口，從而支持同樣的算法在不同的集合結構上進行操作。

    3.2、迭代器模式的缺點

    1）迭代器模式在遍歷的同時更改迭代器所在的集合結構會導致出現異常，所以使用foreach語句只能在對集合進行遍歷，不能在遍歷的同時更改集合中的元素。

    3.3、迭代器模式的使用場景

    1）訪問一個聚合對象的內容而無需暴露它的內部表示。

    2）支持對聚合對象的多種遍歷。

    3）為遍歷不同的聚合結構提供一個統一的接口(即支持多態迭代)。

    四、.NET中迭代器模式的實現

    在mscorlib程序集里有這樣一個命名空間：System.Collections，在該命名空間里面早已有了迭代器模式的實現。對於聚集接口和迭代器接口已經存在了，其中

IEnumerator扮演的就是迭代器的角色，它的實現如下：

public interface IEnumerator
{
    object Current
    {
        get;
    }

    bool MoveNext();

    void Reset();
}

    屬性Current返回當前集合中的元素；Reset()方法恢復初始化指向的位置；MoveNext()方法返回值true表示迭代器成功前進到集合中的下一個元素，返回值false

表示已經位於集合的末尾，能夠以此來提供元素的遍歷。

    在.Net中IEnumerable扮演的就是抽象聚集的角色，只有一個GetEnumerator()方法，如果集合對象需要具備迭代遍歷的功能，就必須實現該接口。

public interface IEnumerable
{
    IEumerator GetEnumerator();
}

    抽象聚合角色（Aggregate）和抽象迭代器角色（Iterator）分別是IEnumerable接口和IEnumerator接口，具體聚合角色（ConcreteAggregate）有Queue、BitArray

等類型，代碼如下：

    public sealed class BitArray : ICollection, IEnumerable, ICloneable
    {
        [Serializable]
        private class BitArrayEnumeratorSimple : IEnumerator, ICloneable
        {
            private BitArray bitarray;

            private int index;

            private int version;

            private bool currentElement;

            public virtual object Current
            {
                get
                {
                    if (this.index == -1)
                    {
                        throw new InvalidOperationException(Environment.GetResourceString("InvalidOperation_EnumNotStarted"));
                    }
                    if (this.index >= this.bitarray.Count)
                    {
                        throw new InvalidOperationException(Environment.GetResourceString("InvalidOperation_EnumEnded"));
                    }
                    return this.currentElement;
                }
            }

            internal BitArrayEnumeratorSimple(BitArray bitarray)
            {
                this.bitarray = bitarray;
                this.index = -1;
                this.version = bitarray._version;
            }

            public object Clone()
            {
                return base.MemberwiseClone();
            }

            public virtual bool MoveNext()
            {
                if (this.version != this.bitarray._version)
                {
                    throw new InvalidOperationException(Environment.GetResourceString("InvalidOperation_EnumFailedVersion"));
                }
                if (this.index < this.bitarray.Count - 1)
                {
                    this.index++;
                    this.currentElement = this.bitarray.Get(this.index);
                    return true;
                }
                this.index = this.bitarray.Count;
                return false;
            }

            public void Reset()
            {
                if (this.version != this.bitarray._version)
                {
                    throw new InvalidOperationException(Environment.GetResourceString("InvalidOperation_EnumFailedVersion"));
                }
                this.index = -1;
            }
        }

        private const int BitsPerInt32 = 32;

        private const int BytesPerInt32 = 4;

        private const int BitsPerByte = 8;

        private int[] m_array;

        private int m_length;

        private int _version;

        [NonSerialized]
        private object _syncRoot;

        private const int _ShrinkThreshold = 256;

        [__DynamicallyInvokable]
        public bool this[int index]
        {
            [__DynamicallyInvokable]
            get
            {
                return this.Get(index);
            }
            [__DynamicallyInvokable]
            set
            {
                this.Set(index, value);
            }
        }

        [__DynamicallyInvokable]
        public int Length
        {
            [__DynamicallyInvokable]
            get
            {
                return this.m_length;
            }
            [__DynamicallyInvokable]
            set
            {
                if (value < 0)
                {
                    throw new ArgumentOutOfRangeException("value", Environment.GetResourceString("ArgumentOutOfRange_NeedNonNegNum"));
                }
                int arrayLength = BitArray.GetArrayLength(value, 32);
                if (arrayLength > this.m_array.Length || arrayLength + 256 < this.m_array.Length)
                {
                    int[] array = new int[arrayLength];
                    Array.Copy(this.m_array, array, (arrayLength > this.m_array.Length) ? this.m_array.Length : arrayLength);
                    this.m_array = array;
                }
                if (value > this.m_length)
                {
                    int num = BitArray.GetArrayLength(this.m_length, 32) - 1;
                    int num2 = this.m_length % 32;
                    if (num2 > 0)
                    {
                        this.m_array[num] &= (1 << num2) - 1;
                    }
                    Array.Clear(this.m_array, num + 1, arrayLength - num - 1);
                }
                this.m_length = value;
                this._version++;
            }
        }

        public int Count
        {
            get
            {
                return this.m_length;
            }
        }

        public object SyncRoot
        {
            get
            {
                if (this._syncRoot == null)
                {
                    Interlocked.CompareExchange<object>(ref this._syncRoot, new object(), null);
                }
                return this._syncRoot;
            }
        }

        public bool IsReadOnly
        {
            get
            {
                return false;
            }
        }

        public bool IsSynchronized
        {
            get
            {
                return false;
            }
        }

        private BitArray()
        {
        }

        [__DynamicallyInvokable]
        public BitArray(int length) : this(length, false)
        {
        }

        [__DynamicallyInvokable]
        public BitArray(int length, bool defaultValue)
        {
            if (length < 0)
            {
                throw new ArgumentOutOfRangeException("length", Environment.GetResourceString("ArgumentOutOfRange_NeedNonNegNum"));
            }
            this.m_array = new int[BitArray.GetArrayLength(length, 32)];
            this.m_length = length;
            int num = defaultValue ? -1 : 0;
            for (int i = 0; i < this.m_array.Length; i++)
            {
                this.m_array[i] = num;
            }
            this._version = 0;
        }

        [__DynamicallyInvokable]
        public BitArray(byte[] bytes)
        {
            if (bytes == null)
            {
                throw new ArgumentNullException("bytes");
            }
            if (bytes.Length > 268435455)
            {
                throw new ArgumentException(Environment.GetResourceString("Argument_ArrayTooLarge", new object[]
                {
                    8
                }), "bytes");
            }
            this.m_array = new int[BitArray.GetArrayLength(bytes.Length, 4)];
            this.m_length = bytes.Length * 8;
            int num = 0;
            int num2 = 0;
            while (bytes.Length - num2 >= 4)
            {
                this.m_array[num++] = ((int)(bytes[num2] & 255) | (int)(bytes[num2 + 1] & 255) << 8 | (int)(bytes[num2 + 2] & 255) << 16 | (int)(bytes[num2 + 3] & 255) << 24);
                num2 += 4;
            }
            switch (bytes.Length - num2)
            {
            case 1:
                goto IL_103;
            case 2:
                break;
            case 3:
                this.m_array[num] = (int)(bytes[num2 + 2] & 255) << 16;
                break;
            default:
                goto IL_11C;
            }
            this.m_array[num] |= (int)(bytes[num2 + 1] & 255) << 8;
            IL_103:
            this.m_array[num] |= (int)(bytes[num2] & 255);
            IL_11C:
            this._version = 0;
        }

        [__DynamicallyInvokable]
        public BitArray(bool[] values)
        {
            if (values == null)
            {
                throw new ArgumentNullException("values");
            }
            this.m_array = new int[BitArray.GetArrayLength(values.Length, 32)];
            this.m_length = values.Length;
            for (int i = 0; i < values.Length; i++)
            {
                if (values[i])
                {
                    this.m_array[i / 32] |= 1 << i % 32;
                }
            }
            this._version = 0;
        }

        [__DynamicallyInvokable]
        public BitArray(int[] values)
        {
            if (values == null)
            {
                throw new ArgumentNullException("values");
            }
            if (values.Length > 67108863)
            {
                throw new ArgumentException(Environment.GetResourceString("Argument_ArrayTooLarge", new object[]
                {
                    32
                }), "values");
            }
            this.m_array = new int[values.Length];
            this.m_length = values.Length * 32;
            Array.Copy(values, this.m_array, values.Length);
            this._version = 0;
        }

        [__DynamicallyInvokable]
        public BitArray(BitArray bits)
        {
            if (bits == null)
            {
                throw new ArgumentNullException("bits");
            }
            int arrayLength = BitArray.GetArrayLength(bits.m_length, 32);
            this.m_array = new int[arrayLength];
            this.m_length = bits.m_length;
            Array.Copy(bits.m_array, this.m_array, arrayLength);
            this._version = bits._version;
        }

        [__DynamicallyInvokable]
        public bool Get(int index)
        {
            if (index < 0 || index >= this.Length)
            {
                throw new ArgumentOutOfRangeException("index", Environment.GetResourceString("ArgumentOutOfRange_Index"));
            }
            return (this.m_array[index / 32] & 1 << index % 32) != 0;
        }

        [__DynamicallyInvokable]
        public void Set(int index, bool value)
        {
            if (index < 0 || index >= this.Length)
            {
                throw new ArgumentOutOfRangeException("index", Environment.GetResourceString("ArgumentOutOfRange_Index"));
            }
            if (value)
            {
                this.m_array[index / 32] |= 1 << index % 32;
            }
            else
            {
                this.m_array[index / 32] &= ~(1 << index % 32);
            }
            this._version++;
        }

        [__DynamicallyInvokable]
        public void SetAll(bool value)
        {
            int num = value ? -1 : 0;
            int arrayLength = BitArray.GetArrayLength(this.m_length, 32);
            for (int i = 0; i < arrayLength; i++)
            {
                this.m_array[i] = num;
            }
            this._version++;
        }

        [__DynamicallyInvokable]
        public BitArray And(BitArray value)
        {
            if (value == null)
            {
                throw new ArgumentNullException("value");
            }
            if (this.Length != value.Length)
            {
                throw new ArgumentException(Environment.GetResourceString("Arg_ArrayLengthsDiffer"));
            }
            int arrayLength = BitArray.GetArrayLength(this.m_length, 32);
            for (int i = 0; i < arrayLength; i++)
            {
                this.m_array[i] &= value.m_array[i];
            }
            this._version++;
            return this;
        }

        [__DynamicallyInvokable]
        public BitArray Or(BitArray value)
        {
            if (value == null)
            {
                throw new ArgumentNullException("value");
            }
            if (this.Length != value.Length)
            {
                throw new ArgumentException(Environment.GetResourceString("Arg_ArrayLengthsDiffer"));
            }
            int arrayLength = BitArray.GetArrayLength(this.m_length, 32);
            for (int i = 0; i < arrayLength; i++)
            {
                this.m_array[i] |= value.m_array[i];
            }
            this._version++;
            return this;
        }

        [__DynamicallyInvokable]
        public BitArray Xor(BitArray value)
        {
            if (value == null)
            {
                throw new ArgumentNullException("value");
            }
            if (this.Length != value.Length)
            {
                throw new ArgumentException(Environment.GetResourceString("Arg_ArrayLengthsDiffer"));
            }
            int arrayLength = BitArray.GetArrayLength(this.m_length, 32);
            for (int i = 0; i < arrayLength; i++)
            {
                this.m_array[i] ^= value.m_array[i];
            }
            this._version++;
            return this;
        }

        [__DynamicallyInvokable]
        public BitArray Not()
        {
            int arrayLength = BitArray.GetArrayLength(this.m_length, 32);
            for (int i = 0; i < arrayLength; i++)
            {
                this.m_array[i] = ~this.m_array[i];
            }
            this._version++;
            return this;
        }

        public void CopyTo(Array array, int index)
        {
            if (array == null)
            {
                throw new ArgumentNullException("array");
            }
            if (index < 0)
            {
                throw new ArgumentOutOfRangeException("index", Environment.GetResourceString("ArgumentOutOfRange_NeedNonNegNum"));
            }
            if (array.Rank != 1)
            {
                throw new ArgumentException(Environment.GetResourceString("Arg_RankMultiDimNotSupported"));
            }
            if (array is int[])
            {
                Array.Copy(this.m_array, 0, array, index, BitArray.GetArrayLength(this.m_length, 32));
                return;
            }
            if (array is byte[])
            {
                int arrayLength = BitArray.GetArrayLength(this.m_length, 8);
                if (array.Length - index < arrayLength)
                {
                    throw new ArgumentException(Environment.GetResourceString("Argument_InvalidOffLen"));
                }
                byte[] array2 = (byte[])array;
                for (int i = 0; i < arrayLength; i++)
                {
                    array2[index + i] = (byte)(this.m_array[i / 4] >> i % 4 * 8 & 255);
                }
                return;
            }
            else
            {
                if (!(array is bool[]))
                {
                    throw new ArgumentException(Environment.GetResourceString("Arg_BitArrayTypeUnsupported"));
                }
                if (array.Length - index < this.m_length)
                {
                    throw new ArgumentException(Environment.GetResourceString("Argument_InvalidOffLen"));
                }
                bool[] array3 = (bool[])array;
                for (int j = 0; j < this.m_length; j++)
                {
                    array3[index + j] = ((this.m_array[j / 32] >> j % 32 & 1) != 0);
                }
                return;
            }
        }

        public object Clone()
        {
            return new BitArray(this.m_array)
            {
                _version = this._version,
                m_length = this.m_length
            };
        }

        [__DynamicallyInvokable]
        public IEnumerator GetEnumerator()
        {
            return new BitArray.BitArrayEnumeratorSimple(this);
        }

        private static int GetArrayLength(int n, int div)
        {
            if (n <= 0)
            {
                return 0;
            }
            return (n - 1) / div + 1;
        }
    }

    還有很多類型，就不一一列舉了，大家可以查看源代碼，每個元素都可以在迭代器模式的構造圖上找到對應的元素，具體的類型和代碼截圖如下：

    五、總結

    想要深入學習迭代器模式，可以好好看看該模式在.Net框架中的實現，一定會讓你受益匪淺。