设计模式——迭代器模式-CFANZ编程社区

模式介绍

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

UML类图

类图解析：

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

迭代器模式案例

背景介绍:在大学中有许多学院,使用迭代器模式对学院及其专业信息进行输出

Department专业类

public class Department {

    private String name;
    private String desc;

    public Department(String name, String desc) {
        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实现子类ComputerCollegeIterator、InfoCollegeIterator

public class ComputerCollegeIterator implements Iterator<Department> {
    // 数组存放
    private 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;
        }
        return true;
    }

    @Override
    public Department next() {
        Department department = departments[position];
        position++;
        return department;
    }

    /**
     * 空实现
     */
    @Override
    public void remove() {
    }
}

public class InfoCollegeIterator implements Iterator<Department> {
    // 以List存放
    private List<Department> departments;
    int index = -1;

    public InfoCollegeIterator(List<Department> departments) {
        this.departments = departments;
    }

    @Override
    public boolean hasNext() {
        if (index >= departments.size() - 1) {
            return false;
        }
        return true;
    }

    @Override
    public Department next() {
        index++;
        return departments.get(index);
    }
}

College接口及其实现子类ComputerCollege、InfoCollege

public interface College {
    /**
     * 获取名字
     * @return
     */
    String getName();

    /**
     * 添加系的方法
     * @param name
     * @param desc
     */
    void addDepartment(String name,String desc);

    Iterator<Department> creteIterator();
}

public class ComputerCollege implements College{
    private Department[] departments;
    private int numOfDepartment = 0; // 对象个数
    private String name;

    @Override
    public String getName() {
        return name;
    }

    public ComputerCollege() {
        departments = new Department[5];
        addDepartment("java专业","java专业");
        addDepartment("Python专业","Python专业");
        addDepartment("PHP专业","PHP专业");
        addDepartment("Go专业","Go专业");
        addDepartment("C++专业","C++专业");
        name = "计算机学院";
    }

    @Override
    public void addDepartment(String name, String desc) {
        Department department = new Department(name, desc);
        departments[numOfDepartment++] = department;
    }

    @Override
    public Iterator<Department> creteIterator() {
        return new ComputerCollegeIterator(departments);
    }
}

public class InfoCollege implements College {
    private List<Department> infoColleges;
    private String name;

    public InfoCollege() {
        name = "信息工程学院";
        infoColleges = new ArrayList<>();
        addDepartment("信息安全专业","信息安全专业");
        addDepartment("网络安全专业","网络安全专业");
        addDepartment("服务器专业","服务器专业");
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public void addDepartment(String name, String desc) {
        infoColleges.add(new Department(name, desc));
    }

    @Override
    public Iterator<Department> creteIterator() {
        return new InfoCollegeIterator(infoColleges);
    }
}

Output信息输出类

public class Output {
    // 学院集合
    private List<College> collegeList;

    public Output(List<College> collegeList) {
        this.collegeList = collegeList;
    }

    /**
     * 输出各个学院的系
     */
    public void printCollege() {
        collegeList.forEach(college -> {
            System.out.println("-------"+college.getName()+"-------");
            printDepartment(college.creteIterator());
        });
    }

    /**
     * 学院输出系
     */
    private void printDepartment(Iterator<Department> iterator) {
        while (iterator.hasNext()) {
            System.out.println(iterator.next().getName());
        }
    }
}

Client测试类

public class Client {
    public static void main(String[] args) {
        // 创建学院
        ComputerCollege computerCollege = new ComputerCollege();
        InfoCollege infoCollege = new InfoCollege();

        // 创建学院集合
        ArrayList<College> colleges = new ArrayList<>();
        colleges.add(computerCollege);
        colleges.add(infoCollege);

        // 输出信息类
        Output output = new Output(colleges);

        // 输出
        output.printCollege();
    }
}

实现结果:

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

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