【转】PHP中被忽略的性能优化利器：生成器.md

 

PHP 

如果是做Python或者其他语言的小伙伴，对于生成器应该不陌生。但很多PHP开发者或许都不知道生成器这个功能，可能是因为生成器是PHP 5.5.0才引入的功能，也可以是生成器作用不是很明显。但是，生成器功能的确非常有用。

优点

直接讲概念估计你听完还是一头雾水，所以我们先来说说优点，也许能勾起你的兴趣。那么生成器有哪些优点，如下：

• 生成器会对PHP应用的性能有非常大的影响
• PHP代码运行时节省大量的内存
• 比较适合计算大量的数据

那么，这些神奇的功能究竟是如何做到的？我们先来举个例子。

概念引入

首先，放下生成器概念的包袱，来看一个简单的PHP函数：

1 2 3 4 5 6 7

function ($number){ $data = []; for($i=0;$i<$number;$i++){ $data[] = time(); } return $data; }

这是一个非常常见的PHP函数，我们在处理一些数组的时候经常会使用。这里的代码也非常简单：

• 1、我们创建一个函数。
• 2、函数内包含一个for循环，我们循环的把当前时间放到$data里面
• 3、for循环执行完毕，把$data返回出去。

下面没完，我们继续。我们再写一个函数，把这个函数的返回值循环打印出来：

1 2 3 4 5 6 7 8 9 10

