官网参考：https://www.php.net/manual/zh/language.generators.overview.php

1. 官网说明

1）(PHP 5 >= 5.5.0, PHP 7, PHP 8)
生成器提供了一种更容易的方法来实现简单的对象迭代，相比较定义类实现 Iterator 接口的方式，性能开销和复杂性大大降低。

2）一种常见的使用场景：在 foreach 迭代数组的时候，使用它。相比于在foreach中再去创建一个数组来说，会更省内存和节约时间。这是因为：yield 只在需要时才会返回一个值，而不是将整个数据集一直保存在内存中。

3）生成器只能在函数中使用。使用它的目的就是：用更少的内存处理数据

2. 例子

2-1 占用更少的内存

  1. <?php
  3. /**
  4.  * 生成器函数
  5.  * @param int $max
  6.  * @return Generator
  7.  */
  8. function getRange(int $max = 10): Generator
  9. {
  10.     for ($i = 1; $i <= $max; $i++) {
  11.         yield $i;
  12.     }
  13. }
  15. /**
  16.  * 更少的内存,更快的时间
  17.  */
  18. (function () {
  19.     foreach (getRange(PHP_INT_MAX) as $range) {
  20.         echo "{$range}";
  21.     }
  22. })();

2-2 键值对

  1. <?php
  3. /**
  4.  * 键值对方式
  5.  * @param int $max
  6.  * @return Generator
  7.  */
  8. function getRange2(int $max = 10): Generator
  9. {
  10.     for ($i = 1; $i <= $max; $i++) {
  11.         $value = $i * mt_rand();
  12.         yield $i => $value;
  13.     }
  14. }
  16. (function () {
  17.     foreach (getRange2(10) as $key => $value) {
  18.         echo "{$key} => {$value}" . PHP_EOL;
  19.     }
  20. });

2-3 生成器传参

  1. <?php
  2. /**
  3.  * 生成器传参,发送stop跳出生成器
  4.  * @param int $max
  5.  * @return Generator
  6.  */
  7. function getRange3(int $max = 10): Generator
  8. {
  9.     for ($i = 1; $i <= $max; $i++) {
  10.         $injected = yield $i;
  11.         if ('stop' === $injected) {
  12.             return;
  13.         }
  14.     }
  15. }
  17. (function () {
  18.     $generator = getRange3(100);
  19.     foreach ($generator as $range) {
  20.         if (50 === $range) {
  21.             $generator->send('stop');
  22.         }
  23.         echo "Dataset {$range}" . PHP_EOL;
  24.     }
  25. })();

3. Generator的作用

1）用Generator来实现协程

2）用Generator来处理大量数据集

3.1 开销的比较代码

  1. <?php
  3. /**
  4.  * 测试：不使用Generator 和 使用Generator的开销
  5.  */
  7. $n = 10000000;
  8. $startTime = microtime(true);
  9. $startMemory = memory_get_usage();
  10. $array = range(1, $n);
  11. foreach ($array as $a) {
  12. }
  13. echo memory_get_usage() - $startMemory, " bytes\n";
  14. echo microtime(true) - $startTime . " ms\n";
  16. function xrange($start, $end, $step = 1)
  17. {
  18.     for ($i = $start; $i < $end; $i += $step) {
  19.         yield $i;
  20.     }
  21. }
  22. $startTime = microtime(true);
  23. $startMemory = memory_get_usage();
  24. $g = xrange(1, $n);
  25. foreach ($g as $i) {
  26. }
  27. echo memory_get_usage() - $startMemory, " bytes\n";
  28. echo microtime(true) - $startTime . " ms\n";