PHP設(shè)計(jì)模式之迭代器模式

陸斌發(fā)布于2019-06-27 14:52 / 1101人閱讀

摘要：概念迭代器模式，又叫做游標(biāo)模式。另外，當(dāng)需要對(duì)聚集有多種方式遍歷時(shí)，可以考慮去使用迭代器模式。迭代器模式為遍歷不同的聚集結(jié)構(gòu)提供如開始下一個(gè)是否結(jié)束當(dāng)前哪一項(xiàng)等統(tǒng)一的接口。

概念

迭代器模式（Iterator），又叫做游標(biāo)（Cursor）模式。提供一種方法順序訪問一個(gè)聚合對(duì)象中的各種元素，而又不暴露該對(duì)象的內(nèi)部表示。

當(dāng)你需要訪問一個(gè)聚合對(duì)象，而且不管這些對(duì)象是什么都需要遍歷的時(shí)候，就應(yīng)該考慮使用迭代器模式。另外，當(dāng)需要對(duì)聚集有多種方式遍歷時(shí)，可以考慮去使用迭代器模式。迭代器模式為遍歷不同的聚集結(jié)構(gòu)提供如開始、下一個(gè)、是否結(jié)束、當(dāng)前哪一項(xiàng)等統(tǒng)一的接口。

適用場(chǎng)景

訪問一個(gè)聚合對(duì)象的內(nèi)容而無需暴露它的內(nèi)部表示

支持對(duì)聚合對(duì)象的多種遍歷

為遍歷不同的聚合結(jié)構(gòu)提供一個(gè)統(tǒng)一的接口

UML圖

角色

Iterator（迭代器）：迭代器定義訪問和遍歷元素的接口

ConcreteIterator（具體迭代器）：具體迭代器實(shí)現(xiàn)迭代器接口，對(duì)該聚合遍歷時(shí)跟蹤當(dāng)前位置

Aggregate （聚合）：聚合定義創(chuàng)建相應(yīng)迭代器對(duì)象的接口

ConcreteAggregate （具體聚合）：具體聚合實(shí)現(xiàn)創(chuàng)建相應(yīng)迭代器的接口，該操作返回ConcreteIterator的一個(gè)適當(dāng)?shù)膶?shí)例

代碼

代碼如下:

PHP SPL中已經(jīng)提供了迭代器接口Iterator和容器接口IteatorAggragate，其源碼如下：

/**
 * Interface to detect if a class is traversable using &foreach;.
 * @link http://php.net/manual/en/class.traversable.php
 */
interface Traversable {
}

/**
 * Interface to create an external Iterator.
 * @link http://php.net/manual/en/class.iteratoraggregate.php
 */
interface IteratorAggregate extends Traversable {

    /**
     * Retrieve an external iterator
     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
     * @return Traversable An instance of an object implementing Iterator or
     * Traversable
     * @since 5.0.0
     */
    public function getIterator();
}

/**
 * Interface for external iterators or objects that can be iterated
 * themselves internally.
 * @link http://php.net/manual/en/class.iterator.php
 */
interface Iterator extends Traversable {

    /**
     * Return the current element
     * @link http://php.net/manual/en/iterator.current.php
     * @return mixed Can return any type.
     * @since 5.0.0
     */
    public function current();

    /**
     * Move forward to next element
     * @link http://php.net/manual/en/iterator.next.php
     * @return void Any returned value is ignored.
     * @since 5.0.0
     */
    public function next();

    /**
     * Return the key of the current element
     * @link http://php.net/manual/en/iterator.key.php
     * @return mixed scalar on success, or null on failure.
     * @since 5.0.0
     */
    public function key();

    /**
     * Checks if current position is valid
     * @link http://php.net/manual/en/iterator.valid.php
     * @return boolean The return value will be casted to boolean and then evaluated.
     * Returns true on success or false on failure.
     * @since 5.0.0
     */
    public function valid();

    /**
     * Rewind the Iterator to the first element
     * @link http://php.net/manual/en/iterator.rewind.php
     * @return void Any returned value is ignored.
     * @since 5.0.0
     */
    public function rewind();
}

這里我們直接實(shí)現(xiàn)上面兩個(gè)接口，請(qǐng)看下面代碼：

array = $array;
        $this->position = 0;
    }

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

    function current() {
        return $this->array[$this->position];
    }

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

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

    function valid() {
        return isset($this->array[$this->position]);
    }
}

/**
 * Class MyAggregate 聚合容器
 */
class ConcreteAggregate implements IteratorAggregate
{
    public $property;

    /**
     * 添加屬性
     *
     * @param $property
     */
    public function addProperty($property)
    {
        $this->property[] = $property;
    }

    public function getIterator()
    {
        return new ConcreteIterator($this->property);
    }
}

/**
 * Class Client 客戶端測(cè)試
 */
class Client
{
    public static function test()
    {
        //創(chuàng)建一個(gè)容器
        $concreteAggregate = new ConcreteAggregate();
        // 添加屬性
        $concreteAggregate->addProperty("屬性1");
        // 添加屬性
        $concreteAggregate->addProperty("屬性2");
        //給容器創(chuàng)建迭代器
        $iterator = $concreteAggregate->getIterator();
        //遍歷
        while($iterator->valid())
        {
            $key   = $iterator->key();
            $value = $iterator->current();
            echo "鍵: ".$key." 值: ".$value."";
            $iterator->next();
        }

    }
}

Client:: test();

運(yùn)行結(jié)果：