PHP 迭代器 生成器

迭代和迭代器

迭代是指反复执行一个过程，每执行一次叫做迭代一次。比如普通的遍历便是迭代：

$arr = [1, 2, 3, 4, 5];

foreach($arr as $key => $value) {
    echo $key . ' => ' . $value . "\n";
}

我们可以看到通过foreach对数组遍历并迭代输出其内容。在foreach内部，每次迭代都会将当前的元素的值赋给$value并将数组的指针移动指向下一个元素为下一次迭代做准备，从而实现顺序遍历。像这样能够让外部的函数迭代自己内部数据的接口就是迭代器接口，对应的那个被迭代的自己就是迭代器对象。

PHP提供了统一的迭代器接口：

Iterator extends Traversable {

    // 返回当前的元素
    abstract public mixed current(void)
    // 返回当前元素的键
    abstract public scalar key(void)
    // 向下移动到下一个元素
    abstract public void next(void)
    // 返回到迭代器的第一个元素
    abstract public void rewind(void)
    // 检查当前位置是否有效
    abstract public boolean valid(void)
}

通过实现Iterator接口，我们可以自行的决定如何遍历对象。

foreach之所以能工作，是因为这些集合类都实现了Iterable接口，该接口中定义了Iterator迭代器的产生方法，并且foreach就是通过Iterable接口在序列中进行移动。

yield和生成器

相比较迭代器，生成器提供了一种更容易的方法来实现简单的对象迭代，性能开销和复杂性都大大降低。

一个生成器函数看起来像一个普通的函数，不同的是普通函数返回一个值，而生成器可以yield生成许多个值，并且每一次的yield只是暂停当前的执行状态，当下次调用生成器函数时，PHP会从上次暂停的状态继续执行下去。

我们在使用生成器的时候可以像关联数组那样指定一个键名对应生成的值。如下生成一个键值对与定义一个关联数组相似。

function xrange($start, $limit, $step = 1) {
    for ($i = $start, $j = 0; $i <= $limit; $i += $step, $j++) {
        // 给予键值
        yield $j => $i;
    }
}

$xrange = xrange(1, 10, 2);
foreach ($xrange as $key => $value) {
    echo $key . ' => ' . $value . "\n";
}

概念理解

首先明确一个概念：生成器yield关键字不是返回值，他的专业术语叫产出值，只是生成一个值。实际上生成器函数返回的是一个Generator对象，这个对象不能通过new实例化，并且实现了Iterator接口。

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

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

生成器优点

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

实际开发应用：读取超大文件

PHP开发很多时候都要读取大文件，比如csv文件、text文件，或者一些日志文件。这些文件如果很大，比如5个G。这时，直接一次性把所有的内容读取到内存中计算不太现实。使用生成器读取文件，第一次读取了第一行，第二次读取了第二行，以此类推，每次被加载到内存中的文字只有一行，大大的减小了内存的使用。

<?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.'<br />';
}