1.简介

大部分的phper或许都不是很了解生成器这个功能,可能是php引用较晚都或者不常用到这一功能。但是生成器的功能和作用却非常有用。以下是官方的介绍


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

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

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

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

<?php

function xrange($start, $limit, $step = 1) {
    if ($start < $limit) {
        if ($step <= 0) {
            throw new LogicException('Step must be +ve');
        }

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

        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 ";
}
echo PHP_EOL;

echo 'Single digit odd numbers from xrange(): ';
foreach (xrange(1, 9, 2) as $number) {
    echo "$number ";
}

?>

以上会输出:

range()的一位数字奇数:1 3 5 7 9 
xrange()中的一位数字奇数:1 3 5 7 9

2.优点

总的来说大致分为以下几个优点:

  1. 生成器能有效节省服务器内存,从而会大幅提升PHP的性能;

  2. 适合数据量大的处理运算;



3.几种写法

  1. 返回键值对

function test()
{
    for ($i = 1000000; $i--;) {
        yield $i => $i * time();
    }
}

foreach (test() as $key => $value) {
    echo "{$key} => {$value}" . PHP_EOL;
}

  2. 传参到生成器中

function test(int $stop_key)
{
    for ($i = 1000000; $i--;) {
        yield $i => $i * time();
        if ($stop_key == $i) return;   //生成器中使用 return 跳出生成器
    }
}

foreach (test(999999) as $key => $value) {
    echo "{$key} => {$value}" . PHP_EOL;
}


4.使用场景

对于处理析庞大的数据集、日志文件、数据库结果集等情况。特别还是需要在线上环境中执行的。为保证能服务器运行稳定,我们肯定不会愿意把那些大量的数据集全部放在内存中去处理,生成器就是为这种情况而生。通常我们也是希望用较小的内存来尽可能快的处理数据。


5.性能分析

那么写一个简单的列子测试下:

<?php

$start_time = microtime(true);
$array = [];

$str = "";
for ($i = 1000000; $i--;) {
    $array[] = $i * time();
}
foreach ($array as $val) {
    echo $val . PHP_EOL;
}
$end_time = microtime(true);

echo "time: ", bcsub($end_time, $start_time, 4), "\n";
echo "memory: ", memory_get_peak_usage(true), "\n";

//打印时间和内存为:
//time: 2.3575
//memory (byte): 37748736

打印的结果为:

微信图片_20200308102141.png

此处写了一个倒序循环并加以简单运算的脚本。同样,我们使用生成器写一个类似脚本的:

<?php
$start_time = microtime(true);
$array = [];
$str = "";
function test()
{
    for ($i = 1000000; $i--;) {
        yield $i * time();

    }

}

foreach (test() as $val) {
    echo $val . PHP_EOL;
}
$end_time = microtime(true);

echo "time: ", bcsub($end_time, $start_time, 4), "\n";
echo "memory: ", memory_get_peak_usage(true), "\n";

打印结果为:

QQ截图20200308102233.png


我们通过对于运行的时间和消耗内存做出对比可得出明显的结论,由于不是并行执行,只在主逻辑与生成器之前运行,所以对于执行时间没有明显减少,但对于内存的优化极为可观