PHP 中如何高效地对对象数组进行 JSON 编码并仅包含特定属性

本文将介绍如何使用 PHP 对包含对象的数组进行 JSON 编码，并仅保留每个对象的特定属性。通过 array_map 和 array_intersect_key 函数的组合，我们能够高效地筛选出需要的属性，避免使用循环，从而提高代码的性能和可读性。

在实际开发中，我们经常需要将 PHP 对象数组转换为 JSON 格式，以便于数据传输和处理。但有时，我们只需要对象中的一部分属性，而不是全部属性。手动循环遍历并删除不需要的属性效率较低，且代码可读性差。本文将介绍一种更优雅、更高效的方法来实现这个目标。

使用 array_map 和 array_intersect_key 函数

PHP 提供了 array_map 和 array_intersect_key 函数，可以帮助我们高效地完成这个任务。array_map 函数可以将一个回调函数应用到数组中的每个元素，而 array_intersect_key 函数则可以返回一个包含所有存在于第一个数组中且键名存在于所有其它参数数组中的键名的数组。

以下是一个示例代码：

<?php

$data = [
  (object)['key1' => 'aaa', 'key2' => 'bbb', 'key3' => 'ccc'],
  (object)['key1' => 'ddd', 'key2' => 'eee', 'key3' => 'fff'],
  (object)['key1' => 'ggg', 'key2' => 'hhh', 'key3' => 'iii']
];

// 定义允许的键名
$allowedKeys = ['key2', 'key3'];

// 使用 array_flip 将键名和值互换，以便 array_intersect_key 使用
$allowed = array_flip($allowedKeys);

$newData = array_map(
  function($item) use ($allowed) {
    // 将对象转换为数组，以便使用 array_intersect_key
    $itemArray = (array)$item;
    // 筛选出允许的键名
    $intersectedArray = array_intersect_key($itemArray, $allowed);
    // 将数组转换回对象
    return (object)$intersectedArray;
  },
  $data
);

echo json_encode($newData);

?>

代码解释：

1. $data: 这是一个包含 stdClass 对象的数组，每个对象都有 key1、key2 和 key3 属性。
2. $allowedKeys: 这是一个数组，包含我们希望保留的属性的键名，即 key2 和 key3。
3. $allowed = array_flip($allowedKeys): array_flip 函数将 $allowedKeys 数组的键和值进行交换。 这样做的目的是为了让 $allowed 数组的键是允许的键名，而值则无关紧要。 这使得它能够被 array_intersect_key 函数使用。
4. array_map(...): array_map 函数遍历 $data 数组中的每个元素，并将每个元素传递给匿名函数。
5. function($item) use ($allowed) { ... }: 这是一个匿名函数，它接受一个 $item (即 $data 数组中的一个对象) 作为参数，并使用 use 关键字从外部作用域导入 $allowed 变量。
6. $itemArray = (array)$item;: 将对象转换为数组，这样才能使用 array_intersect_key。
7. $intersectedArray = array_intersect_key($itemArray, $allowed);: array_intersect_key 函数接受 $itemArray 数组和 $allowed 数组作为参数。 它返回一个新的数组，其中只包含 $itemArray 中键名存在于 $allowed 数组中的元素。 换句话说，它只保留 $itemArray 中键名为 $key2 和 $key3 的元素。
8. return (object)$intersectedArray;: 将筛选后的数组转换回对象。
9. echo json_encode($newData);: 使用 json_encode 函数将处理后的 $newData 数组转换为 JSON 字符串并输出。

输出结果：

[{"key2":"bbb","key3":"ccc"},{"key2":"eee","key3":"fff"},{"key2":"hhh","key3":"iii"}]

注意事项：

• 如果对象中不存在 $allowedKeys 中指定的键，则该键不会出现在最终的 JSON 输出中。
• 此方法适用于对象数组。如果你的数据结构不同，可能需要进行适当的调整。
• 在处理大型数组时，使用 array_map 和 array_intersect_key 通常比手动循环更高效。

总结：

通过结合使用 array_map 和 array_intersect_key 函数，我们可以高效地对 PHP 对象数组进行 JSON 编码，并仅保留特定属性。这种方法不仅代码简洁易懂，而且性能优越，是处理类似问题的理想选择。 在实际应用中，可以根据具体需求调整 $allowedKeys 数组，以选择需要保留的属性。

php免费学习视频：立即学习
踏上前端学习之旅，开启通往精通之路！从前端基础到项目实战，循序渐进，一步一个脚印，迈向巅峰！