PHP迭代器(Iterator)使用

2023-02-19

字数统计: 562字 | 阅读时长≈ 2分

自动PHP5开始，标准库就支持了迭代器(Iterator)接口，实现这个接口，就可以像遍历数组般，遍历对象。

一、迭代器相关接口

接口	说明
Traversable	无法被单独实现，必须由Iterator 或者 IteratorAggregate 接口实现。可用与检测类是否支持被foreach遍历
Iterator	迭代器接口，实现此接口的类，可被外部迭代和控制迭代流程
IteratorAggregate	外部迭代器接口，返回一个迭代器，不需要实现具体迭代逻辑，相当于包装一层

Iterator 和 IteratorAggregate 是所有迭代器的基础实现接口。

除了手动实现上面两个基础迭代器接口，PHP标准库还内置了很多Iterator接口可使用，例如ArrayIterator, IteratorIterator, EmptyIterator

二、迭代器示例

2.1 Iterator实现示例

下面是CSV文件迭代器的实现

class CsvIterator implements \Iterator
{
    /** @var string 文件名称 */
    private string $filename;
    /** @var resource 文件资源句柄 */
    private $fileHandle;
    /** @var int 迭代行数 */
    private int $row = 0;
    /** @var array|false 当前行数据 */
    private array|false $currentRow = [];

    public function __construct(string $filename)
    {
        if (!is_readable($filename)) {
            throw new InvalidArgumentException("File cannot be read");
        }

        $this->filename = $filename;
    }

    /**
     * 重置文件迭代指针
     * @return void
     */
    public function rewind(): void
    {
        if ($this->fileHandle) {
            fclose($this->fileHandle);
        }

        $this->fileHandle = fopen($this->filename, 'rb');
        $this->row = 0;
        $this->next();
    }

    /**
     * 获取当前行数据
     * @return array|false
     */
    public function current(): array|false
    {
        return $this->currentRow;
    }

    /**
     * 获取当前读取行号
     * @return int
     */
    public function key(): int
    {
        return $this->row;
    }

    /**
     * 读取下一行数据
     * @return void
     */
    public function next(): void
    {
        if ($this->fileHandle) {
            $this->currentRow = fgetcsv($this->fileHandle);
            if ($this->currentRow !== false) {
                $this->row++;
            }
        }
    }

    /**
     * 当前行是否可用
     * @return bool
     */
    public function valid(): bool
    {
        return $this->currentRow !== false;
    }

    public function __destruct()
    {
        if ($this->fileHandle) {
            fclose($this->fileHandle);
        }
    }
}

2.2 IteratorAggregate实现示例

<?php

class ItemIterator implements IteratorAggregate {
  private array $items = [];

  public function push($data): void {
    $this->items[] = $data;
  }

  public function getIterator(): Traversable {
    return new ArrayIterator($this->items);
  }
}

$iterator = new ItemsIterator();
$iterator->push('{"name":"test1"}');
$iterator->push('{"name":"test2"}');
$iterator->push('{"name":"test3"}');

foreach ($iterator as $item) {
    print_r($item) . PHP_EOL;
}

三、相关链接

本文作者： 暮秋人
本文链接： https://muqiuren.pages.dev/2023/02/php-iterator/
版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！