理解并实现 PHP each() 函数的现代替代方案

1. each() 函数的废弃与替代需求

在 php 7.2.0 版本中，each() 函数被正式废弃，并在 php 8.0.0 版本中被彻底移除。each() 函数的作用是返回数组中当前指针位置的键值对，并将数组的内部指针向前移动一步。它的典型使用场景是在 while 循环中遍历数组，例如 while (list($key, $value) = each($array))。由于其设计与现代 php 的迭代器模式和 foreach 循环相比显得冗余且效率不高，因此被废弃是必然趋势。

当面对需要兼容旧代码或在特定场景下模拟 each() 行为时，开发者可能需要自行实现一个替代函数。然而，正确地复制 each() 的返回值结构是关键。

2. each() 函数的返回值解析

理解 each() 的返回值是实现其替代方案的基础。当 each() 成功返回一个键值对时，它会返回一个包含四个元素的数组，这四个元素分别是：

• [0]: 数组的当前键 (key)
• [1]: 数组的当前值 (value)
• ['key']: 数组的当前键 (key)，以字符串 'key' 作为关联键
• ['value']: 数组的当前值 (value)，以字符串 'value' 作为关联键

例如，对于数组 ['a' => 10, 'b' => 20]，当指针指向 'a' => 10 时，each() 会返回 [0 => 'a', 1 => 10, 'key' => 'a', 'value' => 10]。当数组迭代完毕时，each() 返回 false。

3. 自定义 myEach() 函数的错误与修正

考虑一个尝试模仿 each() 函数行为的自定义实现 myEach()：

立即学习“PHP免费学习笔记（深入）”；

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

这个 myEach() 函数的核心逻辑是：

1. 获取当前键 (key($array))。
2. 判断是否已到达数组末尾 ($key === null)。
3. 如果未到达末尾，构建一个返回数组。
4. 将数组内部指针向前移动 (next($array))。

问题出在构建返回数组的这一行：[$key, current($array), 'key', 'value' => current($array)];

根据 each() 的返回值规范，第三个元素 ['key'] 应该存储当前键的值。然而，在上述代码中，它被错误地写成了一个字符串字面量 'key'，而不是将 $key 变量的值赋给关联键 'key'。这意味着，这个自定义函数在第三个位置返回的不是实际的键，而是一个字符串 "key"。

腾讯智影-AI数字人

基于AI数字人能力，实现7*24小时AI数字人直播带货，低成本实现直播业务快速增增，全天智能在线直播

73

查看详情

正确的实现方式应该确保关联键 'key' 映射到 $key 变量的值。修正后的代码如下：

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

修正说明： 通过将 'key' 修改为 'key' => $key，我们确保了返回数组的第三个元素是一个关联键值对，其中键是字符串 'key'，值是当前数组元素的实际键 $key。这样，myEach() 的返回值结构就完全符合了 each() 的规范。

示例代码：

$data = ['name' => 'Alice', 'age' => 30, 'city' => 'New York'];

// 使用修正后的 myEach()
echo "--- 使用修正后的 myEach() ---" . PHP_EOL;
reset($data); // 重置数组指针
while ($item = myEach($data)) {
    echo "0: " . $item[0] . ", 1: " . $item[1] . ", key: " . $item['key'] . ", value: " . $item['value'] . PHP_EOL;
}

// 预期输出 (与 each() 行为一致)
// 0: name, 1: Alice, key: name, value: Alice
// 0: age, 1: 30, key: age, value: 30
// 0: city, 1: New York, key: city, value: New York

4. 现代 PHP 的数组迭代最佳实践

尽管可以实现 myEach() 来模拟旧的 each() 行为，但在现代 PHP 开发中，通常有更优、更推荐的数组迭代方式：

1. foreach 循环：foreach 循环是 PHP 中遍历数组最常用且最推荐的方式。它简洁、高效，并且不需要手动管理数组内部指针。

   $data = ['name' => 'Alice', 'age' => 30, 'city' => 'New York'];
   
   echo "--- 使用 foreach 循环 ---" . PHP_EOL;
   foreach ($data as $key => $value) {
       echo "Key: " . $key . ", Value: " . $value . PHP_EOL;
   }

   登录后复制

2. Iterator 接口： 对于更复杂的迭代需求，例如需要自定义迭代逻辑、遍历对象或处理大型数据集，实现 Iterator 接口是更强大的选择。这允许对象像数组一样被 foreach 循环遍历。

   class MyIterator implements Iterator {
       private $position = 0;
       private $array = [];
   
       public function __construct(array $array) {
           $this->array = $array;
           $this->position = 0;
       }
   
       public function rewind(): void {
           $this->position = 0;
       }
   
       public function current(): mixed {
           return $this->array[array_keys($this->array)[$this->position]];
       }
   
       public function key(): mixed {
           return array_keys($this->array)[$this->position];
       }
   
       public function next(): void {
           ++$this->position;
       }
   
       public function valid(): bool {
           return isset(array_keys($this->array)[$this->position]);
       }
   }
   
   $data = ['name' => 'Alice', 'age' => 30];
   $iterator = new MyIterator($data);
   
   echo "--- 使用 Iterator 接口 ---" . PHP_EOL;
   foreach ($iterator as $key => $value) {
       echo "Key: " . $key . ", Value: " . $value . PHP_EOL;
   }

   登录后复制

总结

each() 函数的废弃是 PHP 语言发展的一部分，鼓励开发者采用更现代、更高效的迭代机制。在不得不模拟 each() 行为时，理解其精确的返回值结构至关重要，特别是对索引和关联键的正确映射。然而，对于新的开发项目和代码维护，强烈建议优先使用 foreach 循环或实现 Iterator 接口，以确保代码的健壮性、可读性和与未来 PHP 版本的兼容性。

以上就是理解并实现 PHP each() 函数的现代替代方案的详细内容，更多请关注php中文网其它相关文章！