迭代器模式

在现实生活以及程序设计中，经常要访问一个聚合对象中的各个元素，如“数据结构”中的链表遍历，通常的做法是将链表的创建和遍历都放在同一个类中，但这种方式不利于程序的扩展，如果要更换遍历方法就必须修改程序源代码，这违背了 “开闭原则”。 既然将遍历方法封装在聚合类中不可取，那么聚合类中不提供遍历方法，将遍历方法由用户自己实现是否可行呢？答案是同样不可取，因为这种方式会存在两个缺点：

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

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

 

看一个具体的需求

编写程序展示一个学校院系结构：需求是这样，要在一个页面中展示出学校的院系组成，一个学校有多个学院，一个学院有多少个系。如图：

传统的设计方案：

传统的方式的问题分析：

将学院看做是学校的子类，系是学院的子类，这样实际上是站在组织大小来进行分层次的实际上我们的要求是：在一个页面中展示出学校的院系组成，一个学校有多个学院，一个学院有多个系，因此这种方案，不能很好实现的遍历的操作解决方案：=> 迭代器模式

 

迭代器模式基本介绍

基本介绍：

迭代器模式(IteratorPattern)是常用的设计模式，属于行为型模式 如果我们的集合元素是用不同的方式实现的，有数组，还有Java的集合类，或者还有其他方式，当客户端要遍历这些集合元素的时候就要使用多种遍历方式，而且还会暴露元素的内部结构，可以考虑使用迭代器模式解决迭代器模式，提供一种遍历集合元素的统一接口，用一致的方法遍历集合元素，不需要知道集合对象的底层表示，即：不暴露其内部的结构

迭代器（Iterator）模式的主要优点如下：

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

其主要缺点是：增加了类的个数，这在一定程度上增加了系统的复杂性。

 

模式的结构与实现

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

模式的结构

迭代器模式主要包含以下角色：

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

其结构图如图 1 所示。

模式的实现

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

package iterator; import java.util.*; public class IteratorPattern { public static void main(String[] args) { Aggregate ag = new ConcreteAggregate(); ag.add("中山大学"); ag.add("华南理工"); ag.add("韶关学院"); System.out.print("聚合的内容有："); Iterator it = ag.getIterator(); while(it.hasNext()) { Object ob = it.next(); System.out.print(ob.toString()+"\t"); } Object ob = it.first(); System.out.println("\nFirst："+ob.toString()); } } // 抽象聚合 interface Aggregate { public void add(Object obj); public void remove(Object obj); public Iterator getIterator(); } // 具体聚合 class ConcreteAggregate implements Aggregate { private List<Object> list = new ArrayList<Object>(); public void add(Object obj) { list.add(obj); } public void remove(Object obj) { list.remove(obj); } public Iterator getIterator() { return(new ConcreteIterator(list)); } } // 抽象迭代器 interface Iterator { Object first(); Object next(); boolean hasNext(); } // 具体迭代器 class ConcreteIterator implements Iterator { private List<Object> list = null; private int index = -1; public ConcreteIterator(List<Object> list) { this.list = list; } public boolean hasNext() { if(index < list.size() - 1) { return true; } else { return false; } } public Object first() { index = 0; Object obj = list.get(index); return obj; } public Object next() { Object obj = null; if(this.hasNext()) { obj = list.get(++index); } return obj; } }

程序运行结果如下：

聚合的内容有：中山大学 华南理工 韶关学院 First：中山大学

 

迭代器模式应用实例

1) 应用实例要求，编写程序展示一个学校院系结构：需求是这样，要在一个页面中展示出学校的院系组成，一个学校有多个学院，一个学院有多个系。

2) 设计思路分析

3) 代码实现

