迭代器模式

1、学校院系结构展示需求

编写程序展示一个学校院系结构,要在一个页面中展示出学校的院系组成,一个学校有多个学院,一个学院有多个系。如图:

image.png

传统方案分析

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

2、基本介绍

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

原理类图

image.png

迭代器模式的角色及职责

  • Iterator迭代器接口:系统提供,含有hasNextnextremove
  • ConcreteIterator具体的迭代器:管理相关的迭代
  • Aggregate聚合接口:将客户端和具体的聚合解耦
  • ConcreteAggregate具体的聚合类:提供一个方法,返回可以正确遍历集合的迭代器
  • Client客户端:通过Iterator迭代器接口和Aggregate聚合接口依赖其具体的迭代器和聚合子类

3、迭代器完成学校院系结构展示需求

UML 类图

image.png

核心代码

具体的迭代器

  1. /**
  2. * 计算机学院迭代器类
  3. */
  4. public class ComputerCollegeIterator implements Iterator {
  5. private Department[] departments;
  6. private Integer position = -1;
  7. public ComputerCollegeIterator(Department[] departments) {
  8. this.departments = departments;
  9. }
  10. @Override
  11. public boolean hasNext() {
  12. return position + 1 < departments.length && departments[position + 1] != null;
  13. }
  14. @Override
  15. public Object next() {
  16. return departments[++position];
  17. }
  18. }
  19. /**
  20. * 信息学院迭代器类
  21. */
  22. public class InfoCollegeIterator implements Iterator {
  23. private List<Department> departments;
  24. private Integer position = -1;
  25. public InfoCollegeIterator(List<Department> departments) {
  26. this.departments = departments;
  27. }
  28. @Override
  29. public boolean hasNext() {
  30. return position + 1 < departments.size();
  31. }
  32. @Override
  33. public Object next() {
  34. return departments.get(++position);
  35. }
  36. }

聚合接口

  1. public interface College {
  2. String getName();
  3. Iterator<Department> createIterator();
  4. }

具体的聚合类

  1. /**
  2. * 计算机学院
  3. */
  4. public class ComputerCollege implements College {
  5. private Department[] departments;
  6. private Integer position = 0;
  7. public ComputerCollege() {
  8. departments = new Department[5];
  9. departments[position++] = new Department("Java专业");
  10. departments[position++] = new Department("PHP专业");
  11. departments[position++] = new Department("Python专业");
  12. }
  13. @Override
  14. public String getName() {
  15. return "计算机学院";
  16. }
  17. @Override
  18. public Iterator<Department> createIterator() {
  19. return new ComputerCollegeIterator(departments);
  20. }
  21. }
  22. /**
  23. * 信息学院
  24. */
  25. public class InfoCollege implements College {
  26. private List<Department> departments;
  27. public InfoCollege() {
  28. departments = new ArrayList<>();
  29. departments.add(new Department("信息安全专业"));
  30. departments.add(new Department("网络安全专业"));
  31. departments.add(new Department("服务器安全专业"));
  32. }
  33. @Override
  34. public String getName() {
  35. return "信息学院";
  36. }
  37. @Override
  38. public Iterator<Department> createIterator() {
  39. return new InfoCollegeIterator(departments);
  40. }
  41. }

输出类

  1. public class OutPutImpl {
  2. public OutPutImpl() {
  3. }
  4. public void printCollege(List<College> collegeList) {
  5. Iterator<College> iterator = collegeList.iterator();
  6. while (iterator.hasNext()) {
  7. College college = iterator.next();
  8. System.out.println("============" + college.getName() + "============");
  9. printDepartment(college);
  10. }
  11. }
  12. private void printDepartment(College college) {
  13. Iterator<Department> iterator = college.createIterator();
  14. while (iterator.hasNext()) {
  15. System.out.println(iterator.next().getName());
  16. }
  17. }
  18. }

调用测试

  1. List<College> collegeList = new ArrayList<>();
  2. collegeList.add(new ComputerCollege());
  3. collegeList.add(new InfoCollege());
  4. new OutPutImpl().printCollege(collegeList);

打印结果

  1. //============计算机学院============
  2. //Java专业
  3. //PHP专业
  4. //Python专业
  5. //============信息学院============
  6. //信息安全专业
  7. //网络安全专业
  8. //服务器安全专业

4、ArrayList 集合源码分析

UML 类图

image.png

角色分析说明

  • Iterator迭代器接口:由系统提供,定义了hasNext()next()等方法
  • Itr具体的迭代器实现类:作为ArrayList的内部类存在,实现了Iterator接口的hasNext()next()等方法
  • List聚合接口:定义了iterator()方法,返回一个迭代器接口对象
  • ArrayList具体的聚合类:实现了iterator()方法

迭代器模式提供了一个不同集合类型(如ArrayListLinkedList等)的统一遍历解决方案

5、迭代器模式的注意事项和细节

优点

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

缺点

  • 每个聚合对象都要一个迭代器,会生成多个迭代器不好管理类