设计模式之迭代器模式

本文根据尚硅谷韩顺平老师的设计模式课程编写设计模式

一个需求

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

• 计算机学院
  • Java工程师
  • 大数据工程师
  • 前端工程师
  • 信息安全
• 信息工程学院
  • 网络信息安全
  • 电子技术

传统方式问题分析

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

基本介绍

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

角色

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

代码

public interface College {
    public String getName();

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

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

public class ComputerCollege implements College {

    Department[] departments;
    int numOfDepartment = 0;

    public ComputerCollege() {
        departments = new Department[5];
        addDepartment("Java工程师", "Java工程师");
        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);
    }
}

public class ComputerCollegeIterator implements Iterator {

    //这里我们需要知道Department是以怎样的方式存放的
    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;
        }else {
            return true;
        }
    }

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

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

//系
public class Department {
    private String name;
    private String 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;
    }

    public Department(String name, String desc) {
        this.name = name;
        this.desc = desc;
    }
}

public class InfoColleageiterator implements Iterator {

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

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

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

    @Override
    public void remove() {

    }
}

public class InfoCollege implements College {

    List<Department> departmentList;

    public InfoCollege() {
        departmentList = new ArrayList<>();
        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 InfoColleageiterator(departmentList);
    }
}

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

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

    //遍历所有学院然后地调用printDepartment输出各个学院的系
    public void printCollege(){
        //从college取出所有学院
        Iterator<College> iterator = collegeList.iterator();
        while (iterator.hasNext()){
            //取出一个学院
            College next = iterator.next();
            System.out.println("学院名称"+next.getName());
            //得到对应的迭代器
            printDepartment(next.createIterator());
        }
    }

    //输出 学院输出系
    public void printDepartment(Iterator iterator){
        while (iterator.hasNext()){
           Department department = (Department) iterator.next();
            System.out.println(department.getName());
        }
    }
}

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

        colleges.add(computerCollege);
        colleges.add(infoCollege);

        OutPutImpl outPut = new OutPutImpl(colleges);
        outPut.printCollege();
    }
}

JDK源码

JDK的ArrayList 集合中就使用了迭代器模式

注意事项和细节

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