黄继良

Appearance

On this page

迭代器模式 ​

概述|定义 ​

提供一个对象来顺序访问聚合对象的一系列数据，而不暴露聚合对象的内部表示

结构 ​

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

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

案例 ​

定义一个可以存储学生对象的容器对象，将遍历该同期的功能交由迭代器实现，设计到的类如下UML图

image-20221208210745421

代码 ​

遍历对象 ​

java
package com.huangjiliang.design.heima.behavior.iterator;

/**
 * @author 黄继良
 * @date 2022/12/8
 * @describe  容器中的对象《学生》
 */
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 + '\'' +
                '}';
    }
}

抽象迭代器 ​

java
package com.huangjiliang.design.heima.behavior.iterator;

/**
 * @author 黄继良
 * @date 2022/12/8
 * @describe 迭代器接口，声明hahNext,next方法
 */
public interface StudentIterator {

    boolean hasNext();

    Student next();
}

具体迭代器 ​

java
package com.huangjiliang.design.heima.behavior.iterator;

import java.util.List;

/**
 * @author 黄继良
 * @date 2022/12/8
 * @describe 具体迭代器类，重写所有抽象迭代器方法
 */
public class StudentIteratorImpl implements StudentIterator {

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

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

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

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

抽象容器 ​

java
package com.huangjiliang.design.heima.behavior.iterator;

/**
 * @author 黄继良
 * @date 2022/12/8
 * @describe 抽象容器类，包含添加元素、删除元素、获取迭代器对象等方法
 */
public interface StudentAggregate {

    void addStudent(Student student);

    void removeStudent(Student student);

    StudentIterator getStudentIterator();

}

具体容器 ​

java
package com.huangjiliang.design.heima.behavior.iterator;

import java.util.ArrayList;
import java.util.List;

/**
 * @author 黄继良
 * @date 2022/12/8
 * @describe 具体的容器类
 */
public class StudentAggregateImpl implements StudentAggregate {

    private List<Student> list = new ArrayList<>();


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

优缺点 ​

优点 ​

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

缺点 ​

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

使用场景 ​

  • 当需要为聚合对象提供多种遍历方式时
  • 当需要为遍历不同聚合结构提供一个统一的接口时
  • 当访问一个聚合对象的内容而无需暴露其内部细节的表示时

JDK源码解析 ​

迭代器模式在java的很多集合类中被广泛应用，接下来看java源码中是入户额使用迭代器模式的

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

单列集合都使用到了迭代器，我们以ArrayList举例来说明

java
public class ArrayList<E> extends AbstractList<E> implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
    
    public Iterator<E> iterator() {
        return new Itr();
    }
    
    private class Itr implements Iterator<E> {
        int cursor;       // 下一个要返回元素的索引
        int lastRet = -1; // 上一个返回元素的索引
        int expectedModCount = modCount;

        Itr() {}
        
        //判断是否还有元素
        public boolean hasNext() {
            return cursor != size;
        }

        //获取下一个元素
        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return (E) elementData[lastRet = i];
        }
    } 
}
  • 在iterator方法中返回一个实例化的Iterator对象，Itr是一个内部类，其实现了Iterator接口并重写了其中的抽象的方法
  • java开发欲使用迭代器模式的话，只需要自定义容器类实现java.util.Iterator并实现其中的iterator()方法使其返回一个java.util.Iterator的实现类就可以