PHP设计模式之迭代器模式的使用

迭代器模式是什么？

迭代器模式是一种行为型设计模式，它允许你在不暴露对象内部结构的情况下遍历其中的元素。通过该模式，你可以在使用不同集合（例如树形和线性）的对象时使用相同的代码。

迭代器模式的使用：

实现迭代器模式的第一步是要创建一个迭代器接口，它至少应该具有访问元素和返回下一个元素的方法。该接口可以根据特定需要进行扩展。在 PHP 中，我们可以使用 SPL 的迭代器接口 Iterator 和 IteratorAggregate 进行实现。

下面是一个实现了 SPL 迭代器接口 Iterator 和 IteratorAggregate 的示例代码：

<?php

class BookList implements IteratorAggregate
{
    private $books = [];

    public function getIterator()
    {
        return new BookListIterator($this);
    }

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

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

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

class BookListIterator implements Iterator
{
    private $bookList;
    private $currentBook = 0;

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

    public function rewind()
    {
        $this->currentBook = 0;
    }

    public function key()
    {
        return $this->currentBook;
    }

    public function current()
    {
        return $this->bookList->getBook($this->currentBook);
    }

    public function next()
    {
        $this->currentBook++;
    }

    public function valid()
    {
        return $this->bookList->getBook($this->currentBook) !== null;
    }
}

$bookList = new BookList();
$bookList->addBook('Design Patterns: Elements of Reusable Object-Oriented Software');
$bookList->addBook('Head First Design Patterns');
$bookList->addBook('Clean Code');
$bookList->addBook('Refactoring: Improving the Design of Existing Code');

foreach ($bookList as $book) {
    echo $book . PHP_EOL;
}

以上代码实现了一个书目列表的迭代器，可以通过添加书目加入书目列表。在 getIterator() 方法中，我们返回 BookListIterator 类型的对象，该类实现了 SPL 迭代器接口 Iterator。BookListIterator 类的 rewind()、key()、current()、next() 和 valid() 方法分别是迭代器的标准方法。

迭代器模式的实际应用：

迭代器模式适用于需要遍历一个对象的内部结构，并希望以相同的方式遍历该对象的不同实例。下面是一个使用迭代器模式的例子：

<?php

class DataStorage implements IteratorAggregate
{
    private $data = [];

    public function __construct($data)
    {
        $this->data = $data;
    }

    public function getIterator()
    {
        return new ArrayIterator($this->data);
    }
}

$data = new DataStorage([1, 2, 3, 4, 5]);

foreach ($data as $value) {
    echo $value . PHP_EOL;
}

在上述代码中，我们使用了 SPL 的 ArrayIterator 类作为迭代器。首先，我们创建了一个 DataStorage 类，该类包含了一个数组。接下来，在 getIterator() 方法中，我们返回一个 ArrayIterator 类型的对象，它将迭代数组中的元素。最后，我们遍历了 $data。由于 DataStorage 实现了 SPL 迭代器接口 IteratorAggregate，所以我们可以使用 foreach 循环遍历其内部的 $data 数组。