1. 是什么

定义: 在对象集合之间游走,而不暴露集合的实现。
**

2. 示例

2.1 Java 中的迭代器模式

在容器里存放了大量的同类型对象,我们如果想逐个访问容器中的对象,就必须要知道容器的结构。比如,ArrayList 和 LinkedList 的遍历方法一定是不一样的,如果再加上HashMap, TreeMap,以及我们现在正在研究的BinarySearchTree,对于容器的使用者而言,肯定是一个巨大的负担。作为容器的使用者,我肯定希望所有的容器能提供一个统一的接口,这个接口可以遍历容器中的所有内容,又可以把容器的细节屏蔽掉

幸运的是,确实存在这样的一个统一的接口,这个接口就是 java.util.Iterator。先看类图,下面的这幅图所表示的意思就是,在一个容器类上实现createIterator方法,这个方法可以创建一个迭代器,使用这个迭代器就可以遍历容器中的所有元素了。

迭代器模式 - 图1
Iterator上定义了各种方法,用于遍历。图中只列出了一小部分。我们可以看一下JDK中是怎么定义的:

  1. public interface Iterator<E> {
  2. boolean hasNext();
  3. E next();
  4. default void remove() {
  5. throw new UnsupportedOperationException("remove");
  6. }
  7. default void forEachRemaining(Consumer<? super E> action) {
  8. Objects.requireNonNull(action);
  9. while (hasNext())
  10. action.accept(next());
  11. }
  12. }

有两个default方法。default 这个关键字,我们以前没接触过。这是从1.8引入的,为了和以前的接口兼容,这个我们先不去管它,还有 forEachRemaing是一个高阶函数,它可以接受一个lambda表达式,这个我们会在后面的 Java 函数式编程中慢慢介绍,也先不去管它。所以 Iterator中也就只有两个方法,一个是hasNext,告诉使用者,还有没有下一个元素,如果为false,说明遍历已经完成了。还有一个是next,目的是取下一个元素。

List中的迭代器

我们先使用这个迭代器遍历一下List,例如:

  1. public class Main {
  2. public static void main(String args[]) {
  3. LinkedList<Integer> ll = new LinkedList<>();
  4. for (int i = 0; i < 10; i++)
  5. ll.addLast(i);
  6. Iterator<Integer> ii = ll.iterator();
  7. while (ii.hasNext())
  8. System.out.println(ii.next());
  9. }
  10. }

大家想一下,如果要让自己来实现这样的一个Iterator,你会怎么写?这里给出ArrayList的源代码,可以参考一下:

  1. public Iterator<E> iterator() {
  2. return new Itr();
  3. }
  4. /**
  5. * An optimized version of AbstractList.Itr
  6. */
  7. private class Itr implements Iterator<E> {
  8. int cursor; // index of next element to return
  9. int lastRet = -1; // index of last element returned; -1 if no such
  10. int expectedModCount = modCount;
  11. public boolean hasNext() {
  12. return cursor != size;
  13. }
  14. @SuppressWarnings("unchecked")
  15. public E next() {
  16. checkForComodification();
  17. int i = cursor;
  18. if (i >= size)
  19. throw new NoSuchElementException();
  20. Object[] elementData = ArrayList.this.elementData;
  21. if (i >= elementData.length)
  22. throw new ConcurrentModificationException();
  23. cursor = i + 1;
  24. return (E) elementData[lastRet = i];
  25. }
  26. }

我把 remove 等方法删掉了,这个方法是在 ListIterator定义的,先不去管它。这里只留下了 hasNext 和 next 方法

2.2 示例

代理背景:
  1. 有汉堡包店和晚餐店的菜单, 假设汉堡包店的菜单是用 List存放, 晚餐店是用数组存放的(用不同的存放方式,为了体现迭代器统一的处理方式)
  2. 服务生要将两家店的菜单都打印出来
  3. 这里先自己重写 Iterator, 为了体现迭代器的设计模式,在实际使用中,可以直接循环 Iterator
**

菜单项 Menu, 菜单有名称和价格
/**
 * 菜单
 */
@Data
public class Menu {
   private String name;
   private Double price;
}

晚餐店, 注意这里是用数组存放菜单的
/**
 * 晚餐店
 */
public class DinnerShop {

