1、原由

在现实生活以及程序设计中，经常要访问一个聚合对象中的各个元素，如“数据结构”中的链表遍历，通常的做法是将链表的创建和遍历都放在同一个类中，但这种方式不利于程序的扩展，如果要更换遍历方法就必须修改程序源代码，这违背了 “开闭原则”。

既然将遍历方法封装在聚合类中不可取，那么聚合类中不提供遍历方法，将遍历方法由用户自己实现是否可行呢？答案是同样不可取，因为这种方式会存在两个缺点：

  1. 暴露了聚合类的内部表示，使其数据不安全；
  2. 增加了客户的负担。


“迭代器模式”能较好地克服以上缺点，它在客户访问类与聚合类之间插入一个迭代器，这分离了聚合对象与其遍历行为，对客户也隐藏了其内部细节，且满足“单一职责原则”和“开闭原则”，如 Java 中的 Collection、List、Set、Map 等都包含了迭代器。

迭代器模式在生活中应用的比较广泛，比如：物流系统中的传送带，不管传送的是什么物品，都会被打包成一个个箱子，并且有一个统一的二维码。这样我们不需要关心箱子里是什么，在分发时只需要一个个检查发送的目的地即可。再比如，我们平时乘坐交通工具，都是统一刷卡或者刷脸进站，而不需要关心是男性还是女性、是残疾人还是正常人等信息。

2、定义

迭代器（Iterator）模式的定义：提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。迭代器模式是一种对象行为型模式

3、优点

  1. 访问一个聚合对象的内容而无须暴露它的内部表示。
  2. 遍历任务交由迭代器完成，这简化了聚合类。
  3. 它支持以不同方式遍历一个聚合，甚至可以自定义迭代器的子类以支持新的遍历。
  4. 增加新的聚合类和迭代器类都很方便，无须修改原有代码。
  5. 封装性良好，为遍历不同的聚合结构提供一个统一的接口。

4、缺点

增加了类的个数，这在一定程度上增加了系统的复杂性。

在日常开发中，我们几乎不会自己写迭代器。除非需要定制一个自己实现的数据结构对应的迭代器，否则，开源框架提供的 API 完全够用。

5、结构

迭代器模式是通过将聚合对象的遍历行为分离出来，抽象成迭代器类来实现的，其目的是在不暴露聚合对象的内部结构的情况下，让外部代码透明地访问聚合的内部数据。现在我们来分析其基本结构与实现方法。
迭代器模式主要包含以下角色。

  1. 抽象聚合（Aggregate）角色：定义存储、添加、删除聚合对象以及创建迭代器对象的接口。
  2. 具体聚合（ConcreteAggregate）角色：实现抽象聚合类，返回一个具体迭代器的实例。
  3. 抽象迭代器（Iterator）角色：定义访问和遍历聚合元素的接口，通常包含 hasNext()、first()、next() 等方法。
  4. 具体迭代器（Concretelterator）角色：实现抽象迭代器接口中所定义的方法，完成对聚合对象的遍历，记录遍历的当前位置。


其结构图如图 1 所示。
image.png

6、实现

