设计模式（十三）之行为型模式-迭代器模式

一、迭代器模式

1、案例分析

学校院系展示需求：

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

1.1.1 传统方案

传统方案：学校由学院组成，学院由系组成

1.1.2 传统方案存在问题

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

1.1.3 组合模式

之前已经用组合模式解决过该问题，现在可以换另一种方式解决

1.1.4 需求假设

假设在传统方案中，存在如下情况

（1）计算机学院 的系 存在数组中

（2）信息工程学院的系 存在集合中

这个时候，就可以使用迭代器模式

2、迭代器模式基本介绍

2.1 基本介绍

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

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

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

2.2 原理类图

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

（2）ConcreteIterator：具体的迭代器类，管理迭代

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

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

（5）Client：客户端，通过Iterator和Aggregate依赖子类

3、实例原理类图

4、代码实例

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

4.2 ComputerCollegeIterator类

数组存放，实现Iterator接口，实现Iterator中的hasNext方法和next方法

import java.util.Iterator;
public class ComputerCollegeIterator implements Iterator {

    //这里我们需要了解Department  是以怎样的方式存放
    Department[] departments;
    int positions = 0;//遍历的位置

    public ComputerCollegeIterator(Department[] departments) {
        this.departments = departments;
    }

    //判断是否还有下一个元素
    @Override
    public boolean hasNext() {
        if(positions >= departments.length || departments[positions] == null){
            return false;
        }
        return true;
    }

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

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

4.3 InfoCollegeIterator类

list存放，实现Iterator接口，实现Iterator的hasNext方法和next方法

import java.util.Iterator;
import java.util.List;

public class InfoCollegeIterator  implements Iterator {

    List<Department> departmentList; //信息工程学院是以List方式存放系
    int index = -1;

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

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

    //判断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);
    }
}

4.4 College接口

import java.util.Iterator;

public interface College {

    public String getName();

    //增加系的方法
    public void addDepartment(String name,String desc);

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

4.5 ComputerCollege类

实现College接口，完成数据的初始化操作

import java.util.Iterator;

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

4.6 InfoCollege类

实现College接口

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

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

4.7 OutPutImpl类

import java.util.Iterator;
import java.util.List;

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

4.8 Client类

import java.util.ArrayList;
import java.util.List;

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 outPut = new OutPutImpl(collegeList);
        outPut.printCollege();
    }
}

结果：

=======计算机学院=========
Java专业
PHP专业
大数据专业
=======信息工程学院=========
信息安全专业
网络安全专业
服务器安全专业

5、迭代器模式在JDK-ArrayList集合应用的源码分析

5.1 代码例子

public class IteratorDemo {
  ![image-20210805225901805](设计模式（十三）之行为型模式-迭代器模式/image-20210805225901805.png)  public static void main(String[] args) {
        List<String> a = new ArrayList<>();
        a.add("jack");
        //获取到迭代器
        Iterator Itr = a.iterator();
        while(Itr.hasNext()){
            System.out.println(Itr.next());
        }
    }
}

（1）ArrayList类

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{    
    transient Object[] elementData; // non-private to simplify nested class access
}

（2）List接口，内聚Iterator

public interface List<E> extends Collection<E> {
    Iterator<E> iterator();
}

（3）查看ArrayList的其他实现类

public Iterator<E> iterator() {
    return new Itr();//返回的是一个Itr对象
}

（4）Itr类，ArrayList的内部类，实现Iterator接口

private class Itr implements Iterator<E> {}

（5）Iterator接口

public interface Iterator<E> {
    boolean hasNext();

    E next();
    
    default void remove() {
        throw new UnsupportedOperationException("remove");
    }

    default void forEachRemaining(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        while (hasNext())
            action.accept(next());
    }
}

5.2 代码类图

1. 内部类Itr：充当具体实现迭代器Iterator的类，作为ArrayList内部类
2. List就是充当了聚合接口，含有一个iterator()方法，返回一个迭代器对象
3. ArrayList是实现聚合接口List的子类，实现了iterator()
4. Iterator接口系统提供
5. 迭代器模式解决了不同集合（ArrayList，LinkedList）统一遍历问题

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

6.1 优点

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

6.2 缺点

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