設計模式（十六）迭代器

冬先生發表於2023-12-06
設計模式

一、定義

提供一種方法順序訪問一個聚合物件中的各個元素，且不用暴露該物件的內部表示。迭代器模式是一種物件行為型模式，又稱為遊標（Cursor）模式。

二、描述

在軟體系統中，聚合物件擁有兩個職責：一是儲存資料，二是遍歷資料。從依賴性來看，前者是聚合物件的基本職責，而後者既是可變化的，又是可分離的。因此，可以將遍歷資料的行為從聚合物件中分離出來，封裝在迭代器物件中，由迭代器來提供遍歷聚合物件內部資料的行為，這將簡化聚合物件的設計，更加符合單一職責原則的要求。包含以下四個角色：1、Iterator（抽象迭代器）：它定義了訪問和遍歷元素的介面，宣告瞭用於遍歷資料元素的方法。
2、ConcreteIterator（具體迭代器）：它實現了抽象迭代器介面，完成對聚合物件的遍歷，同時在具體迭代器中透過遊標來記錄在聚合物件中所處的當前位置，在具體實現時，遊標通常是一個表示位置的非負整數。
3、Aggregate（抽象聚合類）：它用於儲存和管理元素物件，宣告一個CreateIterator()方法用於建立一個迭代器物件，充當抽象迭代器工廠角色。
4、ConcreteAggregate（具體聚合類）：它是抽象聚合類的子類，實現了在抽象聚合類中宣告的CreateIterator()方法，該方法返回一個與該具體聚合類對應的具體迭代器ConcreteIterator例項。

三、例子

X公司為某商場開發了一套銷售管理系統，在對該系統進行分析和設計時，M公司開發人員發現經常需要對系統中的商品資料、客戶資料等進行遍歷，為了複用這些遍歷程式碼，開發人員設計了一個抽象的資料聚合類AbstractObjectList，而將儲存商品和客戶登記的類作為其子類。

AbstractObjectList：抽象聚合類

public abstract class AbstractObjectList
{
    protected IList<object> objectList = new List<object>();

    public AbstractObjectList (IList<object> objectList)
    {
        this.objectList = objectList;
    }

    public void AddObject(object obj)
    {
        this.objectList.Add(obj);
    }

    public void RemoveObject(object obj)
    {
        this.objectList.Remove(obj);
    }

    public IList<Object> GetObjectList()
    {
        return this.objectList;
    }

    // 宣告建立迭代器物件的抽象工廠方法
    public abstract AbstractIterator CreateIterator();
}

ProductList、ProductIterator：具體聚合類、具體迭代器，具體迭代器是具體聚合類的內部類

public class ProductList : AbstractObjectList
{
    public ProductList(IList<object> objectList) : base(objectList)
    {
    }

    public override AbstractIterator CreateIterator()
    {
        return new ProductIterator(this);
    }

    private class ProductIterator : AbstractIterator
    {
        private ProductList productList;
        private IList<object> products;
        private int cursor1;    // 定義一個遊標，用於記錄正向遍歷的位置
        private int cursor2;    // 定義一個遊標，用於記錄逆向遍歷的位置

        public ProductIterator(ProductList productList)
        {
            this.productList = productList;
            this.products = productList.GetObjectList();       // 獲取集合物件
            this.cursor1 = 0;                                  // 設定正向遍歷遊標的初始值
            this.cursor2 = this.products.Count - 1;            // 設定逆向遍歷遊標的初始值
        }

        public object GetNextItem()
        {
            return products[cursor1];
        }

        public object GetPreviousItem()
        {
            return products[cursor2];
        }

        public bool IsFirst()
        {
            return cursor2 == -1;
        }

        public bool IsLast()
        {
            return cursor1 == products.Count;
        }

        public void Next()
        {
            if (cursor1 < products.Count)
            {
                cursor1++;
            }
        }

        public void Previous()
        {
            if (cursor2 > -1)
            {
                cursor2--;
            }
        }
    }
}

AbstractIterator：抽象迭代器

public interface AbstractIterator
{
    void Next();               // 移動至下一個元素
    bool IsLast();             // 判斷是否為最後一個元素
    void Previous();           // 移動至上一個元素
    bool IsFirst();            // 判斷是否為第一個元素
    object GetNextItem();      // 獲取下一個元素
    object GetPreviousItem();  // 獲取上一個元素
}

Program：客戶端測試類

IList<object> products = new List<object>();
products.Add("倚天劍");
products.Add("屠龍刀");
products.Add("斷腸草");
products.Add("葵花寶典");
products.Add("四十二章經");

AbstractObjectList objectList = new ProductList(products);      // 建立聚合物件
AbstractIterator iterator = objectList.CreateIterator();        // 建立迭代器物件

Console.WriteLine("正向遍歷");
while (!iterator.IsLast())
{
    Console.Write(iterator.GetNextItem() + ",");
    iterator.Next();
}

Console.WriteLine();
Console.WriteLine("-------------------------------------------------------");
Console.WriteLine("逆向遍歷");
while (!iterator.IsFirst())
{
    Console.Write(iterator.GetPreviousItem() + ",");
    iterator.Previous();
}
Console.ReadLine();

四、總結

1、優點

（1）迭代器模式支援以不同方式遍歷一個聚合物件，在同一個聚合物件上可以定義多種便利方式。在迭代器模式中，只需用一個不同的迭代器來替換原有迭代器即可改變遍歷演算法，也可以自己定義迭代器的子類以支援新的遍歷方法。
（2）迭代器模式簡化了聚合類。由於引入了迭代器，在原有的聚合物件中不需要再自行提供資料遍歷等方法，這樣可以簡化聚合類的設計。
（3）在迭代器模式中，由於引入了抽象層，增加新的聚合類和迭代器類都很方便，無須修改原有程式碼，符合開閉原則。

2、缺點

（1）由於迭代器模式將儲存資料和遍歷資料的職責分離，在增加新的聚合類需要對應增加新的迭代器類，類的個數會成對增加，這在一定程度上增加了系統的複雜性。
（2）抽象迭代器的設計難度較大，需要充分考慮系統將來的擴充套件。在自定義迭代器時，建立一個考慮全面的抽象迭代器並不是一件很容易的事情。

迭代器模式在.Net中，可以透過實現IEnumberable介面即可，不再需要單獨實現，迭代器模式中的聚集介面和迭代器介面都已經存在了，其中IEnumerator介面扮演的就是迭代器角色，IEnumberable介面則扮演的就是抽象聚集的角色，其中定義了GetEnumerator()方法。

相關文章