深入理解PHP函数返回引用机制及其应用-php教程-PHP中文网

深入理解php函数返回引用机制及其应用

本文探讨了如何在PHP中实现类似JavaScript `Array.prototype.find()` 功能，但返回的是对原始数组元素的引用，而非其值。通过将嵌套数组转换为对象结构，并结合PHP的引用返回机制（`function &`）和引用赋值（`= &`），可以直接修改找到的元素。文章还提供了详细的代码示例，并讨论了使用引用的注意事项及更安全的替代方案，旨在帮助开发者更灵活地操作复杂数据结构。

引言：PHP中查找并修改数组元素的挑战

在PHP开发中，我们经常需要从复杂的多维数组中查找特定元素，并对其进行修改。当仅仅返回查找到的元素值时，对该值的修改并不会影响到原始数组。这与JavaScript中通过 Array.prototype.find() 返回对象引用（可以修改原对象）的行为有所不同。本文将深入探讨如何在PHP中实现类似的功能，即通过一个查找函数返回对原始数组元素的引用，从而允许直接修改。

考虑以下数据结构：

$array = [
    ["id" => 54, "type" => 5, "content" => [
        ["id" => 99, "type" => 516],
        ["id" => 88, "type" => 464],
        ["id" => 41, "type" => 845]]
    ],
    ["id" => 54, "type" => 55, "content"=> [
        ["id" => 54, "type" => 578],
        ["id" => 54, "type" => 354],
        ["id" => 75, "type" => 458]]
    ],
    ["id" => 65, "type" => 59, "content" => [
        ["id" => 87, "type" => 5454],
        ["id" => 65, "type" => 245],
        ["id" => 65, "type" => 24525]]
    ]
];

登录后复制

如果我们编写一个简单的查找函数，例如：

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

function array_find_value($array, $function){
    foreach($array as $value){
        if($function($value)){
            return $value; // 返回的是值的副本
        }
    }
    return null; // 未找到返回null
}

$id_to_find = 54;
$type_to_find = 55;
$found_item = array_find_value(
    $array,
    function($foo) use ($id_to_find, $type_to_find) {
        return $foo["id"] == $id_to_find && $foo["type"] == $type_to_find;
    }
);

// 此时修改 $found_item 不会影响 $array
if ($found_item) {
    $found_item['content'] = 'new content';
}
// var_export($array); // 原始数组未变

登录后复制

上述代码中，array_find_value 返回的是找到元素的副本。对 $found_item 的任何修改都不会反映到原始 $array 中。为了实现对原始数据的直接修改，我们需要利用PHP的引用机制。

PHP中的引用机制与返回引用

PHP中的引用（Reference）是一种允许用不同的变量名访问同一个内存内容的方式。这意味着，当一个变量是另一个变量的引用时，它们都指向相同的数据。对其中一个变量的修改会影响到另一个变量。

要使一个函数返回引用，需要遵循以下两个关键步骤：

函数声明时使用 & 符号： 在函数名前加上 &，表示该函数将返回一个引用。
接收返回值时使用 & 符号： 在将函数返回值赋给变量时，也需要使用 & 符号，以确保接收到的是引用，而不是值的副本。

此外，为了能够直接修改复杂数据结构内部的元素（如数组中的子数组或对象属性），将数组中的每个元素转换为对象（stdClass）通常会更方便和直观，因为PHP对对象引用的处理更为直接。

实现返回引用的查找函数

结合上述原理，我们可以改造原有的查找函数，使其返回引用。

百度智能云·曦灵

百度旗下的AI数字人平台

102

查看详情

1. 数据结构调整

首先，将原始数组中的每个子数组转换为对象。这可以通过在创建数组时使用 (object) 类型转换实现。

$array_of_objects = [
    (object)[
        "id" => 54,
        "type" => 5,
        "content" => [
            ["id" => 99, "type" => 516],
            ["id" => 88, "type" => 464],
            ["id" => 41, "type" => 845]
        ]
    ],
    (object)[
        "id" => 54,
        "type" => 55,
        "content" => [
            ["id" => 54, "type" => 578],
            ["id" => 54, "type" => 354],
            ["id" => 75, "type" => 458]
        ]
    ],
    (object)[
        "id" => 65,
        "type" => 59,
        "content" => [
            ["id" => 87, "type" => 5454],
            ["id" => 65, "type" => 245],
            ["id" => 65, "type" => 24525]
        ]
    ]
];

登录后复制

2. 编写返回引用的查找函数

接下来，创建 &getRowReference 函数。注意函数声明前的 & 符号。

/**
 * 从对象数组中查找符合条件的行，并返回该行的指定属性的引用。
 *
 * @param array $array 对象数组
 * @param callable $fn 用于判断的匿名函数或函数名
 * @return mixed 对符合条件行的指定属性的引用，未找到则返回 null。
 */
