PHP array_walk 引用外部变量技巧

理解 array_walk 的参数传递机制

array_walk() 函数是 PHP 中一个强大的数组迭代工具，它将用户自定义的函数应用于数组中的每个元素。其函数签名如下：

array_walk(array|object &$array, callable $callback, mixed $arg = null): bool

1. &$array (第一个参数)： 这是要遍历的数组或对象。请注意，这里的 & 符号表示 array_walk 函数接收这个数组的引用。这意味着如果回调函数修改了数组的元素（通过其第一个参数），这些修改会直接反映在原始数组上。
2. $callback (第二个参数)： 这是要在每个数组元素上执行的回调函数。这个回调函数通常接收两个或三个参数：
   • $value：当前数组元素的值。如果回调函数希望修改原始数组元素，这个参数需要声明为引用（&$value）。
   • $key：当前数组元素的键。
   • $userdata：可选的第三个参数，对应于 array_walk 函数的第三个参数 $arg。
3. $arg (第三个参数)： 这是一个可选的混合类型参数，它会被传递给回调函数作为其第三个参数。关键点在于，array_walk 会将 $arg 的值复制一份传递给回调函数，这意味着它在回调函数内部是按值传递的。

问题重现与分析

许多开发者在使用 array_walk 时，会遇到一个常见的问题：如何将一个外部变量通过引用传递给回调函数，以便在回调中修改它。考虑以下代码示例：

 ['Golden Delicious', 'Granny Smith','Fuji'],
    'Oranges' => ['Valencia', 'Navel', 'Jaffa']
];
$fruits = []; // 外部变量，希望在回调中填充

// 尝试直接将 $fruits 作为第三个参数传递给 array_walk
array_walk($inventory, 'fruitTypes', $fruits);

function fruitTypes($value, $key, &$fruits) { // 回调函数期望 $fruits 按引用传递
    $fruits[] = $key;
}
?>

运行上述代码，你会收到一个警告：

Warning: fruitTypes(): Argument #3 ($fruits) must be passed by reference, value given

这个警告清晰地指出，fruitTypes 函数的第三个参数 $fruits 期望以引用方式接收，但 array_walk 却以值传递的方式提供了它。这验证了我们前面提到的 array_walk 的第三个参数 $arg 是按值传递给回调函数的。

一些开发者可能会尝试在调用 array_walk 时，将 $fruits 变量加上引用符号 &：

// 错误的尝试：在调用 array_walk 时使用引用符号
array_walk($inventory, 'fruitTypes', &$fruits);

然而，这会导致一个 Parse error：

Parse error: syntax error, unexpected token "&", expecting ")"

这是因为在函数调用中，除了通过引用传递给函数参数（如 array_walk 的第一个参数 &$array）外，PHP 不允许对字面量或变量直接使用 & 符号来强制其按引用传递。array_walk 的第三个参数 $arg 本身就不是设计为直接接收引用的。

解决方案：使用闭包和 use 关键字

在 PHP 中，解决回调函数中引用外部变量的最佳实践是使用匿名函数（也称为闭包）结合 use 关键字。use 关键字允许闭包从其定义的作用域中“捕获”一个或多个外部变量，并且可以指定这些变量是按值捕获还是按引用捕获。

以下是使用闭包解决上述问题的正确方法：

 ['Golden Delicious', 'Granny Smith','Fuji'],
    'Oranges' => ['Valencia', 'Navel', 'Jaffa']
];
$fruits = []; // 外部变量，需要被回调函数修改

// 使用匿名函数和 use 关键字将 $fruits 传递给回调函数并允许引用修改
array_walk($inventory, function($value, $key) use (&$fruits) {
    // 在这里，$fruits 是通过引用从外部作用域捕获的，因此对其的修改会影响外部的 $fruits 变量
    $fruits[] = $key;
});

echo "收集到的水果类型键名：\n";
print_r($fruits);

// 另一个示例：修改数组元素本身
$numbers = [1, 2, 3];
array_walk($numbers, function(&$item, $key) {
    // $item 是 array_walk 回调的第一个参数，可以声明为引用以直接修改原始数组元素
    $item *= 2;
});
echo "\n双倍后的数字：\n";
print_r($numbers);
?>

输出结果：

收集到的水果类型键名：
Array
(
    [0] => Apples
    [1] => Oranges
)

双倍后的数字：
Array
(
    [0] => 2
    [1] => 4
    [2] => 6
)

在这个示例中：

• 我们定义了一个匿名函数作为 array_walk 的回调。
• use (&$fruits) 语句告诉 PHP，这个匿名函数需要访问其外部作用域中的 $fruits 变量，并且是以引用方式访问。这意味着在闭包内部对 $fruits 的任何修改都会直接作用于外部的 $fruits 变量。
• 这种方法清晰、安全，并且符合 PHP 现代编程的最佳实践。

注意事项

• 回调函数第一个参数的引用： array_walk 的回调函数第一个参数 ($value) 可以声明为引用 (&$value)，这样可以直接修改原始数组的元素。这与通过 use 捕获外部变量是不同的概念。
• array_walk 第三个参数 $arg 的用途： array_walk 的第三个参数 $arg 主要用于向回调函数传递一些额外的数据或配置信息，这些信息通常是只读的。如果需要修改外部变量，应优先考虑使用闭包和 use 关键字。
• 可读性和维护性： 使用闭包和 use 关键字可以使代码意图更明确，提高代码的可读性和可维护性，避免了传统函数回调中全局变量或复杂参数传递带来的问题。

总结

当需要在 array_walk 的回调函数中修改一个外部变量时，直接将该变量作为 array_walk 的第三个参数并期望其在回调中按引用传递是行不通的。正确的解决方案是利用 PHP 的匿名函数（闭包）和 use 关键字，以引用方式捕获外部变量。这种方法不仅解决了引用传递的问题，也使代码更加现代化和易于理解。