设计模式-迭代器模式

在一个页面中展示出学校的院系组成，其中一个学校有多个学院，一个学院有多个系

---

1.传统方式

将学院看做是学校的子类，系是学院的子类。假设需要采用不同方式存储元素(比如数组或者Java的集合类)，当客户端要遍历这些集合元素的时就要使用多种遍历方式，而且还会暴露元素的内部结构

---

2.迭代器模式

2.1 基本介绍

• 属于行为型模式

• 提供一种遍历集合元素的统一接口，用一致的方法遍历集合元素，不需要知道集合对象的底层表示

• Iterator：迭代器接口，由系统提供，包含hasNext, next, remove三种方法
• ConcreteIterator：具体的迭代器类，管理迭代
• Aggregate：统一的聚合接口， 将客户端和具体聚合解耦
• ConcreteAggregate ：用于聚合集合/数组中的具体对象，并提供方法返回一个迭代器(由于遍历集合)

2.2 代码实现

// 系
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;
    }
}

// ConcreteIterator
public class ComputerCollegeIterator implements Iterator {
    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;
    }

    // 删除元素，默认空实现
    public void remove() {
    }
}

// Aggregate
public interface College {
    public String getName();

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

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

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

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

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

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

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

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

    @Override
    // list的方式添加
    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() {
        // 从collegeList取出所有学院
        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());
        }
    }
}

public class Client {
    public static void main(String[] args) {
        // 创建学院
        List<College> collegeList = new ArrayList<>();

        ComputerCollege computerCollege = new ComputerCollege();
        InfoCollege infoCollege = new InfoCollege();

        collegeList.add(computerCollege);
        //collegeList.add(infoCollege);

        OutPutImpl outPutImpl = new OutPutImpl(collegeList);
        outPutImpl.printCollege();
    }
}

---

3.注意事项和细节

• 提供一个统一的方法遍历对象
• 隐藏了聚合的内部结构(客户端要遍历聚合的时候只能取到迭代器，不会知道聚合的具体组成)
• 每个聚合对象都要一个迭代器，会生成多个迭代器
• 当要展示一组相似对象或遍历一组相同对象时使用迭代器模式

---

参考

https://www.bilibili.com/video/BV1G4411c7N4?p=111-116

---