Gof-迭代器模式

继续打卡设计模式

今天来聊一下迭代器模式

一、实际问题

现在有这样一个问题 编程展示在一个页面中学校的院系组成，一个学校有多个学院， 一个学院有多个系。

分析问题：
将学院看做是学校的子类，系是学院的子类，这样实际上是站在组织大小来进行分层次的
这样遍历的特别是比较简单，可以很直观的看到从大到小的结构。但是注意这里有一个要求是在一个页面中。这就不能说我在遍历一个对象的同时继续遍历它的子类对象。可能说我学java基础的双重for循环不就ok了吗

那我们还是先看看迭代器模式的解决方案。揣摩一下其中的不同点

二、迭代器解决方案

/**
 * @author: 德鑫
 * Description:
 * @Date: 2021/01/29
 */

public interface College {

    public String getName();

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

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

}

先写一个学院接口吧

里面包含了获取学院的名称 ，添加系、反回一个迭代器对象。注意这个迭代器对象是Java本身的迭代器对象

/**
 * @author: 德鑫
 * Description:
 * @Date: 2021/01/29
 */
//系
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;
    }
}

先来第一个信息工程学院

public class InfoCollege implements College {
    List<Department> departmentList;

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

管理信息工程学院的类 注意类型是一个List集合

/**
 * @author: 德鑫
 * Description:
 * @Date: 2021/01/29
 */

public class InfoColleageIterator implements Iterator {
    List<Department> departmentList;
    int index= -1;

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

再来一个计算机学院

/**
 * @author: 德鑫
 * Description:
 * @Date: 2021/01/29
 */

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

管理计算机学院的类 注意类型是一个数组

/**
 * @author: 德鑫
 * Description:
 * @Date: 2021/01/29
 */

public class ComputerCollegeIterator implements Iterator {
    Department[] departments;
    int position = 0; //遍历的位置

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

    @Override
    public void remove() {

    }
    //判断list中还有没有下一个元素
    @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;
    }
}

便于管理肯定是需要来一个界面类。有点类似于我们的命令模式

/**
 * @author: 德鑫
 * Description:
 * @Date: 2021/01/29
 */

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

对于college对象的管理

后面写一个客户端测试

/**
 * @author: 德鑫
 * Description:
 *迭代器设计模式 提供一个统一的遍历对象 ， 客户不在考虑聚合的类型。
 *隐藏了聚合的内部结构。客户端要遍历聚合的时候只能取到迭代器，而不会知道聚合的具体组成。
 * 提供了一种设计思想，就是一个类应该只有一个引起变化的原因。在聚合类中我们把迭代器分开。就是要把
 * 管理对象集合和遍历对象集合的责任分开。这样一来集合改变的话，只影响到聚合对象不影响遍历方式
 * 当要展示一组相似对象，或者遍历一遍相同对象的时候，适合使用迭代器模式。
 * @Date: 2021/01/29
 */

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

三、迭代器设计模式的总结

从上面例子看到对于集合的遍历。如果客户端直接来遍历根据对象属性的不同我们可能需要不同的遍历方式

总的来讲迭代器模式 提供一种遍历集合元素的统一接口。用一致的方法遍历集合元素，不需要知道集合对象的底层表示，也是隐藏了内部的结构