设计模式【十一】—— 迭代器模式

第十六章迭代器模式

16.1 基本介绍

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

16.2 角色及职责

Iterator ：迭代器接口，是系统提供，含义 hasNext, next, remove方法
ConcreteIterator：具体的迭代器类，管理迭代
Aggregate：一个统一的聚合接口，将客户端和具体聚合解耦
ConcreteAggreage：具体的聚合持有对象集合，并提供一个方法，返回一个迭代器，该迭代器可以正确遍历集合
Element：基本元素类
Client：客户端，通过 Iterator 和 Aggregate 依赖子类

16.3 应用实例

在一个页面中展示出学校的院系组成，一个学校有多个学院，一个学院有多个系。每个学院的系是用不同的方式存放，比如：计算机学院里的系以数组方式存放、信息工程学院里的系以集合方式存放。因为数组和集合的遍历方式不同，所以需要使用迭代器模式实现遍历操作。

// element 类
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;
   }
}

// Iterator 接口实现类1：计算机学院
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() {      
   }
}

// Iterator 接口实现类2：信息工程学院
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() {      
   }
}

// Aggregate 统一的聚合接口
public interface College {  
   public String getName();
   //增加系的方法
   public void addDepartment(String name, String desc);   
   //返回一个迭代器,遍历
   public Iterator  createIterator();
}

// ConcreteAggreage 具体的聚合类1：计算机学院，返回一个迭代器
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);
   }
}

// ConcreteAggreage 具体的聚合类1：信息工程学院，返回一个迭代器
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);
   }
}

// 完成对所有学院的输出
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());
      }
   }   
}

// 客户端
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();
   }
}

16.4注意事项和细节

优点：

提供一个统一的方法遍历对象，客户不用再考虑聚合的类型，使用一种方法就可以遍历对象了。
隐藏了聚合的内部结构，客户端要遍历聚合的时候只能取到迭代器，而不会知道聚合的具体组成。
提供了一种设计思想，就是一个类应该只有一个引起变化的原因（叫做单一责任原则）。在聚合类中，我们把迭代器分开，就是要把管理对象集合和遍历对象集合的责任分开，这样一来集合改变的话，只影响到聚合对象。而如果遍历方式改变的话，只影响到了迭代器。

缺点：
每个聚合对象都要一个迭代器，会生成多个迭代器不好管理类。
应用场景：
当要展示一组相似对象，或者遍历一组相同对象时使用，适合使用迭代器模式。

16.5 在 JDK 中的应用

JDK 的 ArrayList 集合中就使用了迭代器模式。

Iterator 接口系统提供
内部类 Itr 充当具体实现迭代器 Iterator 的类，作为 ArrayList 内部类
List 就是充当了聚合接口，含有一个 iterator() 方法，返回一个迭代器对象
ArrayList（其中元素以数组方式存放）是实现聚合接口 List 的子类，实现了 iterator()

迭代器模式解决了不同集合（ArrayList、LinkedList）统一遍历问题。

设计模式【十一】—— 迭代器模式

第十六章 迭代器模式

16.1 基本介绍

16.2 角色及职责

16.3 应用实例

16.4注意事项和细节

16.5 在 JDK 中的应用

第十六章迭代器模式