如何封装 mysqli_result 为可迭代对象

M66 2025-05-18

在 PHP 开发中，我们经常使用 mysqli 扩展来与 MySQL 数据库进行交互，特别是当我们执行查询操作时，通常会得到一个 mysqli_result 对象。然而，mysqli_result 对象本身并不支持像数组或其他可迭代对象一样直接使用 foreach 遍历查询结果，这使得我们在处理查询结果时可能需要手动调用 fetch_assoc() 或其他类似的函数来获取每一行数据。

为了更方便地处理查询结果，我们可以将 mysqli_result 封装成一个可迭代的对象，使得在处理查询结果时更加简洁和直观。接下来，我们将探讨如何实现这一目标。

步骤一：创建一个 Iterator 类

我们可以创建一个类实现 Iterator 接口，这样我们就能将 mysqli_result 封装为一个可迭代对象。首先，我们需要确保该类能够接收一个 mysqli_result 对象，并通过实现接口的方法让它支持迭代。

<?php
class MysqliResultIterator implements Iterator {
    private $result;
    private $currentRow;
    private $currentIndex;

    public function __construct($mysqliResult) {
        $this->result = $mysqliResult;
        $this->currentIndex = 0;
    }

    public function rewind() {
        $this->currentIndex = 0;
        $this->currentRow = $this->result->fetch_assoc();
    }

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

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

    public function next() {
        $this->currentRow = $this->result->fetch_assoc();
        $this->currentIndex++;
    }

    public function valid() {
        return $this->currentRow !== null;
    }
}
?>

在这个类中，我们实现了 Iterator 接口的五个方法：

rewind()：将迭代器重置到第一个元素。
current()：返回当前的元素。
key()：返回当前元素的索引。
next()：移动到下一个元素。
valid()：检查当前元素是否有效。

通过这些方法，MysqliResultIterator 类就能够让我们像操作数组或其他可迭代对象一样，直接遍历查询结果。

步骤二：使用 MysqliResultIterator

一旦我们定义了这个迭代器类，就可以通过将 mysqli_result 对象传递给 MysqliResultIterator 类来创建一个可迭代对象。

<?php
// 假设你已经建立了数据库连接并执行了查询
$mysqli = new mysqli("localhost", "username", "password", "database");

$query = "SELECT id, name, email FROM users";
$result = $mysqli->query($query);

if ($result) {
    // 创建一个 MysqliResultIterator 对象
    $iterator = new MysqliResultIterator($result);

    // 通过 foreach 迭代查询结果
    foreach ($iterator as $index => $row) {
        echo "Index: " . $index . "<br>";
        echo "ID: " . $row['id'] . "<br>";
        echo "Name: " . $row['name'] . "<br>";
        echo "Email: " . $row['email'] . "<br><hr>";
    }

    // 关闭查询结果
    $result->free();
} else {
    echo "Query failed: " . $mysqli->error;
}

$mysqli->close();
?>

在上面的代码中，我们创建了一个 MysqliResultIterator 对象，并通过 foreach 语句迭代查询结果。你会发现，使用这个迭代器，代码变得更加简洁，避免了手动调用 fetch_assoc() 方法。

步骤三：优化迭代器（可选）

如果你需要更灵活的功能，例如支持多种数据格式（关联数组、数字数组等），你可以进一步扩展迭代器，使其支持更多的选项。例如，添加一个参数来指定是否以关联数组或数字数组的形式返回数据。

<?php
class MysqliResultIterator implements Iterator {
    private $result;
    private $currentRow;
    private $currentIndex;
    private $fetchType;

    public function __construct($mysqliResult, $fetchType = MYSQLI_ASSOC) {
        $this->result = $mysqliResult;
        $this->currentIndex = 0;
        $this->fetchType = $fetchType;
    }

    public function rewind() {
        $this->currentIndex = 0;
        $this->currentRow = $this->result->fetch_array($this->fetchType);
    }

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

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

    public function next() {
        $this->currentRow = $this->result->fetch_array($this->fetchType);
        $this->currentIndex++;
    }

    public function valid() {
        return $this->currentRow !== null;
    }
}
?>

通过这个改进，你可以在创建迭代器时指定查询结果的获取格式，例如使用 MYSQLI_ASSOC 或 MYSQLI_NUM 来返回关联数组或数字数组。

小结

通过将 mysqli_result 封装成一个实现了 Iterator 接口的对象，我们可以使数据库查询结果的处理变得更加方便和优雅。这样做不仅使代码变得简洁，而且提供了更多的灵活性，能够更好地处理不同类型的查询结果。

这种封装方法可以大大提高代码的可维护性和可读性，特别是在需要遍历大量数据的场景下。