> For the complete documentation index, see [llms.txt](https://iyukiyama.gitbook.io/design-pattern/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://iyukiyama.gitbook.io/design-pattern/hang-wei-xing-she-ji-mo-shi/die-dai-qi-mo-shi.md).

# 迭代器模式

## 模式说明

对于由多个相同元素聚合而成的对象，需要遍历内部元素时，最直接的做法是在客户端通过一个`for`循环来实现遍历操作。该做法的缺点是对客户端暴露了聚合对象的内部，且增加了客户端的负担。另一种做法是在聚合对象内封装一个遍历方法，在客户端调用该方法。缺点同样明显，当要改变遍历方式(例如原本是从前往后，改成从后往前)，就需要修改聚合类中的遍历方法，违背开闭原则。针对这种场景，结合前两种方式的特点，可以将遍历方法分离出来，但不是在客户端中实现，而是创建一个迭代器类，类中持有聚合对象，并实现迭代方法。这样对客户端不用暴露聚合对象内部，又实现了遍历方法和聚合对象的分离。

本示例展示如何在客户端中通过自定义迭代器遍历自定义聚合类内的元素。客户端声明一个具体聚合类(以抽象聚合接口类型声明)，然后初始化该聚合的元素。再通过聚合类的`getIterator`方法获取具体迭代器类实例(以抽象迭代器类型)。最后调用该`Iterator`的相关方法完成遍历。

<br>

## 结构

**迭代器接口**: 义迭代器角色的方法，获取聚合内第一个元素的方法`first`，获取下一个元素的方法`next`，判断是否有下一个元素的方法`hasNext`。 **具体迭代器类**: 迭代器接口的实现类。持有聚合元素的集合`List<Object>`，持有当前处理元素的下标`index`。实现`fist`，`next`和`hasNext`三个接口方法。 **抽象聚合接口**: 定义聚合角色的方法，增加聚合元素的方法add，移除聚合元素的方法`remove`，获取一个迭代器示例的方法`getIterator`。 **具体聚合类**: 抽象聚合接口的实现类，以`List<Object>`持有一个聚合示例。实现抽象聚合接口中的`add`，`remove`，`getIterator`方法

<br>

## 代码演示

```java
package com.yukiyama.pattern.behavior;

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

/**
 * 迭代器模式
 */
public class IteratorDemo {

    public static void main(String[] args) {
        // 声明一个聚合实例
        AbstractAggregation agg = new MyAggregation();
        // 通过add方法初始化这个聚合
        agg.add("刘备");
        agg.add("关羽");
        agg.add("张飞");
        // 声明一个迭代器实例
        Iterator iter = agg.getIterator();
        // 取出第一个元素
        System.out.println("第一个元素: " + iter.first().toString());
        // 调用迭代器的hasNext和next方法迭代遍历，用toString将元素转为String输出
        System.out.println("====开始迭代遍历====");
        while(iter.hasNext()) {
            System.out.println(iter.next().toString());
        }
    }

}

/**
 * 迭代器接口
 * 定义迭代器角色的方法，获取聚合内第一个元素的方法first，获取下一个元素
 * 的方法next，判断是否有下一个元素的方法hasNext。
 */
interface Iterator{
    Object first();
    Object next();
    boolean hasNext();
}

/**
 * 具体迭代器实现类
 * 迭代器接口的实现类。持有聚合元素的集合List<Object>，并通过有参构造器
 * 初始化该集合。持有当前处理元素的下标index，初始值为-1，表示初识时未
 * 处理任何元素。实现fist，next和hasNext三个接口方法。
 */
class MyIterator implements Iterator{
    private List<Object> list;
    private int index = -1;
    
    public MyIterator(List<Object> list) {
        this.list = list;
    }
    @Override
    public Object first() {
        return list.get(0);
    }
    @Override
    public Object next() {
        Object obj = null;
        // 判断有下一个元素时，获取下一个元素，当前元素下标index+1
        if(this.hasNext()) {
            obj = list.get(index + 1);
            index++;
        }
        return obj;
    }
    @Override
    public boolean hasNext() {
        if(index < list.size() - 1) {
            return true;
        } else {
            return false;
        }
    }
}

/**
 * 抽象聚合类接口
 * 定义三个聚合角色的方法，增加聚合元素的方法add，移除聚合元素的方法remove，
 * 获取一个迭代器实例的方法getIterator。
 */
interface AbstractAggregation{
    void add(Object obj);
    void remove(Object obj);
    public Iterator getIterator();
}

/**
 * 具体聚合实现类
 * 抽象聚合接口的实现类，以List<Object>持有一个聚合实例。实现抽象聚合接口
 * 中的add，remove，getIterator方法。其中getIterator获取一个具体迭代器
 * 类的实例，获取方式是通过有参构造器new一个具体迭代类的实例并返回，构造器
 * 参数是聚合类内部持有的聚合对象List<Object> list。
 */
class MyAggregation implements AbstractAggregation{
    private List<Object> list = new ArrayList<>();
    
    @Override
    public void add(Object obj) {
        list.add(obj);
    }
    @Override
    public void remove(Object obj) {
        list.remove(obj);
    }
    @Override
    public Iterator getIterator() {
        return new MyIterator(list);
    }
}
```