echo 'start time: ' . $start_time = microtime_float(); $result = createRange(10); foreach($result as $value){ sleep(1);//这里停顿1秒，我们后续有用 echo '<br>' . $value; } echo '<br> end time: ' . $end_time = microtime_float(); echo '<br> 当前页面执行时间： ' . ($end_time - $start_time);

这里定义了一个辅助函数，用于打印程序的执行时间：

1 2 3 4 5 6 7 8 9

/** * 返回微妙数（辅助函数） * @return float */ function microtime_float() { list($usec, $sec) = explode(' ', microtime()); return $usec + $sec; }

我们在浏览器里面看一下运行结果：

这里非常完美，没有任何问题。

思考一个问题

我们注意到，在调用函数 createRange 的时候给 $number 的传值是10，一个很小的数字。假设，现在传递一个值 10000000（1000万）。

那么，在函数 createRange 里面，for 循环就需要执行 1000万次。且有 1000 万个值被放到 $data 里面，而 $data 数组在是被放在内存内。所以，在调用函数时候会占用大量内存。

这里，生成器就可以大显身手了。

创建生成器

我们直接修改代码，你们注意观察：

1 2 3 4 5

function ($number){ for($i=0;$i<$number;$i++){ yield time(); } }

看下这段和刚刚很像的代码，我们删除了数组 $data，而且也没有返回任何内容，而是在 time() 之前使用了一个关键字 yield

使用生成器

我们再运行一下第二段代码：

1 2 3 4 5 6 7 8 9 10

echo 'start time: ' . $start_time = microtime_float(); $result = createRange(10); foreach($result as $value){ sleep(1);//这里停顿1秒，我们后续有用 echo '<br>' . $value; } echo '<br> end time: ' . $end_time = microtime_float(); echo '<br> 当前页面执行时间： ' . ($end_time - $start_time);

我们奇迹般的发现了，输出的值和第一次没有使用生成器的不一样。这里的值（时间戳）中间间隔了1秒。

这里的间隔一秒其实就是 sleep(1) 造成的后果。但是为什么第一次没有间隔？那是因为：

• 未使用生成器时：createRange 函数内的 for 循环结果被很快放到 $data中，并且立即返回。所以，foreach 循环的是一个固定的数组。
• 使用生成器时：createRange 的值不是一次性快速生成，而是依赖于 foreach 循环。foreach 循环一次，for 执行一次。

到这里，你应该对生成器有点儿头绪。

深入理解生成器

代码剖析

下面我们来对于刚刚的代码进行剖析（去掉冗余部分）。

1 2 3 4 5 6 7 8 大专栏  【转】PHP中被忽略的性能优化利器：生成器.mde">9 10 11

function ($number){ for($i=0;$i<$number;$i++){ yield time(); } } $result = createRange(10); foreach($result as $value){ sleep(1); echo $value.'<br />'; }

我们来还原一下代码执行过程。

• 首先调用 createRange 函数，传入参数 10，但是 for 值执行了一次然后停止了，并且告诉 foreach 第一次循环可以用的值。
• foreach 开始对 $result 循环，进来首先 sleep(1)，然后开始使用 for 给的一个值执行输出。
• foreach 准备第二次循环，开始第二次循环之前，它向 for 循环又请求了一次。
• for 循环于是又执行了一次，将生成的时间戳告诉foreach.
• foreach 拿到第二个值，并且输出。由于 foreach 中 sleep(1)，所以，for 循环延迟了1秒生成当前时间

所以，整个代码执行中，始终只有一个记录值参与循环，内存中也只有一条信息。

无论开始传入的 $number 有多大，由于并不会立即生成所有结果集，所以内存始终是一条循环的值。

概念理解

到这里，你应该已经大概理解什么是生成器了。下面我们来说下生成器原理。

首先明确一个概念：生成器yield关键字不是返回值，他的专业术语叫产出值，只是生成一个值

那么代码中 foreach 循环的是什么？其实是PHP在使用生成器的时候，会返回一个 Generator 类的对象。foreach 可以对该对象进行迭代，每一次迭代，PHP会通过 Generator 实例计算出下一次需要迭代的值。这样 foreach 就知道下一次需要迭代的值了。

而且，在运行中 for 循环执行后，会立即停止。等待 foreach 下次循环时候再次和 for 索要下次的值的时候，for 循环才会再执行一次，然后立即再次停止。直到不满足条件不执行结束。

实际开发应用

很多PHP开发者不了解生成器，其实主要是不了解应用领域。那么，生成器在实际开发中有哪些应用？

读取超大文件

PHP开发很多时候都要读取大文件，比如csv文件、text文件，或者一些日志文件。这些文件如果很大，比如5个G。这时，直接一次性把所有的内容读取到内存中计算不太现实。

这里生成器就可以派上用场啦。简单看个例子：读取log文件

这是我系统的一个启动日志，拿来做示范读取

• 通过数组输出文件内容
  

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

  header("content-type:text/html;charset=utf-8"); function readLog() { # code... $handle = fopen("./bootstrap.log", 'rb'); $data = []; while (feof($handle)===false) { # code... $data[] = fgets($handle); } fclose($handle); return $data; } $start_time = microtime_float(); $start_mem = memory_get_usage(); $result = readLog(); foreach ($result as $key => $value) { # code... echo '<br>' . $value; } echo 'start time: ' . $start_time; echo '<br>end time: ' . $end_time = microtime_float(); echo '<br>读取文件总共用时: ' . ($end_time - $start_time); echo '<br>start memory: ' . $start_mem; echo '<br>end memory: ' . $end_mem = memory_get_usage(); echo '<br>total memory: ' . ($end_mem - $start_mem) / 1024;

• 通过生成器输出文件内容
  

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  ... ... function readLog() { # code... $handle = fopen("./bootstrap.log", 'rb'); $data = []; while (feof($handle)===false) { # code... yield = fgets($handle); } fclose($handle); } ... ...

通过上图的输出结果我们可以看出：

输出的内容完全相同，但使用数组输出文件内容和使用生成器输出内容所占用的内存差距很惊人（我这个文件大小为：300.8k）。

由此可见，两种方式背后的代码执行规则一点儿也不一样。使用生成器读取文件，第一次读取了第一行，第二次读取了第二行，以此类推，每次被加载到内存中的文字只有一行，大大的减小了内存的使用。

这样，即使读取上G的文本也不用担心，完全可以像读取很小文件一样编写代码。

【注】：本传转载自PHP中被忽略的性能优化利器：生成器