PHP迭代器和生成器用法实例分析

本文实例讲述了PHP迭代器和生成器用法,分享给大家供大家参考,具体如下:

迭代器

迭代器实际是一个实现了Iterator的类,可以用foreach进行遍历。

例如:

  1. <?php
  2. class Sample implements Iterator{
  3. private $curIndex=0;
  4. private $items=null;
  5. public function __construct($_items) {
  6. $this->items = $_items;
  7. }
  8. public function current (){
  9. echo "current\n";
  10. return $this->items[$this->curIndex];
  11. }
  12. public function key (){
  13. echo "key\n";
  14. return $this->curIndex;
  15. }
  16. public function next (){
  17. echo "next\n";
  18. $this->curIndex++;
  19. }
  20. public function rewind (){
  21. $this->curIndex = 0;
  22. }
  23. public function send ( $value ){
  24. if($value == "stop"){
  25. $this->curIndex = null;
  26. }
  27. }
  28. public function valid (){
  29. echo "valid\n";
  30. return isset($this->items[$this->curIndex]);
  31. }
  32. }
  33. $sample = new Sample([1,2,3]);
  34. foreach ($sample as $k =>$v){
  35. }

输出

valid current key next

可以看到foreach 是先调用valid判断迭代器是否有效,然后再调用current获取当前值,同时调用next移动key到指向下一个值(输出key是因为 $k=>$v的缘故)。

生成器

让我们先看一下官方文档

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

生成器允许你在 foreach 代码块中写代码来迭代一组数据而不需要在内存中创建一个数组, 那会使你的内存达到上限,或者会占据可观的处理时间。

相反,你可以写一个生成器函数,就像一个普通的自定义函数一样, 和普通函数只返回一次不同的是, 生成器可以根据需要 yield 多次,以便生成需要迭代的值。

PHP 将会在每次需要值的时候调用生成器函数,并在产生一个值之后保存生成器的状态,这样它就可以在需要产生下一个值的时候恢复调用状态。

下面是php官方文档中的示例

  1. <?php
  2. function gen_one_to_three() {
  3. for ($i = 1; $i <= 3; $i++) {
  4. //注意变量$i的值在不同的yield之间是保持传递的。
  5. yield $i;
  6. }
  7. }
  8. $generator = gen_one_to_three();
  9. foreach ($generator as $value) {
  10. echo "$value\n";
  11. }
  12. var_dump($generator); //实际上是Generator对象

如上,若把3修改成10000,对于$generator实际上没有区别,它只是保存了一个当前值(当然还有相关的内部状态,这里是为了简化),并没有产生10000个数。

从中可以看出生成器的优势在于减少内存的使用,在需要时才生成对应的值。

查看php文档,我们可以看到Generator实际也是Iterator的具体实现,yield调用时就是返回的Generator对象。

那么怎么理解迭代器和生成器的关系呢?

其实,生成器是迭代器的实现+yield,产生了生成器对象。

我们也可以自己定义一个类似yield的函数,如下:

  1. function myYeild(){
  2. $args = func_get_args();
  3. return new Sample($args);
  4. }
  5. $generator = myYeild(1,2,3);
  6. foreach ($generator as $value) {
  7. echo "$value\n";
  8. }

注意,我们的myYeild,是不能和php内置的yeild那么使用的,因为yeild会保存调用上下文,临时离开,并没有return。

这里只是类比一下。

既然yeild可以把普通的对象包装成generator,那么我们的iterator通过yeild也可以像Generator一样吗?

答案有点悲伤,yeild是把传入的值作为参数生成Generator实例,它并不知道我们的iterator。不过这样设计也是合理的,以防我们自己的iterator不靠谱。

实际使用场合

数据库遍历

可以结合游标,遍历数据库时,不需要一次返回所有数据,而是每次取一行。

  1. class AllUser implements \Iterator
  2. {
  3. protected $index = 0;
  4. protected $data = [];
  5. public function __construct()
  6. {
  7. $link = mysqli_connect('192.168.0.91', 'root', '123', 'xxx');
  8. $rec = mysqli_query($link, 'select id from doc_admin');
  9. $this->data = mysqli_fetch_all($rec, MYSQLI_ASSOC);
  10. }
  11. //1 重置迭代器
  12. public function rewind()
  13. {
  14. $this->index = 0;
  15. }
  16. //2 验证迭代器是否有数据
  17. public function valid()
  18. {
  19. return $this->index < count($this->data);
  20. }
  21. //3 获取当前内容
  22. public function current()
  23. {
  24. $id = $this->data[$this->index];
  25. return User::find($id);
  26. }
  27. //4 移动key到下一个
  28. public function next()
  29. {
  30. return $this->index++;
  31. }
  32. //5 迭代器位置key
  33. public function key()
  34. {
  35. return $this->index;
  36. }
  37. }
  38. //实现迭代遍历用户表
  39. $users = new AllUser();
  40. //可实时修改
  41. foreach ($users as $user){
  42. $user->add_time = time();
  43. $user->save();
  44. }

文件遍历

一次读取一行

实现Iterator接口,让普通类可以使用foreach遍历。

协程,参见鸟哥则这篇文章。

注意:可以在生成器的函数前加"&",可以使用引用。在函数里直接return会终止生成器。