PHP学习笔记17：迭代器和生成器

最新推荐文章于 2024-10-08 00:47:23 发布

魔芋红茶

最新推荐文章于 2024-10-08 00:47:23 发布

阅读量715

点赞数

分类专栏： PHP

本文链接：https://blog.csdn.net/hy6533/article/details/121862592

版权

PHP 专栏收录该内容

33 篇文章 2 订阅

订阅专栏

本文介绍了PHP中的迭代器和生成器。迭代器允许自定义遍历集合的方式，通过实现Iterator接口，包括current、next、rewind、key和valid等方法。生成器则提供了一种简洁的创建迭代器的方式，使用yield关键字，可以在遍历大型数据集时避免内存占用过多。文中还展示了如何使用生成器进行字符串的单词和字母遍历，并讨论了生成器的优点及其在处理超大序列时的效率优势。

摘要由CSDN通过智能技术生成

PHP学习笔记17：迭代器和生成器

图源：php.net

迭代器相关概念广泛存在于各种编程语言和设计模式中，这里推荐两篇我的相关文章：

迭代器

php中，可以通过实现Iterator接口的方式实现一个迭代器：

<?php
class MyClass implements Iterator
{
    public function current(): mixed
    {
    }
    public function next(): void
    {
    }
    public function rewind(): void
    {
    }
    public function key(): mixed
    {
    }
    public function valid(): bool
    {
    }
}

这些方法的作用是：

current，返回游标对应的当前元素。
next，移动游标到下一个元素。
rewind，重置游标到开始位置。
key，返回游标位置。
valid，游标当前的位置是否有效（用于判断是否结束遍历）。

php的迭代器接口比Python中的更复杂，但好处是包含rewind方法，可以重置迭代器以重复迭代。

下面用一个可以将字符串内单词分词的程序作为示例：

<?php
class Sentence implements Iterator
{
    private array $words;
    private int $index = 0;
    public function __construct(string $string)
    {
        $this->words = str_word_count($string, 1);
    }
    public function current(): mixed
    {
        return $this->words[$this->index];
    }
    public function rewind(): void
    {
        $this->index = 0;
    }
    public function next(): void
    {
        $this->index++;
    }
    public function key(): mixed
    {
        return $this->index;
    }
    public function valid(): bool
    {
        return isset($this->words[$this->index]);
    }
}
$sentence = new Sentence("hello world, how are you!");
foreach ($sentence as $word) {
    echo $word . PHP_EOL;
}
echo PHP_EOL;
// hello
// world
// how
// are
// you

php预设了一些常用的迭代器，具体请参考官方手册迭代器。

生成器

生成器可以看做是一种特殊的迭代器，可以使用生成器函数来便捷地创建一个生成器：

<?php
function sentence(string $str)
{
    $words = str_word_count($str, 1);
    foreach ($words as $key => $val) {
        yield $val;
    }
}
foreach (sentence("hello world, how are you!") as $word) {
    echo $word . PHP_EOL;
}
// hello
// world
// how
// are
// you

生成器的优点在于，相比较迭代器，它的实现代码更少，且还可以用yield from语句将调用委托给另一个生成器，实现类似的生成器多级套用的方式。这点在Python的async包实现并发时相当常见。

这里展示sentence套用一个将字符串分解为字母遍历的生成器：

<?php
function char(string $str): Generator
{
    $len = strlen($str);
    if ($len == 0) {
        yield "";
        return;
    }
    $index = 0;
    do {
        yield substr($str, $index, 1);
        $index++;
    } while ($index <= $len - 1);
}
function sentence(string $str): Generator
{
    $words = str_word_count($str, 1);
    foreach ($words as $key => $val) {
        yield from char($val);
    }
}
foreach (sentence("hello world, how are you!") as $word) {
    echo $word . " ";
}
echo PHP_EOL;
// h e l l o w o r l d h o w a r e y o u

通过使用生成器，我们可以避免程序中因为遍历大型数组导致的内存占用过多的情况：

<?php
function xrange(int $start, int $end, int $step): Generator
{
    if ($step <= 0) {
        throw new Exception("invlid step param.");
    }
    if ($start < $end) {
        for ($i = $start; $i <= $end; $i += $step) {
            yield $i;
        }
    } else {
        for ($i = $start; $i >= $end; $i -= $step) {
            yield $i;
        }
    }
}
function print_generator(Generator $gen)
{
    foreach ($gen as $val) {
        echo $val . " ";
    }
    echo PHP_EOL;
}
$gen1 = xrange(1, 10, 1);
$gen2 = xrange(20, 3, 3);
print_generator($gen1);
print_generator($gen2);
// 1 2 3 4 5 6 7 8 9 10 
// 20 17 14 11 8 5