24种设计模式学习笔记之迭代器模式

迭代器模式-----行为模式
提供一种方法顺序访问一个聚合对象中的各个元素，而又不暴露其内部的表示。

UML图

迭代器模式组成结构

迭代器（Iterator）：迭代器定义访问和遍历元素的接口。
具体迭代器（ConcreteIterator）：具体迭代器实现迭代器接口，对该聚合遍历时跟踪当前位置。
聚合（Aggregate）：聚合定义创建相应迭代器对象的接口。
具体聚合（ConcreteAggregate）：具体聚合实现创建相应迭代器的接口，该操作返回 ConcreteIterator 的一个适当的实例。

迭代器模式适用场景

访问一个聚合对象的内容而无需暴露它的内部表示。
支持对聚合对象的多种遍历。
为遍历不同的聚合结构提供一个统一的接口。

优点

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

缺点

对于比较简单的遍历（像数组或者有序列表），使用迭代器方式遍历较为繁琐。

举个栗子：

包子店与沙县小吃合并啦：有一家包子店，他们负责提供早餐，卖各式各样的包子，并提供豆浆之类的饮品；也有一家沙县小吃，它们负责提供午餐和晚餐，卖一些盖浇饭和煲仔饭。为了获得更多的盈利，后来这两家店合并了。

但是却发现了一个问题，原来的包子店提供的菜单是用 List 集合结合存储的，而沙县小吃的菜单却是由数组存储的。所以在提供菜单的时候就会很麻烦，需要使用两个不同的循环来遍历对应的集合和数组，才能打印完整的菜单 (当然这项工作是由服务员完成的)。有没有更好的解决办法呢？这时候迭代器模式就登场了。

现在我们将这个问题用到代码中去实现。

/**
 * 用来封装菜单食物信息
 */
public class MenuItem {
    String name;   //食物名字
    double price;    //食物价格

    public MenuItem(String name, double price){
        this.name = name;
        this.price = price;
    }

    public String getName() {
        return name;
    }

    public double getPrice() {
        return price;
    }
}

/**
 *   聚合 Menu 接口
 * */
public interface  Menu {

    Iterator<MenuItem> createIterator();
}

/**
 * 包子菜单类，实现了 Menu 接口中的 createIterator() 方法
 */
public class BZMenu implements Menu{


    List<MenuItem> menuItems;

    /**
     * 通过构造函数，在菜单里添加一些菜品
     */
    public BZMenu() {
        menuItems = new ArrayList<>();

        addItem("雪菜包",1.0);
        addItem("灌汤包",1.0);
        addItem("韭菜包",1.0);
        addItem("猪肉包",1.0);
    }

    public void addItem(String name, double price){
        MenuItem menuItem = new MenuItem(name, price);
        menuItems.add(menuItem);
    }

    /**
     * 返回包子菜单信息的迭代器
     *
     * @return
     */
    @Override
    public Iterator<MenuItem> createIterator() {

        return new BZMenuIterator(menuItems);
    }
}

/**
 * 沙县菜单类，实现了 Menu 接口中的 createIterator() 方法
 */
public class SXMenu implements Menu{

    static final int MAX_ITEMS = 4;

    int indexOfItems = 0;

    MenuItem[] menuItems;

    /**
     * 通过构造函数，在菜单里添加一些菜品
     */
    public SXMenu(){
        menuItems = new MenuItem[MAX_ITEMS];

        addItem("青椒肉丝盖浇饭",10.0);
        addItem("西红柿鸡蛋盖浇饭",10.0);
        addItem("牛肉土豆煲仔饭",15.0);
        addItem("金针菇煲仔饭",10.0);
    }

    public void addItem(String name, double price){
        MenuItem menuItem = new MenuItem(name, price);

        if(indexOfItems >= MAX_ITEMS){
            System.out.println("菜单已满！");
        }else {
            menuItems[indexOfItems] = menuItem;
            indexOfItems ++;
        }
    }


    /**
     * 返回沙县菜单信息的迭代器
     *
     * @return
     */
    @Override
    public Iterator<MenuItem> createIterator() {
        return new SXMenuIterator(menuItems);
    }
}

/**
 *    具体迭代器 BZMenuIterator 类
 *    包子菜单信息迭代器
 * */
public class BZMenuIterator implements Iterator {

    List<MenuItem> menuItems;

    int position = 0;


    /**
     * 通过构造函数，实例化存储包子信息的菜单 List 集合
     * 虽然可以直接使用 Iterator 来遍历集合，为了更好理解迭代器模式，这里自己手写一个迭代器
     *
     * @param menuItems
     */
    public BZMenuIterator(List<MenuItem> menuItems){
        this.menuItems = menuItems;
    }

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

    @Override
    public Object next() {
        MenuItem menuItem = menuItems.get(position);
        position += 1;
        return menuItem;
    }


}

/**
 * 沙县菜单迭代器
 */
public class SXMenuIterator implements Iterator {

    MenuItem[] menuItems;

    int position = 0;

    /**
     * 通过构造函数实例化存储沙县信息的菜单数组
     *
     * @param menuItems
     */
    public SXMenuIterator(MenuItem[] menuItems){
        this.menuItems = menuItems;
    }

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

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

}

public class Waitress {

    BZMenu bzMenu;
    SXMenu sxMenu;

    public Waitress(BZMenu bzMenu, SXMenu sxMenu){
        this.bzMenu = bzMenu;
        this.sxMenu = sxMenu;
    }

    public void printMenu(){

        Iterator<MenuItem> iterator = bzMenu.createIterator();
        Iterator<MenuItem> iterator1 = sxMenu.createIterator();

        System.out.println("包子菜单为：");
        printMenu(iterator);
        System.out.println("沙县菜单为：");
        printMenu(iterator1);
    }

    private void printMenu(Iterator iterator){
        while (iterator.hasNext()){
            MenuItem menuItem = (MenuItem) iterator.next();
            System.out.print(menuItem.getName() + ": ");
            System.out.println(menuItem.getPrice());
        }
    }


}

public class Client {

    public static void main(String[] args) {

        BZMenu bzMenu = new BZMenu();
        SXMenu sxMenu = new SXMenu();
        Waitress waitress = new Waitress(bzMenu,sxMenu);

        waitress.printMenu();

    }

}

24种设计模式学习笔记之迭代器模式

猜你喜欢