【生成器】PHP的生成器yield【原创】

在PHP 5.5中，PHP多了一个新的特性，那就是生成器（Generator）。生成器提供了一种更简单的方法来实现简单的对象迭代。

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

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

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

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

下面的代码可以将range实现为生成器：
1
<?php
2
/**
3
 * Created by PhpStorm.
4
 * User: Administrator
5
 * Date: 2017/7/10
6
 * Time: 11:55
7
 */
8
​
9
/**
10
 * @param $start
11
 * @param $limit
12
 * @param int $step
13
 * @return Generator
14
 */
15
function xrange($start, $limit, $step = 1)
16
{
17
    if ($start < $limit) {
18
        if ($step <= 0) {
19
            throw new LogicException('Step must be +ve');
20
        }
21
​
22
        for ($i = $start; $i <= $limit; $i += $step) {
23
            yield $i;
24
        }
25
    } else {
26
        if ($step >= 0) {
27
            throw new LogicException('Step must be -ve');
28
        }
29
​
30
        for ($i = $start; $i >= $limit; $i += $step) {
31
            yield $i;
32
        }
33
    }
34
}
35
​
36
/**
37
 * @param $start
38
 * @param $limit
39
 * @param int $step
40
 * @return array
41
 */
42
function yrange($start, $limit, $step = 1)
43
{
44
    $res = [];
45
    if ($start < $limit) {
46
        if ($step <= 0) {
47
            throw new LogicException('Step must be +ve');
48
        }
49
​
50
        for ($i = $start; $i <= $limit; $i += $step) {
51
            $res[] = $i;
52
        }
53
    } else {
54
        if ($step >= 0) {
55
            throw new LogicException('Step must be -ve');
56
        }
57
​
58
        for ($i = $start; $i >= $limit; $i += $step) {
59
            $res[] = $i;
60
        }
61
    }
62
    return $res;
63
}
64
​
65
echo 'Single digit odd numbers from range():  ';
66
foreach (range(1, 9, 2) as $number) {
67
    echo "$number ";
68
}
69
echo "\n";
70
​
71
var_dump(xrange(1, 9, 2));
72
echo 'Single digit odd numbers from xrange(): ';
73
foreach (xrange(1, 9, 2) as $number) {
74
    echo "$number ";
75
}
76
echo "\n";
77
​
78
echo 'Single digit odd numbers from yrange(): ';
79
foreach (yrange(1, 9, 2) as $number) {
80
    echo "$number ";
81
}
运行：
Single digit odd numbers from range():  1 3 5 7 9
C:\laragon\www\php_book\test_yield.php:71:
class Generator#1 (0) {
}
Single digit odd numbers from xrange(): 1 3 5 7 9
Single digit odd numbers from yrange(): 1 3 5 7 9

其中的yrange其实也是实现了range的功能，写上去只是为了和xrange对比而已。而var_dump出来只是提示是个Generator类而已，并没有把值打印出来，猜想应该是只有用foreach进行遍历的时候才会去打印。

一个生成器函数看起来像一个普通的函数，不同的是普通函数返回一个值，而一个生成器可以yield生成许多它所需要的值。

当一个生成器被调用的时候，它返回一个可以被遍历的对象.当你遍历这个对象的时候(例如通过一个foreach循环)，PHP 将会在每次需要值的时候调用生成器函数，并在产生一个值之后保存生成器的状态，这样它就可以在需要产生下一个值的时候恢复调用状态。

一旦不再需要产生更多的值，生成器函数可以简单退出，而调用生成器的代码还可以继续执行，就像一个数组已经被遍历完了。

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

以下是一个简单的生成值的例子：
1
<?php
2
function gen_one_to_three() {
3
    for ($i = 1; $i <= 3; $i++) {
4
        //注意变量$i的值在不同的yield之间是保持传递的。
5
        yield $i;
6
    }
7
}
8
​
9
$generator = gen_one_to_three();
10
foreach ($generator as $value) {
11
    echo "$value\n";
12
}
输出：
1
2
3


再来看一个例子：
1
<?php
2
​
3
function generator() {
4
    yield from range(1, 3);
5
​
6
    foreach (range(4, 6) as $i) {
7
        yield $i;
8
    }
9
};
10
​
11
foreach (generator() as $value) {
12
    echo $value . "\r\n";
13
}
14
​
运行：
1
2
3
4
5
6


posted @ 2017-07-14 21:48  Newman·Li  阅读(145)  评论(0)  编辑  收藏  举报