function &getRowReference(array &$array, callable $fn) {
    foreach ($array as &$row) { // 注意这里也需要使用 &，确保 $row 是对原数组元素的引用
        if ($fn($row)) {
            // 返回 $row->content 的引用
            // 如果需要返回整个 $row 的引用，直接 return $row;
            return $row->content;
        }
    }
    // 如果没有找到匹配的行，则返回 null。
    // 注意：返回 null 引用在PHP中是合法的，但接收时需谨慎。
    $null_ref = null;
    return $null_ref;
}

// 定义一个辅助函数用于条件判断
function qualifyingRow($row) {
    global $id_to_find;
    global $type_to_find;
    return $row->id == $id_to_find && $row->type == $type_to_find;
}

// 设置查找条件
$id_to_find = 54;
$type_to_find = 55;

// 调用函数并接收引用
// 确保在赋值时也使用 & 符号
$ref_to_content = &getRowReference($array_of_objects, 'qualifyingRow');

// 现在，可以通过 $ref_to_content 直接修改原始数组中的 'content' 属性
if ($ref_to_content !== null) {
    $ref_to_content = 'This content has been changed directly via reference.';
    // 也可以对数组进行操作，例如：
    // $ref_to_content[] = ["new_item" => true];
}

// 验证原始数组是否已被修改
var_export($array_of_objects);

登录后复制

代码解释：

function &getRowReference(array &$array, callable $fn): 函数声明前的 & 表示它将返回一个引用。参数 $array 前的 & 确保在 foreach 循环中 $row 也是对原始数组元素的引用，这样才能返回其内部属性的引用。
foreach ($array as &$row): 这里的 &$row 至关重要，它使得 $row 成为 $array 中当前元素的引用。如果没有这个 &，$row 将只是一个副本，返回其属性的引用将是无效的。
return $row->content;: 返回 $row 对象中 content 属性的引用。
$ref_to_content = &getRowReference(...): 在接收函数返回值时，必须使用 = 配合 & 来进行引用赋值。

运行上述代码，你会发现 $array_of_objects 中匹配的元素的 content 属性已经被成功修改。

注意事项与替代方案

虽然返回引用在某些场景下提供了极大的便利性，但它也伴随着一些潜在的复杂性和风险。

1. 使用引用的注意事项

理解引用的生命周期： 返回的引用必须指向一个在函数调用结束后仍然存在的变量。如果返回局部变量的引用，那么该引用将指向一个已不存在的内存区域，导致未定义行为。在我们的例子中，$row 是对传入 $array 元素的引用，而 $array 在函数外部定义，因此是安全的。
增加代码复杂性： 引用使得数据流向变得不那么直观，可能增加代码的理解难度和调试成本。
意外的副作用： 多个引用指向同一数据，可能导致在代码的不同部分无意中修改了共享数据，产生难以追踪的bug。
性能考量： 对于简单的数据类型，传递值通常比传递引用更快，因为引用需要额外的内存来存储引用本身。但对于大型数据结构，传递引用可以避免复制，从而提高性能。

2. 更安全的替代方案：返回索引

在许多情况下，更推荐和更安全的做法是让查找函数返回匹配元素的索引，而不是直接返回引用。然后，可以使用这个索引来访问和修改原始数组中的元素。

/**
 * 从数组中查找符合条件的行，并返回该行的索引。
 *
 * @param array $array 数组
 * @param callable $fn 用于判断的匿名函数或函数名
 * @return int|null 匹配行的索引，未找到则返回 null。
 */
function find_index(array $array, callable $fn): ?int {
    foreach ($array as $index => $value) {
        if ($fn($value)) {
            return $index;
        }
    }
    return null;
}

// 使用原始的数组结构
$original_array = [
    ["id" => 54, "type" => 5, "content" => [/* ... */]],
    ["id" => 54, "type" => 55, "content"=> [/* ... */]],
    ["id" => 65, "type" => 59, "content" => [/* ... */]]
];

$id_to_find_idx = 54;
$type_to_find_idx = 55;

$found_index = find_index(
    $original_array,
    function($foo) use ($id_to_find_idx, $type_to_find_idx) {
        return $foo["id"] == $id_to_find_idx && $foo["type"] == $type_to_find_idx;
    }
);

// 通过索引修改原始数组
if ($found_index !== null) {
    $original_array[$found_index]['content'] = 'This content was changed via index.';
}

var_export($original_array);

登录后复制

这种方法避免了引用的复杂性，使得代码更易于理解和维护，同时也能达到修改原始数据的目的。对于对象数组，返回索引同样适用，然后通过 $array_of_objects[$found_index]->content 进行修改。