×

PHP关键字之01 - yield

96
Nosee123
2018.05.29 00:33* 字数 663
Generator类

从PHP5.5开始,可以使用生成器来处理一个序列。生成器是一个函数,它不会调用return来返回一个值,而会调用yield(可能在一个循环中调用)。有了这样一个生成器,可以在原先使用数组的地方调用这个生成器函数,然后处理传递到yield关键字的值序列。

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

例一:使用生成器来生成一个平方数列表

function squares($start, $stop) {
    if ($start < $stop) {
        for($i = $start; $i <= $stop; $i++){
            yield $i => $i * $i;
        }
    } else {
        for($i = $stop; $i <= $start; $i++){
            yield $i => $i * $i;
        }
    }

}

var_dump(squares(1,5));

foreach(squares(1,5) as $k => $v){
    printf("%d squared is %d\n",$k,$v);
}

可以在foreach中使用传入yield的健和值,就像常规的数组元素一样。
运行结果如下:

object(Generator)#1 (0) {
}
1 squared is 1
2 squared is 4
3 squared is 9
4 squared is 16
5 squared is 25

例二:生成器来重新实现 range() 函数

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

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

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 "\n";

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

注意:

yield 的应用场景,一般多用于循环体,比如数据库的 fetch 操作,这样可以减少内存的消耗,ZanPHP 框架就大量的这样使用。

但切莫滥用 yield 操作,当数据量大的时候,yield可能会是一个高耗时的操作,会使程序性能大大降低。

参考:

官方文档:

相关书籍:

  • 《PHP经典实例》 David Sklar & Adam Trachtenberg

扩展阅读

在PHP中使用协程实现多任务调度:

听雨阁中听雨歌 - PHP的生成器、yield和协程
猫猫大侠 - PHP yield 分析,以及协程的实现,超详细版(上)
取个好名字真难的博客 - php利用yield写一个简单中间件

phper
Web note ad 1