PHP each() 替代方案与常见问题解决

理解 each() 函数及其废弃背景

在PHP的早期版本中，each() 函数是一个常用的数组迭代工具，它能够返回当前数组元素的键值对，并将数组内部指针向前移动一位。each() 函数的独特之处在于它返回一个包含四个元素的数组：两个数字索引（0和1）分别对应键和值，以及两个字符串索引（'key'和'value'）也分别对应键和值。例如，对于 $arr = ['a' => 10]，each($arr) 会返回 [0 => 'a', 1 => 10, 'key' => 'a', 'value' => 10]。

然而，随着PHP语言的发展和优化，each() 函数因其性能和功能上的局限性，已在PHP 7.2版本中被标记为废弃（deprecated），并在PHP 8.0版本中被彻底移除。官方推荐使用 foreach 循环作为首选的数组遍历方式，因为它更简洁、高效且不易出错。

尽管如此，在维护旧代码或特定场景下，开发者可能仍需要模拟 each() 的行为，例如在 while (list($key, $value) = each($array)) 这种结构中。这时，自定义一个 each() 的替代函数就显得尤为重要。

自定义 each() 替代函数：常见错误分析

为了模拟 each() 的功能，一些开发者会尝试编写自己的函数，例如以下 myEach() 函数：

function myEach(&$array)
{
    $key = key($array);
    $result = ($key === null) ? false :
              [$key, current($array), 'key', 'value' => current($array)]; // 潜在错误点
    next($array);
    return $result;
}

这个实现尝试获取当前键和值，并在数组遍历完成后返回 false，同时在每次调用后将数组指针前移。然而，上述代码在构建 result 数组时存在一个微妙但关键的错误。

错误分析：each() 函数返回的数组中，除了数字索引 0 和 1 之外，还有字符串索引 'key' 和 'value'。原始 each() 函数返回的 ['key' => $key] 意味着它将当前元素的实际键作为值赋给了 'key' 索引。

在上述 myEach() 的错误实现中，[$key, current($array), 'key', 'value' => current($array)] 这部分：

• $key 会被自动赋给索引 0。
• current($array) 会被自动赋给索引 1。
• 问题出在 'key' 这个字符串字面量。 它会被自动赋给索引 2，而不是作为键 'key' 的值。这意味着，如果原始数组的键是 'a'，那么返回的数组中会包含 [2 => 'key']，而不是 ['key' => 'a']。这与 each() 的预期行为不符，可能导致依赖 ['key'] 或 [2] 获取键的代码逻辑出错。

正确的 each() 替代函数实现

要正确模拟 each() 的行为，我们需要确保返回数组的结构与 each() 完全一致，特别是 key 和 value 的字符串索引部分。修正后的 myEach() 函数应如下所示：

/**
 * 模拟 PHP each() 函数的行为，用于兼容旧代码或特定迭代场景。
 * 注意：在大多数情况下，推荐使用 foreach 循环。
 *
 * @param array $array 引用传递的数组
 * @return array|false 包含当前键值对的数组，或在遍历结束时返回 false
 */
function myEach(&$array)
{
    $key = key($array); // 获取当前键

    // 如果当前键为 null，表示数组已遍历完或为空，返回 false
    if ($key === null) {
        return false;
    }

    $value = current($array); // 获取当前值

    // 构建与 each() 函数兼容的返回数组
    // 确保 'key' 索引的值是实际的键，而不是字符串字面量 'key'
    $result = [
        0       => $key,
        1       => $value,
        'key'   => $key,    // 修正点：将字符串 'key' 改为 'key' => $key
        'value' => $value
    ];

    next($array); // 移动数组内部指针到下一个元素

    return $result;
}

修正点说明： 关键的修正在于将 ['key', current($array), ...] 中的 'key' 改为 'key' => $key。这样，返回的数组中 ['key'] 索引的值就是当前元素的实际键，完全符合 each() 的原始行为。

示例用法与注意事项

使用修正后的 myEach() 函数，可以像使用原始 each() 一样进行数组遍历：

$data = ['apple' => 10, 'banana' => 20, 'orange' => 30];
$processedData = [];

echo "--- 使用 myEach() 遍历数组 ---\n";
while ($entry = myEach($data)) {
    echo "当前键: " . $entry[0] . " (或 " . $entry['key'] . "), ";
    echo "当前值: " . $entry[1] . " (或 " . $entry['value'] . ")\n";

    // 模拟一些处理
    $processedData[$entry['key']] = $entry['value'] * 2;
}

echo "\n--- 处理后的数据 ---\n";
print_r($processedData);

/* 预期输出:
--- 使用 myEach() 遍历数组 ---
当前键: apple (或 apple), 当前值: 10 (或 10)
当前键: banana (或 banana), 当前值: 20 (或 20)
当前键: orange (或 orange), 当前值: 30 (或 30)

--- 处理后的数据 ---
Array
(
    [apple] => 20
    [banana] => 40
    [orange] => 60
)
*/

注意事项：

1. 引用传递： myEach() 函数需要通过引用 (&) 传递数组，因为 key()、current() 和 next() 函数会操作数组的内部指针。
2. foreach 优先： 尽管提供了 myEach() 作为替代方案，但在绝大多数情况下，foreach 循环仍然是遍历数组的最佳选择，因为它语法更简洁，性能更优，且不易引入指针操作带来的潜在问题。
3. 兼容性： 这种自定义实现主要用于兼容那些高度依赖 each() 函数返回结构的老旧代码，或在需要手动控制数组指针的特定高级场景下。
4. PHP 8.0+ 环境： 在 PHP 8.0 及更高版本中，each() 函数已完全移除，直接调用会导致致命错误。使用自定义 myEach() 可以帮助这些代码在不大幅重构的情况下继续运行。

总结

each() 函数的废弃是PHP语言演进的一部分，鼓励开发者采用更现代、高效的迭代方式。当必须模拟 each() 的行为时，自定义函数如 myEach() 是一个可行的方案。然而，务必注意其返回数组的结构，特别是字符串键 'key' 必须正确地映射到实际的数组键。通过本文提供的修正和示例，开发者可以确保其自定义替代方案的正确性和兼容性，从而平稳地过渡到更现代的PHP编程实践。