生成器總覽

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

生成器提供了一種更容易的方法來實(shí)現(xiàn)簡單的對(duì)象迭代,相比較定義類實(shí)現(xiàn) Iterator 接口的方式,性能開銷和復(fù)雜性大大降低。

生成器允許你在 foreach 代碼塊中寫代碼來迭代一組數(shù)據(jù)而不需要在內(nèi)存中創(chuàng)建一個(gè)數(shù)組, 那會(huì)使你的內(nèi)存達(dá)到上限,或者會(huì)占據(jù)可觀的處理時(shí)間。相反,你可以寫一個(gè)生成器函數(shù),就像一個(gè)普通的自定義函數(shù)一樣, 和普通函數(shù)只返回一次不同的是, 生成器可以根據(jù)需要 yield 多次,以便生成需要迭代的值。

一個(gè)簡單的例子就是使用生成器來重新實(shí)現(xiàn) range() 函數(shù)。 標(biāo)準(zhǔn)的 range() 函數(shù)需要在內(nèi)存中生成一個(gè)數(shù)組包含每一個(gè)在它范圍內(nèi)的值,然后返回該數(shù)組, 結(jié)果就是會(huì)產(chǎn)生多個(gè)很大的數(shù)組。 比如,調(diào)用 range(0, 1000000) 將導(dǎo)致內(nèi)存占用超過 100 MB。

做為一種替代方法, 我們可以實(shí)現(xiàn)一個(gè) xrange() 生成器, 只需要足夠的內(nèi)存來創(chuàng)建 Iterator 對(duì)象并在內(nèi)部跟蹤生成器的當(dāng)前狀態(tài),這樣只需要不到1K字節(jié)的內(nèi)存。

示例 #1 將 range() 實(shí)現(xiàn)為生成器

<?php
function xrange($start$limit$step 1) {
    if (
$start <= $limit) {
        if (
$step <= 0) {
            throw new 
LogicException('Step must be positive');
        }

        for (
$i $start$i <= $limit$i += $step) {
            yield 
$i;
        }
    } else {
        if (
$step >= 0) {
            throw new 
LogicException('Step must be negative');
        }

        for (
$i $start$i >= $limit$i += $step) {
            yield 
$i;
        }
    }
}

/* 
 * 注意下面range()和xrange()輸出的結(jié)果是一樣的。
 */

echo 'Single digit odd numbers from range():  ';
foreach (
range(192) as $number) {
    echo 
"$number ";
}
echo 
"\n";

echo 
'Single digit odd numbers from xrange(): ';
foreach (
xrange(192) as $number) {
    echo 
"$number ";
}
?>

以上例程會(huì)輸出:

Single digit odd numbers from range():  1 3 5 7 9 
Single digit odd numbers from xrange(): 1 3 5 7 9 

Generator 對(duì)象

調(diào)用生成器函數(shù)時(shí)會(huì)返回一個(gè)內(nèi)部的 Generator 類的對(duì)象。 該對(duì)象實(shí)現(xiàn)了 Iterator 接口,基本上和僅向前的迭代器一樣, 它提供的方法可以操控生成器的狀態(tài),包括發(fā)送值、返回值。