    private static final int MAX_ITEMS = 4;
    int index = 0;
    Menu[] menuItems;

    public DinnerShop() {
        menuItems = new Menu[MAX_ITEMS];

        // 默认就放入菜单项
        addItem("浪漫晚餐", 299d);
        addItem("小龙虾", 99d);
        addItem("鱿鱼", 49d);
        addItem("扇贝", 89d);
    }

    public void addItem(String name, double price) {
        Menu menu = new Menu(name, price);
        if (index >= MAX_ITEMS) {
            System.err.println("对不起, 菜单页满了");
        } else {
            menuItems[index] = menu;
            index++;
        }
    }

    // 创建迭代器:重点
    public Iterator createIteraotr() {
        return new DinnerMenuIterator(menuItems);
    }
}

晚餐点菜单迭代器, 重写 next()hasNext() 方法

/**
 * 晚餐菜单遍历类
 */
public class DinnerMenuIterator implements Iterator {
    Menu[] menuItems;
    int position = 0;

    public DinnerMenuIterator(Menu[] menuItems) {
        this.menuItems = menuItems;
    }

    @Override
    public boolean hasNext() {
        if (position >= menuItems.length || menuItems[position] == null) {
            return false;
        }

        return true;
    }

    @Override
    public Object next() {
        Menu menuItem = menuItems[position];
        position++;
        return menuItem;
    }
}

汉堡包店, 这里用List存放菜单
/**
 * 汉堡店菜单
 */
public class PancakeHouseShop {

    /**
     * 菜单列表
     */
    List<Menu> menuItems;

    public PancakeHouseShop() {
        this.menuItems = new ArrayList<>();

        // 默认就放入菜单项
        addItem("可乐", 3d);
        addItem("汉堡", 13d);
        addItem("薯条", 8d);
        addItem("鸡翅", 5d);
    }

    public void addItem(String name, Double price) {
        Menu menu = new Menu(name, price);
        menuItems.add(menu);
    }

    // 产生迭代器
    public Iterator createIterator() {
        return new PancakeHouseMenuIterator(menuItems);
    }
}

汉堡包店迭代器

/**
 * 汉堡包菜单迭代类
 */
public class PancakeHouseMenuIterator implements Iterator {
    List<Menu> menuItems;
    int position = 0;

    public PancakeHouseMenuIterator(List<Menu> menuItems) {
        this.menuItems = menuItems;
    }

    @Override
    public boolean hasNext() {
        if (position >= menuItems.size() || menuItems.get(position) == null) {
            return false;
        }

        return true;
    }

    @Override
    public Object next() {
        Menu menuItem = menuItems.get(position);
        position++;

        return menuItem;
    }
}

测试类:服务生
/**
 * 服务生
 */
public class Waiter {

    public void print() {
        System.out.println("================== 汉堡包菜单 ======================");
        PancakeHouseShop pancakeHouseShop = new PancakeHouseShop();
        Iterator pancakeHouseMenuIterator = pancakeHouseShop.createIterator();
        printMenu(pancakeHouseMenuIterator);

        System.out.println("=================== 晚餐菜单 =====================");
        DinnerShop dinnerShop = new DinnerShop();
        Iterator dinnerMenuIterator = dinnerShop.createIteraotr();
        printMenu(dinnerMenuIterator);
    }

    private void printMenu(Iterator iterator) {
        while (iterator.hasNext()) {
            Menu menu = (Menu) iterator.next();
            System.out.println("名称: " + menu.getName() + "======== 价格: " + menu.getPrice());
        }
    }

    public static void main(String[] args) {
        Waiter waiter = new Waiter();
        waiter.print();
    }
}
控制台打印:
================== 汉堡包菜单 ======================
名称: 可乐======== 价格: 3.0
名称: 汉堡======== 价格: 13.0
名称: 薯条======== 价格: 8.0
名称: 鸡翅======== 价格: 5.0
=================== 晚餐菜单 =====================
名称: 浪漫晚餐======== 价格: 299.0
名称: 小龙虾======== 价格: 99.0
名称: 鱿鱼======== 价格: 49.0
名称: 扇贝======== 价格: 89.0

总结
  1. 这里没有用直接将数组和 List 生成 Iterator, 是为了更方便的看出迭代器的作用
    2. 用统一的方式来遍历,不暴露内部细节