迭代器模式 Iterator

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

角色

  1. 迭代器角色(Iterator):
    1. 定义遍历元素所需要的方法,一般来说会有这么三个方法:取得下一个元素的方法next(),判断是否遍历结束的方法hasNext()),移出当前对象的方法remove(),
    2. php默认的spl标准库中自带这个接口,有5个方法(参考实例代码)
  2. 具体迭代器角色(Concrete Iterator):实现迭代器接口中定义的方法,完成集合的迭代。
  3. 容器角色(Aggregate): 一般是一个接口,提供一个iterator()方法,例如java中的Collection接口,List接口,Set接口等
  4. 具体容器角色(ConcreteAggregate):就是抽象容器的具体实现类,比如List接口的有序列表实现ArrayList,List接口的链表实现LinkList,Set接口的哈希列表的实现HashSet等。

实例

分析:
Book 具体容器中存放的角色
BookList 容器
BookListIterator 具体迭代器
BookListReverseIterator 具体迭代器 反向的(实际中使用中,只需要遍历的操作,很少会用)

uml图

代码实例:

//Book
namespace MyAppIterator;
class Book
{
    protected $id;

    protected $title;

    public function __construct ($id, $title)
    {
        $this->id = $id;
        $this->title = $title;
    }

    /**
     * @return mixed
     */
    public function getId ()
    {
        return $this->id;
    }

    /**
     * @param mixed $id
     */
    public function setId ($id)
    {
        $this->id = $id;
    }

    /**
     * @return mixed
     */
    public function getTitle ()
    {
        return $this->title;
    }

    /**
     * @param mixed $title
     */
    public function setTitle ($title)
    {
        $this->title = $title;
    }
}


//BookList
namespace MyAppIterator;


//容器:存储书
class BookList
{
    protected $books = [];

    public function getBook ($id)
    {
        if (isset($this->books[$id])) return $this->books[$id];
        return null;
    }

    public function addBook (Book $book)
    {
        $this->books[] = $book;
    }

    public function remove ($id)
    {
        foreach ($this->books as $key => $book) {
            if ($id == $key) unset($this->books[$key]);
        }
    }

    public function count ()
    {
        return count($this->books);
    }
}

//BookListIterator
namespace MyAppIterator;

//spl 标准类库 Iterator 自带5个方法
//当然如果对于简单的数据结构比如数组,我们宁愿使用for也不会使用迭代器的
class BookListIterator implements Iterator
{
    protected $books;
    protected $currentBook = 0;

    public function __construct (BookList $bookList)
    {
        $this->books = $bookList;
    }

    //Return the current element 返回当前元素
    public function current ()
    {
        return $this->books->getBook($this->currentBook);
    }

    //Move forward to next element 移动下标到下一个元素
    public function next ()
    {
        $this->currentBook++;
    }

    //Return the key of the current element 返回当前元素的key
    public function key ()
    {
        return $this->currentBook;
    }

    //Checks if current position is valid 检查当前元素是否有效
    public function valid ()
    {
        return null !== $this->books->getBook($this->currentBook);
    }

    // Rewind the Iterator to the first element 回到第一个元素
    public function rewind ()
    {
        $this->currentBook = 0;
    }
}

测试:

代码优化(遍历与实现分开)

BookList类添加一个方法
 public function iterator ()
    {
        return new  BookListIterator($this);
    }

测试:

迭代器模式的优缺点:

迭代器模式的优点有:

  1. 简化了遍历方式,对于对象集合的遍历,还是比较麻烦的,对于数组或者有序列表,我们尚可以通过游标来取得,但用户需要在对集合了解很清楚的前提下,自行遍历对象,但是对于hash表来说,用户遍历起来就比较麻烦了。而引入了迭代器方法后,用户用起来就简单的多了。
  2. 可以提供多种遍历方式,比如说对有序列表,我们可以根据需要提供正序遍历,倒序遍历两种迭代器,用户用起来只需要得到我们实现好的迭代器,就可以方便的对集合进行遍历了。
  3. 封装性良好,用户只需要得到迭代器就可以遍历,而对于遍历算法则不用去关心。

迭代器模式的缺点:
对于比较简单的遍历(像数组或者有序列表),使用迭代器方式遍历较为繁琐,大家可能都有感觉,像ArrayList,我们宁可愿意使用for循环和get方法来遍历集合。(是因为我们熟悉他们的内部结构)

在java中迭代器模式是与集合共生共死的,一般来说,我们只要实现一个集合,就需要同时提供这个集合的迭代器,就像java中的Collection,List、Set、Map等,这些集合都有自己的迭代器。假如我们要实现一个这样的新的容器,当然也需要引入迭代器模式,给我们的容器实现一个迭代器。

参考文档
Java设计模式系列之迭代器模式