package com.atguigu.iterator; import java.util.ArrayList; import java.util.List; public class Client { public static void main(String[] args) { // 创建学院 List<College> collegeList = new ArrayList<College>(); ComputerCollege computerCollege = new ComputerCollege(); InfoCollege infoCollege = new InfoCollege(); collegeList.add(computerCollege); // collegeList.add(infoCollege); OutPutImpl outPutImpl = new OutPutImpl(collegeList); outPutImpl.printCollege(); } } package com.atguigu.iterator; import java.util.Iterator; // 抽象聚合角色 public interface College { public String getName(); // 增加系的方法 public void addDepartment(String name, String desc); // 返回一个迭代器,遍历 public Iterator createIterator(); } package com.atguigu.iterator; import java.util.Iterator; // 具体聚合角色 public class ComputerCollege implements College { Department[] departments; // 保存当前数组的对象个数 int numOfDepartment = 0; public ComputerCollege() { departments = new Department[5]; addDepartment("Java 专业", " Java 专业 "); addDepartment("PHP 专业", " PHP 专业 "); addDepartment("大数据专业", " 大数据专业 "); } @Override public String getName() { return "计算机学院"; } @Override public void addDepartment(String name, String desc) { Department department = new Department(name, desc); departments[numOfDepartment] = department; numOfDepartment += 1; } @Override public Iterator createIterator() { return new ComputerCollegeIterator(departments); } } package com.atguigu.iterator; import java.util.Iterator; // 具体迭代器 public class ComputerCollegeIterator implements Iterator { // 这里我们需要 Department 是以怎样的方式存放=>数组 Department[] departments; // 遍历的位置 int position = 0; public ComputerCollegeIterator(Department[] departments) { this.departments = departments; } // 判断是否还有下一个元素 @Override public boolean hasNext() { if(position >= departments.length || departments[position] == null) { return false; } else { return true; } } @Override public Object next() { Department department = departments[position]; position += 1; return department; } // 删除的方法，默认空实现 public void remove() { } } package com.atguigu.iterator; // 系 public class Department { private String name; private String desc; public Department(String name, String desc) { super(); this.name = name; this.desc = desc; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getDesc() { return desc; } public void setDesc(String desc) { this.desc = desc; } } package com.atguigu.iterator; import java.util.Iterator; import java.util.List; // 具体迭代器 public class InfoColleageIterator implements Iterator { // 信息工程学院是以 List 方式存放系 List<Department> departmentList; // 索引 int index = -1; public InfoColleageIterator(List<Department> departmentList) { this.departmentList = departmentList; } // 判断 list 中还有没有下一个元素 @Override public boolean hasNext() { if(index >= departmentList.size() - 1) { return false; } else { index += 1; return true; } } @Override public Object next() { return departmentList.get(index); } // 空实现 remove public void remove() { } } package com.atguigu.iterator; import java.util.ArrayList; import java.util.Iterator; import java.util.List; // 具体聚合角色 public class InfoCollege implements College { List<Department> departmentList; public InfoCollege() { departmentList = new ArrayList<Department>(); addDepartment("信息安全专业", " 信息安全专业 "); addDepartment("网络安全专业", " 网络安全专业 "); addDepartment("服务器安全专业", " 服务器安全专业 "); } @Override public String getName() { return "信息工程学院"; } @Override public void addDepartment(String name, String desc) { Department department = new Department(name, desc); departmentList.add(department); } @Override public Iterator createIterator() { return new InfoColleageIterator(departmentList); } } package com.atguigu.iterator; import java.util.Iterator; import java.util.List; public class OutPutImpl { // 学院集合 List<College> collegeList; public OutPutImpl(List<College> collegeList) { this.collegeList = collegeList; } // 遍历所有学院，然后调用 printDepartment 输出各个学院的系 public void printCollege() { // 从 collegeList 取出所有学院, Java 中的 List 已经实现 Iterator Iterator<College> iterator = collegeList.iterator(); // 取出一个学院 while(iterator.hasNext()) { College college = iterator.next(); System.out.println("=== "+college.getName() +"=====" ); // 得到对应迭代器 printDepartment(college.createIterator()); } } // 输出 学院输出 系 public void printDepartment(Iterator iterator) { while(iterator.hasNext()) { Department d = (Department)iterator.next(); System.out.println(d.getName()); } } }

 

迭代器模式在 JDK-ArrayList 集合应用的源码分析

角色分析说明：

内部类Itr 充当具体实现迭代器Iterator 的类， 作为ArrayList 内部类List 就是充当了聚合接口，含有一个iterator() 方法，返回一个迭代器对象ArrayList 是实现聚合接口List 的子类，实现了iterator()Iterator 接口系统提供迭代器模式解决了 不同集合(ArrayList ,LinkedList) 统一遍历问题

 

模式的应用场景

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

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

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

 

模式的扩展

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

本系列完全参考韩顺平老师讲解的Java设计模式课程，仅做课后总结复习使用。

部分引用：http://c.biancheng.net/view/1322.html