行为型设计模式——迭代器模式

迭代器模式

迭代器模式也是非常的简单，定义如下： 提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。相信大家都使用过类似下面的迭代器：

List<String> list = new ArrayList<>();
Iterator<String> iterator = list.iterator(); //list.iterator()方法返回的肯定是Iterator接口的子实现类对象
while (iterator.hasNext()) {
    System.out.println(iterator.next());
}

如果在你的项目中需要对一个自定义的集合进行迭代遍历，那么迭代器模式是非常需要学习的。迭代器模式主要包含以下角色：

抽象聚合（Aggregate）角色：定义存储、添加、删除聚合元素以及创建迭代器对象的接口。
具体聚合（ConcreteAggregate）角色：实现抽象聚合类，返回一个具体迭代器的实例。
抽象迭代器（Iterator）角色：定义访问和遍历聚合元素的接口，通常包含 hasNext()、next() 等方法。
具体迭代器（Concretelterator）角色：实现抽象迭代器接口中所定义的方法，完成对聚合对象的遍历，记录遍历的当前位置。

案例实现

【例】定义一个可以存储学生对象的容器对象，将遍历该容器的功能交由迭代器实现，涉及到的类如下：
在这里插入图片描述

代码如下

首先定义Student对象，如下：

public class Student {
    private String name;
    private int age;

    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

然后定义Student类迭代器接口，主要就判断是否还有下一个元素和获取下一个元素两个方法，如下：

public interface StudentIterator {
    boolean hasNext();
    Student next();
}

然后实现学生类迭代器接口就好，如下：

public class StudentIteratoirImpl implements StudentIterator{
    private List<Student> list;
    private int position = 0;

    public StudentIteratoirImpl(List<Student> list){
        this.list = list;
    }

    @Override
    public boolean hasNext() {
        return position<list.size();
    }

    @Override
    public Student next() {
        Student student = list.get(position);
        position++;
        return student;
    }
}

其实到这里我们就已经完成了迭代器功能了，可以使用下面的代码测试迭代器，如下：

public class Main {
    public static void main(String[] args) {

        // 测试迭代器类
        ArrayList<Student> students = new ArrayList<>();
        students.add(new Student("张三",17));
        students.add(new Student("李四",19));
        students.add(new Student("王五",18));

        StudentIteratoirImpl iter = new StudentIteratoirImpl(students);
        while (iter.hasNext()){
            Student s = iter.next();
            System.out.println(s);
        }
    }
}

但是我们定义的是Student迭代器模型，上面的迭代器仅仅是实现了基础功能，如何需要的话我们可以将添加学生对象和删除学生对象的以及迭代的功能封装到一个容器类中，当然这部分内容属于扩展内容，如下：

// 定义学生容器接口
public interface StudentContainer {
    // 添加学生的操作
    void addStudent(Student student);
    // 移除学生
    void removeStudent(Student student);
    // 获取学生迭代器
    StudentIterator getStudentIterator();
}

// 实现学生容器接口
public class StudentContainerImpl implements StudentContainer{
    private List<Student> list = new ArrayList<Student>();
    @Override
    public void addStudent(Student student) {
        list.add(student);
    }

    @Override
    public void removeStudent(Student student) {
        list.remove(student);
    }

    @Override
    public StudentIterator getStudentIterator() {
        return new StudentIteratoirImpl(list);
    }
}

客户类测试：

public class Main {
    public static void main(String[] args) {

        // 测试迭代器类
        ArrayList<Student> students = new ArrayList<>();
        students.add(new Student("张三",17));
        students.add(new Student("李四",19));
        students.add(new Student("王五",18));

        StudentIteratoirImpl iter = new StudentIteratoirImpl(students);
        while (iter.hasNext()){
            Student s = iter.next();
            System.out.println(s);
        }

        System.out.println("-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-");

        // 测试学生容器类
        StudentContainerImpl studentContainer = new StudentContainerImpl();
        studentContainer.addStudent(new Student("张三",17));
        studentContainer.addStudent(new Student("李四",19));
        studentContainer.addStudent(new Student("王五",18));
        StudentIterator studentIterator = studentContainer.getStudentIterator();
        while (studentIterator.hasNext()){
            Student s = studentIterator.next();
            System.out.println(s);
        }
    }
}

输出结果：

Student{name=‘张三’, age=17}
Student{name=‘李四’, age=19}
Student{name=‘王五’, age=18}
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Student{name=‘张三’, age=17}
Student{name=‘李四’, age=19}
Student{name=‘王五’, age=18}

优点

它支持以不同的方式遍历一个聚合对象，在同一个聚合对象上可以定义多种遍历方式。在迭代器模式中只需要用一个不同的迭代器来替换原有迭代器即可改变遍历算法，我们也可以自己定义迭代器的子类以支持新的遍历方式。
迭代器简化了聚合类。由于引入了迭代器，在原有的聚合对象中不需要再自行提供数据遍历等方法，这样可以简化聚合类的设计。
在迭代器模式中，由于引入了抽象层，增加新的聚合类和迭代器类都很方便，无须修改原有代码，满足 “开闭原则” 的要求。