PHP 高性能,低内存,大数据处理: 生成器yield

生成器是PHP 5.5.0才引入的功能，有些小伙伴可能不是很熟悉

一、官方释义：

生成器提供了一种更容易的方法来实现简单的对象迭代，相比较定义类实现 Iterator 接口的方式，性能开销和复杂性大大降低。

生成器允许你在 foreach 代码块中写代码来迭代一组数据而不需要在内存中创建一个数组, 那会使你的内存达到上限，或者会占据可观的处理时间。相反，你可以写一个生成器函数，就像一个普通的自定义函数一样, 和普通函数只返回一次不同的是, 生成器可以根据需要 yield 多次，以便生成需要迭代的值

二、官方示例：

一个简单的例子就是使用生成器来重新实现 range() 函数。 标准的 range() 函数需要在内存中生成一个数组包含每一个在它范围内的值，然后返回该数组, 结果就是会产生多个很大的数组。 比如，调用 range(0, 1000000) 将导致内存占用超过 100 MB。

做为一种替代方法, 我们可以实现一个 xrange() 生成器, 只需要足够的内存来创建 Iterator 对象并在内部跟踪生成器的当前状态，这样只需要不到1K字节的内存。

ps: range() 函数创建一个包含指定范围的元素的数组。

该函数返回一个包含从 low 到 high 之间的元素的数组。

注释：如果 low 参数大于 high 参数，则创建的数组将是从 high 到 low。

Example #1 将 range() 实现为生成器(下面的代码是把 PHP 官方文档中精简了一下)

<?php
function xrange($start, $limit, $step = 1) {
    if ($start < $limit) {
        for ($i = $start; $i <= $limit; $i += $step) {
            yield $i;
        }
    } else {
        for ($i = $start; $i >= $limit; $i += $step) {
            yield $i;
        }
    }
}

/* 
 * 注意下面range()和xrange()输出的结果是一样的。
 */

echo 'Single digit odd numbers from range():  ';
foreach (range(1, 9, 2) as $number) {
    echo "$number ";
}
//输出$number结果为： Single digit odd numbers from range():  1 3 5 7 9 
echo "\n"; 


echo 'Single digit odd numbers from xrange(): ';
foreach (xrange(1, 9, 2) as $number) {
    echo "$number ";
}
//输出$number结果为： Single digit odd numbers from xrange(): 1 3 5 7 9 
?>

这里 xrange 并不需要分配大块内存来存放变量，大大节约了内存，提升效率。

三、官方语法

生成器函数的核心是yield关键字。它最简单的调用形式看起来像一个return申明，不同之处在于普通return会返回值并终止函数的执行，而yield会返回一个值给循环调用此生成器的代码并且只是暂停执行生成器函数。

四、解释说明：
举个简单的例子：

<?php
function createArr($num){
    $data = [];
    for($i=0;$i<$num;$i++){
        $data[] = $i;
    }
    return $data;
}

$result = createArr(10); 
foreach($result as $value){
    echo $value.'<br />';
}
?>

上面这段代码相信大家都能看的懂，简单来说就是使用for循环创建一个长度可变的数组，其中给createArr函数的传值是10，大家考虑一下如果我们给createArr函数的100参数值是1000000(一百万)，会发生什么？

首先for循环了一百万次，生成了一个长度为一百万的data数组，而data数组是放在内存中的，所以在执行的时候会占用大量内存。

将上面代码使用生成器实现：

function createArr($num){
    for($i=0;$i<$num;$i++){
        yield $i;
    }
}

$result = createArr(10);
foreach($result as $value){
    echo $value.'<br />';
}

划重点：
当一个生成器被调用的时候，它返回一个可以被遍历的对象.当你遍历这个对象的时候(例如通过一个foreach循环)，PHP 将会在每次需要值的时候调用生成器函数，并在产生一个值之后保存生成器的状态，这样它就可以在需要产生下一个值的时候恢复调用状态。
一旦不再需要产生更多的值，生成器函数可以简单退出，而调用生成器的代码还可以继续执行，就像一个数组已经被遍历完了

所以生成器不是返回值，而是产生一个值！所以，整个代码执行中，始终只有一个记录值参与循环，内存中也只有一条信息。大大的减小了内存的使用