设计模式-21-迭代器模式

一、迭代器模式

迭代器模式（Iterator Pattern）是 Java 和 .Net 编程环境中非常常用的设计模式。这种模式用于顺序访问集合对象的元素，不需要知道集合对象的底层表示。

迭代器模式属于行为型模式。

二、介绍

意图：提供一种方法顺序访问一个聚合对象中各个元素, 而又无须暴露该对象的内部表示。

主要解决：不同的方式来遍历整个整合对象。

何时使用：遍历一个聚合对象。

如何解决：把在元素之间游走的责任交给迭代器，而不是聚合对象。

关键代码：定义接口：hasNext, next。

应用实例：JAVA 中的 iterator。

优点： 1、它支持以不同的方式遍历一个聚合对象。 2、迭代器简化了聚合类。 3、在同一个聚合上可以有多个遍历。 4、在迭代器模式中，增加新的聚合类和迭代器类都很方便，无须修改原有代码。

缺点：由于迭代器模式将存储数据和遍历数据的职责分离，增加新的聚合类需要对应增加新的迭代器类，类的个数成对增加，这在一定程度上增加了系统的复杂性。

使用场景： 1、访问一个聚合对象的内容而无须暴露它的内部表示。 2、需要为聚合对象提供多种遍历方式。 3、为遍历不同的聚合结构提供一个统一的接口。

注意事项：迭代器模式就是分离了集合对象的遍历行为，抽象出一个迭代器类来负责，这样既可以做到不暴露集合的内部结构，又可让外部代码透明地访问集合内部的数据。

三、结构

迭代器模式主要包含以下角色：

        1、抽象聚合角色：定义存储、添加、删除聚合元素以及创建迭代器对象的接口

        2、具体聚合角色：实现抽象聚合类，返回一个具体迭代器实例

        3、抽象迭代器角色：定义访问和遍历聚合元素的接口，通常包括hashNext(),next()等方法

        4、具体迭代器角色：实现抽象迭代器中接口所定义的方法，完成聚合对象的遍历，记录遍历的当前位置。

四、代码实现

定义一个学生类

package IP_01_Iterator;

/**
 * @Author: {LZG}
 * @ClassName: Student
 * @Description: 学生类
 * @Date: 2022/4/4 18:34
 **/
public class Student {
    private String name;
    private String number;

    public String getName() {
        return name;
    }

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

    public String getNumber() {
        return number;
    }

    public void setNumber(String number) {
        this.number = number;
    }

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

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

 定义一个抽象迭代器接口

package IP_01_Iterator;

/**
 * @Author: {LZG}
 * @ClassName: StudentIterator
 * @Description: 抽象迭代器接口
 * @Date: 2022/4/4 18:35
 **/
public interface StudentIterator {

    //  判断是否还有元素
    boolean hashNext();

    //  获取下一个元素
    Student next();

}

生成具体的迭代器

package IP_01_Iterator;
import java.util.*;
/**
 * @Author: {LZG}
 * @ClassName: StudentIteratorImpl
 * @Description: 具体的迭代器
 * @Date: 2022/4/4 18:36
 **/
public class StudentIteratorImpl implements StudentIterator{

    private List<Student> list;
    private int position=0;

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

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

    @Override
    public Student next() {
        //  从集合中获取指定位置元素
        Student currentStudent=list.get(position);
        position++;
        return currentStudent;
    }
}

定义一个抽象聚合接口

package IP_01_Iterator;

/**
 * @Author: {LZG}
 * @ClassName: StudentAggregate
 * @Description: 抽象聚合接口
 * @Date: 2022/4/4 18:39
 **/
public interface StudentAggregate {

    //  添加学生功能
    void addStudent(Student student);
    //  删除学生功能
    void removeStudent(Student student);
    //  获取迭代器对象功能
    StudentIterator getStudentIterator();


}

生成具体聚合角色

package IP_01_Iterator;
import java.util.*;
/**
 * @Author: {LZG}
 * @ClassName: StudentAggregateImpl
 * @Description: TODO
 * @Date: 2022/4/4 18:41
 **/
public class StudentAggregateImpl implements StudentAggregate{

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

客户

package IP_01_Iterator;

/**
 * @Author: {LZG}
 * @ClassName: Client
 * @Description: TODO
 * @Date: 2022/4/4 18:44
 **/
public class Client {
    public static void main(String[] args) {
        //  创建聚合对象
        StudentAggregateImpl studentAggregate = new StudentAggregateImpl();
        //  添加元素
        studentAggregate.addStudent(new Student("张三","001"));
        studentAggregate.addStudent(new Student("李四","002"));
        studentAggregate.addStudent(new Student("王五","003"));
        studentAggregate.addStudent(new Student("赵六","004"));

        //  遍历聚合对象

        //  1、获取迭代器对象
        StudentIterator studentIterator = studentAggregate.getStudentIterator();
        //  2、遍历
        while(studentIterator.hashNext()){
            //  获取元素
            Student student = studentIterator.next();
            System.out.println(student.toString());
        }

    }
}

测试结果

 类图

 五、优缺点

优点：

        1、它支持以一个不同的方式遍历一个聚合对象，在同一个聚合对象上可以定义多种遍历方式。在迭代器模式中只需要用一个不同的迭代器来替换原有迭代器即可改变遍历算法，我们也可以自定义迭代器的子类以支持新的遍历方式

        2、迭代器简化了聚合类，由于引入了迭代器，在原有的聚合对象中不需要再自行提供数据遍历等方法，满足”开闭原则“的要求

缺点：

        增加了类的个数，在一定程度上增加了系统的复杂性