迭代器模式 Iterator Pattern

一、模式介绍

1.1、定义

提供一个对象来顺序访问聚合对象中的一各个元素，而不是暴露对象的内部表示。

日常开发中，一般不会自己写迭代器，除非需要定制一个自己实现到的数据结构对应的迭代器；否则，开原框架提供的 API 完全够用。

1.2、优点

1. 访问一个聚合对象的内容而无需暴露它的内部表示
2. 遍历任务交由迭代器完成，这简化了聚合类
3. 它支持一下不同方式遍历一个聚合，甚至可以自定义迭代器的子类，以支持新的遍历
4. 增加新的聚合类和迭代器类都很方便，无须修改原有代码
5. 封装性良好，为遍历不同的聚合结构提供一个统一的接口

1.3、缺点

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

二、结构与实现

迭代器模式是通过将聚合对象的遍历行为分离出来，抽象成迭代器类来实现的，其目的是在不暴露聚合对象的内部结构的情况下，让外部代码透明地访问聚合的内部数据。

2.1、结构

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

2.2、实现

2.2.1、Iterator

package com.erlang.iterator;

/**
 * @description: 迭代器模式
 * @author: erlang
 * @since: 2022-02-20 15:02
 */
public interface Iterator {
    /**
     * 第一个元素
     *
     * @return 数据
     */
    Object first();

    /**
     * 当前位置下一个位置的对象
     *
     * @return 数据
     */
    Object next();

    /**
     * 下一个位置是否元素
     *
     * @return false|true
     */
    boolean hasNext();
}

2.2.2、ConcreteIterator

package com.erlang.iterator;

import java.util.List;

/**
 * @description: 具体迭代器
 * @author: erlang
 * @since: 2022-02-20 15:04
 */
public class ConcreteIterator implements Iterator {

    private List<Object> list = null;
    private int index = -1;

    public ConcreteIterator(List<Object> list) {
        this.list = list;
    }

    @Override
    public Object first() {
        index = 0;
        return list.get(index);
    }

    @Override
    public Object next() {
        if (this.hasNext()) {
            return list.get(++index);
        }
        return null;
    }

    @Override
    public boolean hasNext() {
        return index < list.size() - 1;
    }
}

2.2.3、Aggregate

package com.erlang.iterator;

/**
 * @description: 抽象聚合对象
 * @author: erlang
 * @since: 2022-02-20 15:06
 */
public interface Aggregate {

    /**
     * 添加元素
     *
     * @param o 元素
     */
    void add(Object o);

    /**
     * 移除指定元素
     *
     * @param o 元素
     */
    void remove(Object o);

    /**
     * 获取迭代器实例
     *
     * @return 迭代器实例
     */
    Iterator getIterator();

}

2.2.4、ConcreteAggregate

package com.erlang.iterator;

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

/**
 * @description: 具体聚合对象
 * @author: erlang
 * @since: 2022-02-20 15:07
 */
public class ConcreteAggregate implements Aggregate {

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

    @Override
    public void add(Object o) {
        list.add(o);
    }

    @Override
    public void remove(Object o) {
        list.remove(o);
    }

    @Override
    public Iterator getIterator() {
        return (new ConcreteIterator(list));
    }
}

2.2.5、IteratorClient

package com.erlang.iterator;

/**
 * @description: 迭代器客户端测试
 * @author: erlang
 * @since: 2022-02-20 15:09
 */
public class IteratorClient {
    public static void main(String[] args) {
        Aggregate ag = new ConcreteAggregate();
        ag.add("1");
        ag.add("2");
        ag.add("3");
        System.out.print("遍历集合：");
        Iterator it = ag.getIterator();
        while (it.hasNext()) {
            Object ob = it.next();
            System.out.print(ob.toString() + "\t");
        }
        Object ob = it.first();
        System.out.println("\n集合中第一个元素：" + ob.toString());
    }
}

2.2.6、执行结果

遍历集合：1	2	3	
集合中第一个元素：1