迭代器模式的实现代码如下：

  1. package net.biancheng.c.iterator;
  3. import java.util.*;
  5. public class IteratorPattern {
  6.     public static void main(String[] args) {
  7.         Aggregate ag = new ConcreteAggregate();
  8.         ag.add("中山大学");
  9.         ag.add("华南理工");
  10.         ag.add("韶关学院");
  11.         System.out.print("聚合的内容有：");
  12.         Iterator it = ag.getIterator();
  13.         while (it.hasNext()) {
  14.             Object ob = it.next();
  15.             System.out.print(ob.toString() + "\t");
  16.         }
  17.         Object ob = it.first();
  18.         System.out.println("\nFirst：" + ob.toString());
  19.     }
  20. }
  22. //抽象聚合
  23. interface Aggregate {
  24.     public void add(Object obj);
  26.     public void remove(Object obj);
  28.     public Iterator getIterator();
  29. }
  31. //具体聚合
  32. class ConcreteAggregate implements Aggregate {
  33.     private List<Object> list = new ArrayList<Object>();
  35.     public void add(Object obj) {
  36.         list.add(obj);
  37.     }
  39.     public void remove(Object obj) {
  40.         list.remove(obj);
  41.     }
  43.     public Iterator getIterator() {
  44.         return (new ConcreteIterator(list));
  45.     }
  46. }
  48. //抽象迭代器
  49. interface Iterator {
  50.     Object first();
  52.     Object next();
  54.     boolean hasNext();
  55. }
  57. //具体迭代器
  58. class ConcreteIterator implements Iterator {
  59.     private List<Object> list = null;
  60.     private int index = -1;
  62.     public ConcreteIterator(List<Object> list) {
  63.         this.list = list;
  64.     }
  66.     public boolean hasNext() {
  67.         if (index < list.size() - 1) {
  68.             return true;
  69.         } else {
  70.             return false;
  71.         }
  72.     }
  74.     public Object first() {
  75.         index = 0;
  76.         Object obj = list.get(index);
  77.         ;
  78.         return obj;
  79.     }
  81.     public Object next() {
  82.         Object obj = null;
  83.         if (this.hasNext()) {
  84.             obj = list.get(++index);
  85.         }
  86.         return obj;
  87.     }
  88. }

程序运行结果如下：
image.png

7、应用实例

1、用迭代器模式编写一个浏览婺源旅游风景图的程序

分析：婺源的名胜古迹较多，要设计一个查看相关景点图片（点此下载本实例所要显示的景点图片）和简介的程序，用“迭代器模式”设计比较合适。

首先，设计一个婺源景点（WyViewSpot）类来保存每张图片的名称与简介；再设计一个景点集（ViewSpotSet）接口，它是抽象聚合类，提供了增加和删除婺源景点的方法，以及获取迭代器的方法。

然后，定义一个婺源景点集（WyViewSpotSet）类，它是具体聚合类，用 ArrayList 来保存所有景点信息，并实现父类中的抽象方法；再定义婺源景点的抽象迭代器（ViewSpotltemtor）接口，其中包含了查看景点信息的相关方法。

