15-迭代器模式

学校院系结构展示需求

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

传统方案分析

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

基本介绍

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

原理类图

迭代器模式的角色及职责

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

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

核心代码

具体的迭代器

/**
 * @ClassName Department
 * @author: shouanzh
 * @Description 系
 * @date 2022/1/26 14:23
 */
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;
    }
}

/**
 * @ClassName ComputerCollegeIterator
 * @author: shouanzh
 * @Description 计算机学院迭代器类
 * @date 2022/1/26 14:25
 */
public class ComputerCollegeIterator implements Iterator {

    private Department[] departments;
    private Integer 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;
    }

}


/**
 * @ClassName InfoCollegeIterator
 * @author: shouanzh
 * @Description 信息学院迭代器类
 * @date 2022/1/26 15:03
 */
public class InfoCollegeIterator implements Iterator {

    private List<Department> departments;
    private Integer index = -1; // 索引

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

    // 判断有没有下一个
    @Override
    public boolean hasNext() {

        if (index >= departments.size() -1) {
            return false;
        } else {
            index += 1;
            return true;
        }
    }

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

聚合接口

/**
 * @ClassName College
 * @author: shouanzh
 * @Description 聚合接口
 * @date 2022/1/26 15:12
 */
public interface College {

    String getName();

    // 增加系
    void addDepartment(String name, String desc);

    // 返回一个迭代器遍历
    Iterator createIterator();

}

具体的聚合类

/**
 * @ClassName ComputerCollege
 * @author: shouanzh
 * @Description 计算机学院
 * @date 2022/1/26 15:28
 */
public class ComputerCollege implements College{

    private Department[] departments;
    private Integer numberOfDepartment = 0; // 保存当前数组对象个数

    public ComputerCollege() {
        departments = new Department[5];
        addDepartment("Java专业","Java专业");
        addDepartment("PHP专业","PHP专业");
        addDepartment("Python专业","Python专业");
    }

    @Override
    public String getName() {
        return "计算机学院";
    }

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

    @Override
    public Iterator createIterator() {
        return new ComputerCollegeIterator(departments);
    }
}

/**
 * @ClassName InfoCollege
 * @author: shouanzh
 * @Description 信息学院
 * @date 2022/1/26 15:47
 */
public class InfoCollege implements College{

    private List<Department> departments;

    public InfoCollege() {
        departments = new ArrayList<>();
        departments.add(new Department("信息安全专业","信息安全专业"));
        departments.add(new Department("网络安全专业","网络安全专业"));
        departments.add(new Department("服务器安全专业","服务器安全专业"));
    }


    @Override
    public String getName() {
        return "信息学院";
    }

    @Override
    public void addDepartment(String name, String desc) {

    }

    @Override
    public Iterator createIterator() {
        return new InfoCollegeIterator(departments);
    }
}

输出类

/**
 * @ClassName OutPutImpl
 * @author: shouanzh
 * @Description 输出
 * @date 2022/1/26 15:55
 */
public class OutPutImpl {

    public void printCollege(List<College> collegeList) {
        Iterator<College> iterator = collegeList.iterator();
        while (iterator.hasNext()) {
            College college = iterator.next();
            System.out.println("============" + college.getName() + "============");
            printDepartment(college);
        }
    }

    private void printDepartment(College college) {
        Iterator<Department> iterator = college.createIterator();
        while (iterator.hasNext()) {
            System.out.println(iterator.next().getName());
        }
    }

}

测试

/**
 * @ClassName Client
 * @author: shouanzh
 * @Description Client
 * @date 2022/1/26 15:59
 */
public class Client {

    public static void main(String[] args) {
        List<College> collegeList = new ArrayList<>();
        collegeList.add(new ComputerCollege());
        collegeList.add(new InfoCollege());
        new OutPutImpl().printCollege(collegeList);
    }

}

ArrayList 集合源码分析

角色分析说明

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

迭代器模式提供了一个不同集合类型（如ArrayList、LinkedList等）的统一遍历解决方案

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

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

缺点
每个聚合对象都要一个迭代器，会生成多个迭代器不好管理类​