生成器（php5.5+） · PHP学习

# 生成器（php5.5+） **优点：** - 生成器会对PHP应用的性能有非常大的影响 - PHP代码运行时节省大量的内存 - 比较适合计算大量的数据那么，这些神奇的功能究竟是如何做到的？我们先来举个例子。 ## **概念引入** 首先，放下生成器概念的包袱，来看一个简单的PHP函数： ``` <pre class="calibre10">``` function createRange($number){ $data = []; for($i=0;$i<$number;$i++){ $data[] = time(); } return $data; } //函数的作用是执行 `for`循环，把遍历保存的$data 返回出去。 //把这个函数的返回值循环打印出来： $result = createRange(10); // 这里调用上面我们创建的函数 foreach($result as $value){ sleep(1);//这里停顿1秒，我们后续有用 echo $value.' '; } ``` ``` 我们在浏览器里面看一下运行结果： ![](https://img.kancloud.cn/c7/a7/c7a72c032135488a595b6425b391e70b_349x329.png) 这里非常完美，没有任何问题。（当然 sleep(1) 效果你们看不出来） ## **思考一个问题** 我们注意到，在调用函数 createRange 的时候给 $number 的传值是10，一个很小的数字。假设，现在传递一个值`10000000`（1000万）。那么，在函数 createRange 里面，`for`循环就需要执行`1000`万次。且有`1000`万个值被放到 $data 里面，而`$data`数组在是被放在内存内。所以，在调用函数时候会**占用大量内存**。 ## **创建生成器** 这里，生成器就可以大显身手了，解决**占用大量内存**的问题。 ``` <pre class="calibre10">``` function createRange($number){ for($i=0;$i<$number;$i++){ yield time(); } } ``` ``` ## **使用生成器** 我们再运行一下第二段代码： ``` <pre class="calibre10">``` $result = createRange(10); // 这里调用上面我们创建的函数 foreach($result as $value){ sleep(1); echo $value.' '; } ``` ``` ![](https://img.kancloud.cn/4f/76/4f760e945737af1fd66b631ecbfa3775_330x329.png) 我们奇迹般的发现了，输出的值和第一次没有使用生成器的不一样。这里的值（时间戳）中间间隔了1秒。这里的间隔一秒其实就是 sleep(1) 造成的后果。但是为什么第一次没有间隔？那是因为： - 未使用生成器时： createRange 函数内的 for 循环结果被很快放到 $data 中，并且立即返回。所以， foreach 循环的是一个固定的数组。 - 使用生成器时： createRange 的值不是一次性快速生成，而是依赖于 foreach 循环。 foreach 循环一次， for 执行一次。到这里，你应该对生成器有点儿头绪。 ## **深入理解生成器** ### 代码剖析下面我们来对于刚刚的代码进行剖析。 ``` <pre class="calibre10">``` function createRange($number){ for($i=0;$i<$number;$i++){ yield time(); } } $result = createRange(10); // 这里调用上面我们创建的函数 foreach($result as $value){ sleep(1); echo $value.' '; } ``` ``` 我们来还原一下代码执行过程。 1. 首先调用 createRange 函数，传入参数`10`，但是 for 值执行了一次然后停止了，并且告诉 foreach 第一次循环可以用的值。 2. foreach 开始对 $result 循环，进来首先 sleep(1) ，然后开始使用 for 给的一个值执行输出。 3. foreach 准备第二次循环，开始第二次循环之前，它向 for 循环又请求了一次。 4. for 循环于是又执行了一次，将生成的时间戳告诉 foreach . 5. foreach 拿到第二个值，并且输出。由于 foreach 中 sleep(1) ，所以， for 循环延迟了1秒生成当前时间所以，整个代码执行中，始终只有一个记录值参与循环，内存中也只有一条信息。无论开始传入的 $number 有多大，由于并不会立即生成所有结果集，所以内存始终是一条循环的值。 ### **概念理解** 到这里，你应该已经大概理解什么是生成器了。下面我们来说下生成器原理。首先明确一个概念：**生成器yield关键字不是返回值，他的专业术语叫产出值，只是生成一个值** 那么代码中 foreach 循环的是什么？其实是PHP在使用生成器的时候，会返回一个 Generator 类的对象。 foreach 可以对该对象进行迭代，每一次迭代，PHP会通过 Generator 实例计算出下一次需要迭代的值。这样 foreach 就知道下一次需要迭代的值了。而且，在运行中 for 循环执行后，会立即停止。等待 foreach 下次循环时候再次和 for 索要下次的值的时候，循环才会再执行一次，然后立即再次停止。直到不满足条件不执行结束。 ## **实际开发应用** 很多PHP开发者不了解生成器，其实主要是不了解应用领域。那么，生成器在实际开发中有哪些应用？ **读取超大文件** PHP开发很多时候都要读取大文件，比如csv文件、text文件，或者一些日志文件。这些文件如果很大，比如5个G。这时，直接一次性把所有的内容读取到内存中计算不太现实。这里生成器就可以派上用场啦。简单看个例子：读取text文件 ![](https://img.kancloud.cn/84/e0/84e03299c1b2033a6f21616dac6ac750_339x256.png) 我们创建一个text文本文档，并在其中输入几行文字，示范读取。 ``` <pre class="calibre10">``` <?php header("content-type:text/html;charset=utf-8"); function readTxt() { # code... $handle = fopen("./test.txt", 'rb'); while (feof($handle)===false) { # code... yield fgets($handle); } fclose($handle); } foreach (readTxt() as $key => $value) { # code... echo $value.' '; } ``` ``` ![](https://img.kancloud.cn/a2/b5/a2b5f198ad68a2a0e99f34a42d829fb6_343x343.png) 通过上图的输出结果我们可以看出代码完全正常。但是，背后的代码执行规则却一点儿也不一样。使用生成器读取文件，第一次读取了第一行，第二次读取了第二行，以此类推，**每次被加载到内存中的文字只有一行**，大大的减小了内存的使用。这样，即使读取上G的文本也不用担心，完全可以像读取很小文件一样编写代码。 ## **php7生成器中引入其他生成器** 在生成器中可以引入另一个或几个生成器，只需要写yield from functionName1 ``` <pre class="calibre10">``` function generator1() { yield 1; yield 2; yield from generator2(); yield from generator3(); } function generator2() { yield 3; yield 4; } function generator3() { yield 5; yield 6; } foreach (generator1() as $val) { echo $val, " "; } ``` ``` ## **php7生成器可以返回表达式** 它允许在生成器函数中通过使用 return 语法来返回一个表达式（但是不允许返回引用值），可以通过调用 Generator::getReturn() 方法来获取生成器的返回值，但是这个方法只能在生成器完成产生工作以后调用一次 ``` <pre class="calibre17">``` $gen = (function() { yield 1; yield 2; return 3; })(); foreach ($gen as $val) { echo $val, PHP_EOL;// 1 2 } echo $gen->getReturn(), PHP_EOL;//3 结果： 1 2 3 ``` ```