淺析 PHP 中的 Generator

　　Miss Wang php開發案例 前天

　　何為 Generator

　　從 PHP 5.5 開始，PHP 加入了一個新的特性，那就是 Generator，中文譯為生成器。生成器可以簡單地用來實現物件的迭代，讓我們先從官方的一個小例子說起。

　　xrange

　　在 PHP 中，我們都知道，有一個函式叫做 range，用來生成一個等差數列的陣列，然後我們可以用這個陣列進行 foreach 的迭代。具體就想這樣。

　　foreach (range(1, 100, 2) as $num) { echo "{$num}\n";

　　}

　　這一段程式碼就會輸出首項為 1，末項為 100，公差為 2 的等差數列。它的執行順序是這樣的。首先，range(1, 100, 2) 會生成一個數組，裡面存了上面那樣的一個等差數列，之後在 foreach 中對這個陣列進行迭代。

　　那麼，這樣就會出現一個問題，如果我要生成 100 萬個數字呢？那我們就要佔用上百兆記憶體。雖然現在記憶體很便宜，但是我們也不能這麼浪費記憶體嘛。那麼這時，我們的生成器就可以排上用場了。考慮下面的程式碼。

　　function xrange($start, $limit, $step = 1) { yield $start;

　　$start++;

　　}foreach (xrange(1, 100, 2) as $num) { echo "{$num}\n";

　　}

　　這段程式碼所的出來的結果，和前面的那段程式碼一模一樣，但是，它內部的原理是天翻地覆了。

　　我們剛才說了，前面的程式碼，range 會生成一個數組，然後 foreach 來迭代這個陣列，從而取出某一個值。但是這段程式碼呢，我們重新定義了一個 xrange 函式，在函式中，我們用了一個關鍵字 yield。我們都知道定義一個函式，希望它返回一個值得時候，用 return 來返回。那麼這個 yield 呢，也可以返回一個值，但是，它和 return 是截然不同的。

　　使用 yield 關鍵字，可以讓函式在執行的時候，中斷，同時會儲存整個函式的上下文，返回一個 Generator 型別的物件。在執行物件的 next 方法時，會重新載入中斷時的上下文，繼續執行，直到出現下一個 yield 為止，如果後面沒有再出現 yield，那麼就認為整個生成器結束了。

　　這樣，我們上面的函式呼叫可以等價地寫成這樣。

　　$nums = xrange(1, 100, 2);while ($nums->valid()) { echo $nums->current() . "\n";

　　$nums->next();

　　}

　　在這裡，$num 是一個 Generator 的物件。我們在這裡看到三個方法，valid、current 和 next。當我們函式執行完了，後面沒有 yield 中斷了，那麼我們在 xrange 函式就執行完了，那麼 valid 方法就會變成 false。而 current 呢，會返回當前 yield 後面的值，這是，生成器的函式會中斷。那麼在呼叫 next 方法之後，函式會繼續執行，直到下一個 yield 出現，或者函式結束。

　　好了，到這裡，我們看到了通過 yield 來“生成”一個值並返回。其實，yield 其實也可以這麼寫 $ret = yield;。同返回值一樣，這裡是將一個值在繼續執行函式的時候，傳值進函式，可以通過 Generator::send($value) 來使用。例如。

　　function sum(){

　　$ret = yield; echo "{$ret}\n";

　　}

　　$sum = sum();

　　$sum->send('I am from outside.');

　　這樣，程式就會打印出 send 方法傳進去的字串了。在 yield 的兩邊可以同時有呼叫。

　　function xrange($start, $limit, $step = 1) {

　　$ret = yield $start;

　　$start++; echo "{$ret}\n";

　　}

　　而像這樣的使用，send() 可以返回下一個 yield 的返回。

　　其它的 Generator 方法

　　Generator::key()

　　對於 yield，我們可以這樣使用 yield $id => $value，這是，我們可以通過 key 方法來獲取 $id，而 current 方法返回的是 $value。

　　Generator::rewind()

　　這個方法，可以幫我們讓生成器重新開始執行並儲存上下文，同時呢，會返回第一個 yield 返回的內容。在第一次執行 send 方法的時候，rewind 會被隱式呼叫。

　　Generator::throw()

　　這個方法，向生成器中，拋送一個異常。

　　後記

　　yield 作為 PHP 5.5 的新特性，讓我們用了新的方法來高效地迭代資料。同時，我們還可以使用 yield 來實現協程。