设计模式 -- 迭代器模式（Iterator Pattern）

1 问题引出

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

传统方式实现 

 

1. 将学院看做是学校的子类，系是学院的子类，这样实际上是站在组织大小来进行分层次的

2. 实际上我们的要求是 ：在一个页面中展示出学校的院系组成，一个学校有多个学院，一个学院有多个系， 因此这种方案，不能很好实现的遍历的操作

2 基本介绍

1. 迭代器模式（Iterator Pattern）是常用的设计模式，属于行为型模式

2. 如果我们的集合元素是用不同的方式实现的，有数组，还有 java 的集合类，或者还有其他方式，当客户端要遍历这些集合元素的时候就要使用多种遍历方式，而且还会暴露元素的内部结构，可以考虑使用迭代器模式解决。

3. 迭代器模式，提供一种遍历集合元素的统一接口，用一致的方法遍历集合元素，不需要知道集合对象的底层表示，即：不暴露其内部的结构。

3 原理结构图

3.1 类图

3.2 说明

1. Iterator ： 迭代器接口，是系统提供，含义 hasNext, next, remove

2. ConcreteIterator : 具体的迭代器类，管理迭代

3. Aggregate :一个统一的聚合接口， 将客户端和具体聚合解耦

4. ConcreteAggreage : 具体的聚合持有对象集合， 并提供一个方法，返回一个迭代器， 该迭代器可以正确遍历集合

5. Client :客户端， 通过 Iterator 和 Aggregate 依赖子类

4 应用实例

4.1 类图

4.2 代码实现

Client

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();
    }
​
}

College

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

ComputerCollege

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);
    }
}

ComputerCollegeIterator

public class ComputerCollegeIterator implements Iterator {
​
    //  这里我们需要 Department 是以怎样的方式存放=>数组
    Department[] departments;
    int position = 0; //  遍历的位置
​
    public ComputerCollegeIterator(Department[] departments) {
        this.departments = departments;
    }
​
    //  判断是否还有下一个元素@Override
    public boolean hasNext() {
        //  TODO Auto-generated method stub
        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() {}
​
}

Department

// 系
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;
    }
​
}

OutPutImpl

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());
        }
    }
}

5 优缺点

5.1 优点

1. 统一的遍历接口：迭代器模式提供了一致的方法来访问不同的集合类型，简化了客户端代码。
2. 解耦集合与遍历逻辑：由于集合的遍历逻辑被封装在迭代器中，集合类可以专注于存储和管理数据。客户端要遍历聚合的时候只能取到迭代器，而不会知道聚合的具体组成。
3. 支持多种遍历方式：同一个集合可以支持多种不同的遍历方式，只需添加新的迭代器即可。
4. 扩展性：增加新的聚合类或迭代器类很方便，符合“开闭原则”。

5.2 缺点

1. 增加复杂度：每增加一个新的集合类型，就需要增加一个新的迭代器类，这可能会增加系统的类数量。每个聚合对象都要一个迭代器，会生成多个迭代器不好管理类.
2. 实现成本：对于简单的遍历需求，实现迭代器模式可能会显得过于繁琐和不必要。

6 迭代器模式的应用

1. Java和.Net：在这些编程环境中，迭代器模式被广泛使用。Java的Iterator接口和.Net中的相似功能都是迭代器模式的实现。
2. 生成器（Generator）：在支持生成器功能的语言中，如JavaScript，生成器可以被视为一种特殊的迭代器，用于控制函数的执行流程。
3. 遍历不同数据结构：在需要遍历不同数据结构（如数组、树、图）时，迭代器模式提供了统一的解决方案。

7 总结

        迭代器模式是一种强大的设计模式，它使得遍历各种复杂的数据结构变得简单和统一。通过将遍历的逻辑封装在迭代器中，迭代器模式不仅提供了对数据访问的抽象，还允许灵活地添加新的遍历算法而不影响现有的代码。然而，迭代器模式的实现可能会增加系统的复杂性，因此在选择使用该模式时应该权衡其利弊后，再做抉择。