3.3 迭代器 Iterator

柔光的暖阳◎ 2022-12-25 01:55 181阅读 0赞

**专业描述**  
迭代器模式是一种行为设计模式， 让你能在不暴露集合底层表现形式 （列表、 栈和树等） 的情况下遍历集合中所有的元素。

**真实世界类比**  
你计划在罗马游览数天， 参观所有主要的旅游景点。 但在到达目的地后， 你可能会浪费很多时间绕圈子， 甚至找不到罗马斗兽场在哪里。

或者你可以购买一款智能手机上的虚拟导游程序。 这款程序非常智能而且价格不贵， 你想在景点待多久都可以。

第三种选择是用部分旅行预算雇佣一位对城市了如指掌的当地向导。 向导能根据你的喜好来安排行程， 为你介绍每个景点并讲述许多激动人心的故事。 这样的旅行可能会更有趣， 但所需费用也会更高。

所有这些选择(自由漫步、 智能手机导航或真人向导)都是这个由众多罗马景点组成的集合的迭代器。

**迭代器模式结构**  
![在这里插入图片描述][20201130104331134.png_pic_center]

1.  **迭代器 （Iterator）** 接口声明了遍历集合所需的操作： 获取下一个元素、 获取当前位置和重新开始迭代等。
2.  **具体迭代器 （Concrete Iterators）** 实现遍历集合的一种特定算法。 迭代器对象必须跟踪自身遍历的进度。 这使得多个迭代器可以相互独立地遍历同一集合。
3.  **集合 （Collection）** 接口声明一个或多个方法来获取与集合兼容的迭代器。 请注意， 返回方法的类型必须被声明为迭代器接口， 因此具体集合可以返回各种不同种类的迭代器。
4.  **具体集合 （Concrete Collections）** 会在客户端请求迭代器时返回一个特定的具体迭代器类实体。 你可能会琢磨， 剩下的集合代码在什么地方呢？ 不用担心， 它也会在同一个类中。 只是这些细节对于实际模式来说并不重要， 所以我们将其省略了而已。
5.  **客户端 （Client）** 通过集合和迭代器的接口与两者进行交互。 这样一来客户端无需与具体类进行耦合， 允许同一客户端代码使用各种不同的集合和迭代器。  
    客户端通常不会自行创建迭代器， 而是会从集合中获取。 但在特定情况下， 客户端可以直接创建一个迭代器 （例如当客户端需要自定义特殊迭代器时）。

**迭代器模式适合应用场景**

*  当集合背后为复杂的数据结构， 且你希望对客户端隐藏其复杂性时 （出于使用便利性或安全性的考虑）， 可以使用迭代器模式。
 *  使用该模式可以减少程序中重复的遍历代码。
 *  如果你希望代码能够遍历不同的甚至是无法预知的数据结构， 可以使用迭代器模式。

**实现方式**

1.  声明迭代器接口。 该接口必须提供至少一个方法来获取集合中的下个元素。 但为了使用方便， 你还可以添加一些其他方法， 例如获取前一个元素、 记录当前位置和判断迭代是否已结束。
2.  声明集合接口并描述一个获取迭代器的方法。 其返回值必须是迭代器接口。 如果你计划拥有多组不同的迭代器， 则可以声明多个类似的方法。
3.  为希望使用迭代器进行遍历的集合实现具体迭代器类。 迭代器对象必须与单个集合实体链接。 链接关系通常通过迭代器的构造函数建立。
4.  在你的集合类中实现集合接口。 其主要思想是针对特定集合为客户端代码提供创建迭代器的快捷方式。 集合对象必须将自身传递给迭代器的构造函数来创建两者之间的链接。
5.  检查客户端代码， 使用迭代器替代所有集合遍历代码。 每当客户端需要遍历集合元素时都会获取一个新的迭代器。

**C++代码示例：**

/** * Iterator Design Pattern * * Intent: Lets you traverse elements of a collection without exposing its * underlying representation (list, stack, tree, etc.). * 此例中Container存储数据，Iterator轮询数据。 * 是一个深入学习模板、友元、STL的绝佳用例。 */
    
    #include <iostream>
    #include <string>
    #include <vector>
    
    /** * C++ has its own implementation of iterator that works with a different * generics containers defined by the standard library. */
    
    template <typename T, typename U>
    class Iterator { 
     public:
      typedef typename std::vector<T>::iterator iter_type;
      Iterator(U *p_data, bool reverse = false) : m_p_data_(p_data) { 
        m_it_ = m_p_data_->m_data_.begin();
      }
    
      void First() { 
        m_it_ = m_p_data_->m_data_.begin();
      }
    
      void Next() { 
        m_it_++;
      }
    
      bool IsDone() { 
        return (m_it_ == m_p_data_->m_data_.end());
      }
    
      iter_type Current() { 
        return m_it_;
      }
    
     private:
      U *m_p_data_;
      iter_type m_it_;
    };
    
    /** * Generic Collections/Containers provides one or several methods for retrieving * fresh iterator instances, compatible with the collection class. */
    
    template <class T>
    class Container { 
      friend class Iterator<T, Container>;
    
     public:
      void Add(T a) { 
        m_data_.push_back(a);
      }
    
      Iterator<T, Container> *CreateIterator() { 
        return new Iterator<T, Container>(this);
      }
    
     private:
      std::vector<T> m_data_;
    };
    
    class Data { 
     public:
      Data(int a = 0) : m_data_(a) { }
    
      void set_data(int a) { 
        m_data_ = a;
      }
    
      int data() { 
        return m_data_;
      }
    
     private:
      int m_data_;
    };
    
    /** * The client code may or may not know about the Concrete Iterator or Collection * classes, for this implementation the container is generic so you can used * with an int or with a custom class. */
    void ClientCode() { 
      std::cout << "________________Iterator with int______________________________________" << std::endl;
      Container<int> cont;
    
      for (int i = 0; i < 10; i++) { 
        cont.Add(i);
      }
    
      Iterator<int, Container<int>> *it = cont.CreateIterator();
      for (it->First(); !it->IsDone(); it->Next()) { 
        std::cout << *it->Current() << std::endl;
      }
    
      Container<Data> cont2;
      Data a(100), b(1000), c(10000);
      cont2.Add(a);
      cont2.Add(b);
      cont2.Add(c);
    
      std::cout << "________________Iterator with custom Class______________________________" << std::endl;
      Iterator<Data, Container<Data>> *it2 = cont2.CreateIterator();
      for (it2->First(); !it2->IsDone(); it2->Next()) { 
        std::cout << it2->Current()->data() << std::endl;
      }
      delete it;
      delete it2;
    }
    
    int main() { 
      ClientCode();
      return 0;
    }

output:

________________Iterator with int______________________________________
    0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    ________________Iterator with custom Class______________________________
    100
    1000
    10000

[20201130104331134.png_pic_center]: /images/20221120/36591c3a2358456599f808ae9bd2f719.png