给力星

Web Developer

重温PHP手册 – 生成器

生成器

(PHP 5 >= 5.5.0)生成器提供了一种更容易的方法来实现简单的对象迭代。

生成器允许你在 foreach 代码块中写代码来迭代一组数据而不需要在内存中创建一个数组,生成器可以根据需要 yield 多次,以便生成需要迭代的值。

一个简单的例子就是使用生成器来重新实现 range() 函数。 标准的 range() 函数需要为其中的每一个返回值在内存中生成一个数组, 结果就是生成一个很大的数组。 比如,调用 range(0, 1000000) 将导致内存占用超过 100 MB。

做为一种替代方法, 我们可以实现一个 xrange() 生成器, 只需要足够的内存来创建 Iterator 对象并在内部跟踪生成器的当前状态,这样只需要不到1K字节的内存。

将 range() 实现为生成器,主要是使用 yield 替代 return (并且一个生成器也不能 return,这会造成编译错误):

function xrange($start, $limit, $step = 1) {
    if ($start < $limit) {
        if ($step <= 0) {
            throw new LogicException('Step must be +ve');
        }

        for ($i = $start; $i <= $limit; $i += $step) {
            yield $i;
        }
    } else {
        if ($step >= 0) {
            throw new LogicException('Step must be -ve');
        }

        for ($i = $start; $i >= $limit; $i += $step) {
            yield $i;
        }
    }
}

/* Note that both range() and xrange() result in the same
 * output below. */

echo 'Single digit odd numbers from range():  ';
foreach (range(1, 9, 2) as $number) {
    echo "$number ";        // 1 3 5 7 9
}
echo "\n";

echo 'Single digit odd numbers from xrange(): ';
foreach (xrange(1, 9, 2) as $number) {
    echo "$number ";        // 1 3 5 7 9
}

为了避免资源泄漏,应使用 finally :

function getLines($file) {
    $f = fopen($file, 'r');
    try {
        while ($line = fgets($f)) {
            yield $line;
        }
    } finally {
        fclose($f);     // 结束时关闭资源
    }
}

foreach (getLines("file.txt") as $n => $line) {
    if ($n > 5) break;
    echo $line;
}

yield 关键字

yield 与 return 相似,不同的是 yield 不会终止函数的执行,而是为循环提供一个值并暂停生成器函数的执行。

yield 键值对

yield 也可以生成 key/value对,与数组类似。

/* 最前面的ID作为KEY值 */
$input = <<<'EOF'
1;PHP;Likes dollar signs
2;Python;Likes whitespace
3;Ruby;Likes blocks
EOF;

function input_parser($input) {
    foreach (explode(PHP_EOL, $input) as $line) {
        $fields = explode(';', $line);
        // 将 array 的第一个单元移出并作为结果返回
        // 且将 array 的长度减一并将所有其它单元向前移动一位。
        $id = array_shift($fields);

        yield $id => $fields;
    }
}

foreach (input_parser($input) as $id => $fields) {
    echo "$id:\n";
    echo "    $fields[0]\n";
    echo "    $fields[1]\n";
}

输出如下:

1:
    PHP
    Likes dollar signs
2:
    Python
    Likes whitespace
3:
    Ruby
    Likes blocks

yield NULL值

如果 yield 后未跟变量,则返回 NULL 值。

yield 引用

yield 可以返回引用,进而可以修改其值

function &gen_reference() {
    $value = 3;

    while ($value > 0) {
        yield $value;
    }
}

/* 在循环中可以修改$number的值
 * 从而 gen_reference() 的值也会改变 */
foreach (gen_reference() as &$number) {
    echo (--$number).'... ';
}
// 输出: 2... 1... 0...

Note

用 yield 来实现 Fibonacci:

function getFibonacci()
{
    $i = 0;
    $k = 1; //first fibonacci value
    yield $k;
    while(true)
    {
        $k = $i + $k;
        $i = $k - $i;
        yield $k;        
    }
}

$y = 0;

foreach(getFibonacci() as $fibonacci)
{
    echo $fibonacci . "\n";
    $y++;    
    if($y > 30)
    {
        break; // infinite loop prevent
    }
}

对象生成器

Generator 类中的多数方法与 iterator 接口的方法有相同的语义,但generator对象有额外的方法: send()。

注意:Generator 对象不能通过 new 实例化

Generator 类:

class Generator implements Iterator {
    public function rewind();          // Rewinds the iterator. If
                                       // iteration has already begun,
                                       // this will throw an exception.

    public function valid();           // Returns false if the
                                       // iterator has been closed.
                                       // Otherwise returns true.

    public function current();         // Returns the yielded value.

    public function key();             // Returns the yielded key.

    public function next();            // Resumes execution of the
                                       // generator.

    public function send($value);      // Sends the given value to the
                                       // generator as the result of
                                       // the yield expression and
                                       // resumes execution of the
                                       // generator.
}

Generator::send()

Generator::send() 允许在值在迭代时被注入到生成器函数中,注入的值通过 yield 返回,然后可以像其他生成器函数中的值那样使用。

使用 Generator::send() 来注入值:

function printer() {
    while (true) { 
        // 通过 yield 语句返回注入的值
        $string = yield;
        echo $string;
    }
}

$printer = printer();
$printer->send('Hello world!'); // 输出 Hello world!

Generator 和 Iterator 对象的比较

Generator 的主要优势是简便性,需要书写的代码比 Iterator 类要少,且代码更具可读性。

不过 generator 是 forward-only 的迭代,在迭代开始后不能 rewind ,即同一个生成器不能迭代多次。

两者的对比实例(下面两者的作用是等价的):

function getLinesFromFile($fileName) {
    if (!$fileHandle = fopen($fileName, 'r')) {
        throw new RuntimeException('Couldn\'t open file "' . $fileName . '"');
    }

    while (false !== $line = fgets($fileHandle)) {
        yield $line;
    }

    fclose($fileHandle);
}

// versus...

class LineIterator implements Iterator {
    protected $fileHandle;

    protected $line;
    protected $i;

    public function __construct($fileName) {
        if (!$this->fileHandle = fopen($fileName, 'r')) {
            throw new RuntimeException('Couldn\'t open file "' . $fileName . '"');
        }
    }

    public function rewind() { }

    public function valid() {
        return false !== $this->line;
    }

    public function current() {
        return $this->line;
    }

    public function key() {
        return $this->i;
    }

    public function next() {
        if (false !== $this->line) {
            $this->line = fgets($this->fileHandle);
            $this->i++;
        }
    }
    // 注意结束后要关闭资源
    public function __destruct() {
        fclose($this->fileHandle);
    }
}