最后，定义婺源景点的具体迭代器（WyViewSpotlterator）类，它实现了父类的抽象方法；客户端程序设计成窗口程序，它初始化婺源景点集（ViewSpotSet）中的数据，并实现 ActionListener 接口，它通过婺源景点迭代器（ViewSpotlterator）来査看婺源景点（WyViewSpot）的信息。图 2 所示是其结构图。
image.png
程序代码如下：

  1. package net.biancheng.c.iterator;
  3. import javax.swing.*;
  4. import java.awt.*;
  5. import java.awt.event.ActionEvent;
  6. import java.awt.event.ActionListener;
  7. import java.util.ArrayList;
  9. public class PictureIterator {
  10.     public static void main(String[] args) {
  11.         new PictureFrame();
  12.     }
  13. }
  15. //相框类
  16. class PictureFrame extends JFrame implements ActionListener {
  17.     private static final long serialVersionUID = 1L;
  18.     ViewSpotSet ag; //婺源景点集接口
  19.     ViewSpotIterator it; //婺源景点迭代器接口
  20.     WyViewSpot ob;    //婺源景点类
  22.     PictureFrame() {
  23.         super("中国最美乡村“婺源”的部分风景图");
  24.         this.setResizable(false);
  25.         ag = new WyViewSpotSet();
  26.         ag.add(new WyViewSpot("江湾", "江湾景区是婺源的一个国家5A级旅游景区，景区内有萧江宗祠、永思街、滕家老屋、婺源人家、乡贤园、百工坊等一大批古建筑，精美绝伦，做工精细。"));
  27.         ag.add(new WyViewSpot("李坑", "李坑村是一个以李姓聚居为主的古村落，是国家4A级旅游景区，其建筑风格独特，是著名的徽派建筑，给人一种安静、祥和的感觉。"));
  28.         ag.add(new WyViewSpot("思溪延村", "思溪延村位于婺源县思口镇境内，始建于南宋庆元五年（1199年），当时建村者俞氏以（鱼）思清溪水而名。"));
  29.         ag.add(new WyViewSpot("晓起村", "晓起有“中国茶文化第一村”与“国家级生态示范村”之美誉，村屋多为清代建筑，风格各具特色，村中小巷均铺青石，曲曲折折，回环如棋局。"));
  30.         ag.add(new WyViewSpot("菊径村", "菊径村形状为山环水绕型，小河成大半圆型，绕村庄将近一周，四周为高山环绕，符合中国的八卦“后山前水”设计，当地人称“脸盆村”。"));
  31.         ag.add(new WyViewSpot("篁岭", "篁岭是著名的“晒秋”文化起源地，也是一座距今近六百历史的徽州古村；篁岭属典型山居村落，民居围绕水口呈扇形梯状错落排布。"));
  32.         ag.add(new WyViewSpot("彩虹桥", "彩虹桥是婺源颇有特色的带顶的桥——廊桥，其不仅造型优美，而且它可在雨天里供行人歇脚，其名取自唐诗“两水夹明镜，双桥落彩虹”。"));
  33.         ag.add(new WyViewSpot("卧龙谷", "卧龙谷是国家4A级旅游区，这里飞泉瀑流泄银吐玉、彩池幽潭碧绿清新、山峰岩石挺拔奇巧，活脱脱一幅天然泼墨山水画。"));
  34.         it = ag.getIterator(); //获取婺源景点迭代器
  35.         ob = it.first();
  36.         this.showPicture(ob.getName(), ob.getIntroduce());
  37.     }
  39.     //显示图片
  40.     void showPicture(String Name, String Introduce) {
  41.         Container cp = this.getContentPane();
  42.         JPanel picturePanel = new JPanel();
  43.         JPanel controlPanel = new JPanel();
  44.         String FileName = "src/iterator/Picture/" + Name + ".jpg";
  45.         JLabel lb = new JLabel(Name, new ImageIcon(FileName), JLabel.CENTER);
  46.         JTextArea ta = new JTextArea(Introduce);
  47.         lb.setHorizontalTextPosition(JLabel.CENTER);
  48.         lb.setVerticalTextPosition(JLabel.TOP);
  49.         lb.setFont(new Font("宋体", Font.BOLD, 20));
  50.         ta.setLineWrap(true);
  51.         ta.setEditable(false);
  52.         //ta.setBackground(Color.orange);
  53.         picturePanel.setLayout(new BorderLayout(5, 5));
  54.         picturePanel.add("Center", lb);
  55.         picturePanel.add("South", ta);
  56.         JButton first, last, next, previous;
  57.         first = new JButton("第一张");
  58.         next = new JButton("下一张");
  59.         previous = new JButton("上一张");
  60.         last = new JButton("最末张");
  61.         first.addActionListener(this);
  62.         next.addActionListener(this);
  63.         previous.addActionListener(this);
  64.         last.addActionListener(this);
  65.         controlPanel.add(first);
  66.         controlPanel.add(next);
  67.         controlPanel.add(previous);
  68.         controlPanel.add(last);
  69.         cp.add("Center", picturePanel);
  70.         cp.add("South", controlPanel);
  71.         this.setSize(630, 550);
  72.         this.setVisible(true);
  73.         this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  74.     }
  76.     @Override
  77.     public void actionPerformed(ActionEvent arg0) {
  78.         String command = arg0.getActionCommand();
  79.         if (command.equals("第一张")) {
  80.             ob = it.first();
  81.             this.showPicture(ob.getName(), ob.getIntroduce());
  82.         } else if (command.equals("下一张")) {
  83.             ob = it.next();
  84.             this.showPicture(ob.getName(), ob.getIntroduce());
  85.         } else if (command.equals("上一张")) {
  86.             ob = it.previous();
  87.             this.showPicture(ob.getName(), ob.getIntroduce());
  88.         } else if (command.equals("最末张")) {
  89.             ob = it.last();
  90.             this.showPicture(ob.getName(), ob.getIntroduce());
  91.         }
  92.     }
  93. }
  95. //婺源景点类
  96. class WyViewSpot {
  97.     private String Name;
  98.     private String Introduce;
  100.     WyViewSpot(String Name, String Introduce) {
  101.         this.Name = Name;
  102.         this.Introduce = Introduce;
  103.     }
  105.     public String getName() {
  106.         return Name;
  107.     }
  109.     public String getIntroduce() {
  110.         return Introduce;
  111.     }
  112. }
  114. //抽象聚合：婺源景点集接口
  115. interface ViewSpotSet {
  116.     void add(WyViewSpot obj);
  118.     void remove(WyViewSpot obj);
  120.     ViewSpotIterator getIterator();
  121. }
  123. //具体聚合：婺源景点集
  124. class WyViewSpotSet implements ViewSpotSet {
  125.     private ArrayList<WyViewSpot> list = new ArrayList<WyViewSpot>();
  127.     public void add(WyViewSpot obj) {
  128.         list.add(obj);
  129.     }
  131.     public void remove(WyViewSpot obj) {
  132.         list.remove(obj);
  133.     }
  135.     public ViewSpotIterator getIterator() {
  136.         return (new WyViewSpotIterator(list));
  137.     }
  138. }
  140. //抽象迭代器：婺源景点迭代器接口
  141. interface ViewSpotIterator {
  142.     boolean hasNext();
  144.     WyViewSpot first();
  146.     WyViewSpot next();
  148.     WyViewSpot previous();
  150.     WyViewSpot last();
  151. }
  153. //具体迭代器：婺源景点迭代器
  154. class WyViewSpotIterator implements ViewSpotIterator {
  155.     private ArrayList<WyViewSpot> list = null;
  156.     private int index = -1;
  157.     WyViewSpot obj = null;
  159.     public WyViewSpotIterator(ArrayList<WyViewSpot> list) {
  160.         this.list = list;
  161.     }
  163.     public boolean hasNext() {
  164.         if (index < list.size() - 1) {
  165.             return true;
  166.         } else {
  167.             return false;
  168.         }
  169.     }
  171.     public WyViewSpot first() {
  172.         index = 0;
  173.         obj = list.get(index);
  174.         return obj;
  175.     }
  177.     public WyViewSpot next() {
  178.         if (this.hasNext()) {
  179.             obj = list.get(++index);
  180.         }
  181.         return obj;
  182.     }
  184.     public WyViewSpot previous() {
  185.         if (index > 0) {
  186.             obj = list.get(--index);
  187.         }
  188.         return obj;
  189.     }
  191.     public WyViewSpot last() {
  192.         index = list.size() - 1;
  193.         obj = list.get(index);
  194.         return obj;
  195.     }
  196. }

程序运行结果如图 3 所示
image.png

8、应用场景

前面介绍了关于迭代器模式的结构与特点，下面介绍其应用场景，迭代器模式通常在以下几种情况使用。

  1. 当需要为聚合对象提供多种遍历方式时。
  2. 当需要为遍历不同的聚合结构提供一个统一的接口时。
  3. 当访问一个聚合对象的内容而无须暴露其内部细节的表示时。


由于聚合与迭代器的关系非常密切，所以大多数语言在实现聚合类时都提供了迭代器类，因此大数情况下使用语言中已有的聚合类的迭代器就已经够了。

9、扩展

迭代器模式常常与组合模式结合起来使用，在对组合模式中的容器构件进行访问时，经常将迭代器潜藏在组合模式的容器构成类中。当然，也可以构造一个外部迭代器来对容器构件进行访问，其结构图如图 4 所示。
image.png

10、进阶阅读