帶你去理解PHP中的Generator-php教程-PHP中文網

帶你去理解PHP中的Generator

藏色散人

發布： 2023-04-09 16:42:02

轉載

3693 人瀏覽過

何為Generator

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

xrange

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

foreach (range(1, 100, 2) as $num) {
    echo $num . PHP_EOL;
}

登入後複製

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

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

function xrange($start, $limit, $step = 1) {
    while ($start <= $limit) {
        yield $start;
        $start += $step;
    }
}

foreach (xrange(1, 100, 2) as $num) {
    echo $num . PHP_EOL;
}

登入後複製

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

我們剛剛說了，前面的程式碼，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 . PHP_EOL;
}

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

登入後複製

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

function xrange($start, $limit, $step = 1) {
    while ($start <= $limit) {
        $ret = yield $start;
        $start += $step;
        echo $ret . PHP_EOL;
    }
}

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

登入後複製

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