我最近无意中发现了这段代码:

function xrange($min, $max) 
{
    for ($i = $min; $i <= $max; $i++) {
        yield $i;
    }
}

我以前从未见过这个yield关键字。试着运行我得到的代码

解析错误:语法错误,意外的T_VARIABLE在x行

那么yield关键字是什么呢?它是有效的PHP吗?如果是,我该怎么用呢?


当前回答

一个值得在此讨论的有趣方面是参照让步。每次我们需要改变一个形参以使其反映在函数外部时,我们必须通过引用传递这个形参。要将此应用于生成器,只需在生成器的名称和迭代中使用的变量前加上&:

 <?php 
 /**
 * Yields by reference.
 * @param int $from
 */
function &counter($from) {
    while ($from > 0) {
        yield $from;
    }
}

foreach (counter(100) as &$value) {
    $value--;
    echo $value . '...';
}

// Output: 99...98...97...96...95...

上面的例子展示了在foreach循环中改变迭代值如何改变生成器中的$from变量。这是因为由于生成器名称前有&号,$from是通过引用产生的。正因为如此,foreach循环中的$value变量是生成器函数中$from变量的引用。

其他回答

简单的例子

<?php
echo '#start main# ';
function a(){
    echo '{start[';
    for($i=1; $i<=9; $i++)
        yield $i;
    echo ']end} ';
}
foreach(a() as $v)
    echo $v.',';
echo '#end main#';
?>

输出

#start main# {start[1,2,3,4,5,6,7,8,9,]end} #end main#

先进的例子

<?php
echo '#start main# ';
function a(){
    echo '{start[';
    for($i=1; $i<=9; $i++)
        yield $i;
    echo ']end} ';
}
foreach(a() as $k => $v){
    if($k === 5)
        break;
    echo $k.'=>'.$v.',';
}
echo '#end main#';
?>

输出

#start main# {start[0=>1,1=>2,2=>3,3=>4,4=>5,#end main#

下面的代码说明了如何使用生成器在完成之前返回一个结果,而不像传统的非生成器方法在完整迭代之后返回一个完整的数组。使用下面的生成器,值在准备就绪时返回,不需要等待数组被完全填充:

<?php 

function sleepiterate($length) {
    for ($i=0; $i < $length; $i++) {
        sleep(2);
        yield $i;
    }
}

foreach (sleepiterate(5) as $i) {
    echo $i, PHP_EOL;
}

没有一个答案给出了使用由非数字成员填充的大型数组的具体示例。下面是一个例子,在一个大的.txt文件(在我的用例中是262MB)上使用由explosion()生成的数组:

<?php

ini_set('memory_limit','1000M');

echo "Starting memory usage: " . memory_get_usage() . "<br>";

$path = './file.txt';
$content = file_get_contents($path);

foreach(explode("\n", $content) as $ex) {
    $ex = trim($ex);
}

echo "Final memory usage: " . memory_get_usage();

输出结果是:

Starting memory usage: 415160
Final memory usage: 270948256

现在将其与类似的脚本进行比较,使用yield关键字:

<?php

ini_set('memory_limit','1000M');

echo "Starting memory usage: " . memory_get_usage() . "<br>";

function x() {
    $path = './file.txt';
    $content = file_get_contents($path);
    foreach(explode("\n", $content) as $x) {
        yield $x;
    }
}

foreach(x() as $ex) {
    $ex = trim($ex);
}

echo "Final memory usage: " . memory_get_usage();

这个脚本的输出是:

Starting memory usage: 415152
Final memory usage: 415616

显然,内存使用节省相当大(ΔMemoryUsage -----> ~270.5 MB在第一个示例中,~450B在第二个示例中)。

这个函数使用yield:

function a($items) {
    foreach ($items as $item) {
        yield $item + 1;
    }
}

它和这个几乎一样,没有:

function b($items) {
    $result = [];
    foreach ($items as $item) {
        $result[] = $item + 1;
    }
    return $result;
}

唯一的区别是a()返回一个生成器,而b()只是一个简单的数组。你可以在两者上进行迭代。

另外,第一个不分配完整的数组,因此内存需求更少。

一个值得在此讨论的有趣方面是参照让步。每次我们需要改变一个形参以使其反映在函数外部时,我们必须通过引用传递这个形参。要将此应用于生成器,只需在生成器的名称和迭代中使用的变量前加上&:

 <?php 
 /**
 * Yields by reference.
 * @param int $from
 */
function &counter($from) {
    while ($from > 0) {
        yield $from;
    }
}

foreach (counter(100) as &$value) {
    $value--;
    echo $value . '...';
}

// Output: 99...98...97...96...95...

上面的例子展示了在foreach循环中改变迭代值如何改变生成器中的$from变量。这是因为由于生成器名称前有&号,$from是通过引用产生的。正因为如此,foreach循环中的$value变量是生成器函数中$from变量的引用。