1. 程式人生 > >PHP中的生成器(yield)使用

PHP中的生成器(yield)使用

在講解生成器之前先介紹一下迭代器:

在 PHP 中,通常情況下遍歷陣列使用 foreach 來遍歷。

如果我們要想讓一個物件可以遍歷呢?

PHP 為我們提供了 Iterator 介面,只要實現了這個介面,這個物件就可以通過 foreach 來迭代。

例子如下:

class myIterator implements Iterator {
    private $index = 0;
    private $data = '';

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

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

    function current() {
        return $this->data[$this->index];
    }

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

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

    function valid() {
        return isset($this->data[$this->index]);
    }
}

$it = new myIterator(array(
    "hello",
    "php",
    "iterator",
));
foreach($it as $key => $value) {
    echo "$key : $value<br>";
}

我們通過foreach遍歷 $it 時,PHP 會自己依次呼叫:

  1. rewind() 重置到第一個元素
  2. valid() 檢查當前位置是否有效
  3. current() 返回當前元素
  4. key() 返回當前元素的鍵
  5. next() 指向下一個元素

生成器是 PHP 5.5 引入的新特性,但是目前貌似很少人用到它。

下面是 PHP 官方文件上對生成器的解釋:

生成器提供了一種更容易的方法來實現簡單的物件迭代,相比較定義類實現 Iterator 介面的方式,效能開銷和複雜性大大降低。

生成器允許你在 foreach 程式碼塊中寫程式碼來迭代一組資料而不需要在記憶體中建立一個數組

,那會使你的記憶體達到上限,或者會佔據可觀的處理時間。相反,你可以寫一個生成器函式,就像一個普通的自定義函式一樣, 和普通函式只返回一次不同的是, 生成器可以根據需要 yield 多次,以便生成需要迭代的值。

為了體現生成器的優點,下面我們定義一個函式來進行比較:

function func1()
{
    foreach (range(0, 1000000) as $value){
        echo $value;
    }
}

func1();
// ( ! ) Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 402653192 bytes) in xxx.php on line 5

因為建立如此大的陣列到記憶體中進行迭代,則 PHP 直接提示超出了單個程序的記憶體限制

下面我們換做生成器的方式來處理:

function func1()
{
    foreach (range(0, 1000000) as $value){
        yield $value;
    }
}

var_dump(func1()); // object(Generator)[1]
foreach (func1() as $value){
    echo $value;
}

可以看到我們呼叫 func1() 返回了一個 Generator 物件,這個物件可以使用 foreach 迭代,每次迭代,PHP 會要求 Generator 例項計算並提供下一個要迭代的值。生成器的優雅體現在每次產出一個值之後,生成器的內部狀態都會停頓;向生成器請求下一個值時,內部狀態又會恢復。生成器內部的狀態會一直在停頓和恢復之間切換,直到抵達函式定義體的末尾或遇到空的 return 語句為止。

參考連結: