引言：PHP对象转JSON时移除空值字段的需求
在Web开发中，我们经常需要将PHP数据结构（如对象或数组）转换为JSON格式，以便通过API接口传输给前端或其他服务。然而，有时数据源中某些字段可能为NULL，如果直接将这些字段包含在JSON输出中，可能会增加数据量，或导致前端解析逻辑复杂化。因此，一种常见的需求是，在生成JSON时，自动排除那些值为NULL的字段，使输出的JSON数据更加精简和有效。
本文将介绍两种在PHP中实现这一目标的方法：一种适用于结构简单的对象，另一种则更适用于处理深度嵌套的复杂对象。
方法一：条件赋值构建对象
对于结构相对扁平或嵌套层级不深的对象，最直接的方法是在构建对象时进行条件判断。只有当字段的值不为NULL时，才将其添加到最终的对象中。
示例代码：
立即学习“PHP免费学习笔记（深入）”；
假设我们有以下数据：
<?php
// 模拟从数据库获取的数据
$id_info = null; // 假设id_info为NULL
$name_info = 'John Doe';
$age_info = 30;
$email_info = null; // 假设email_info为NULL
// 初始化一个用于构建对象的数组
$obj_data = [];
// 条件判断并添加字段
if ($id_info !== null) {
$obj_data["id"] = strval($id_info);
}
// 嵌套对象也采用类似方式
$name_obj_data = [];
if ($name_info !== null) {
$name_obj_data["eng_name"] = strval($name_info);
}
// 将嵌套对象添加到主对象中，即使为空也可能需要保留键名，或者也进行条件判断
if (!empty($name_obj_data)) {
$obj_data["Name"] = (object) $name_obj_data;
}
if ($age_info !== null) {
$obj_data["Age"] = $age_info;
}
if ($email_info !== null) {
$obj_data["Email"] = $email_info;
}
// 将数组转换为标准对象
$obj = (object) $obj_data;
echo json_encode($obj, JSON_PRETTY_PRINT);
?>输出结果：
{
"Name": {
"eng_name": "John Doe"
},
"Age": 30
}优缺点分析：
-
优点：
- 逻辑直观，易于理解和实现。
- 对于简单的对象结构，代码量适中。
- 避免了额外的转换开销。
-
缺点：
- 当对象结构变得复杂，嵌套层级增多时，条件判断会散布在代码的各个部分，导致代码冗余且难以维护。
- 不具备通用性，每次遇到新字段或新嵌套层级都需要手动添加判断。
方法二：递归过滤函数处理深度嵌套对象
当需要处理深度嵌套的对象，并且希望以更通用、更自动化的方式移除NULL字段时，可以编写一个递归过滤函数。这种方法通常涉及将stdClass对象转换为关联数组，进行过滤，然后再根据需要转换回对象或直接json_encode。
核心思想：
- 将stdClass对象转换为关联数组，因为数组更容易进行迭代和修改。
- 编写一个递归函数，遍历数组的每个元素。
- 如果元素是数组，则递归调用自身进行过滤。
- 如果元素的值为NULL（或任何其他需要过滤的“空”值），则跳过该字段。
arrayFilter 函数解析：
以下是一个自定义的递归过滤函数，它可以处理深度嵌套的数组（或从对象转换而来的数组），并移除值为“假” (falsy) 的字段（包括null、0、""、false等）。
<?php
function arrayFilter($inputArr){
$output = null; // 初始化输出，如果输入为空，则输出也为空
if (is_array($inputArr)){
foreach ($inputArr as $key => $val){
// 检查当前键的值是否为“假”（null, 0, "", false等）
// 如果是，则跳过此字段，不将其添加到输出中
if(!$inputArr[$key]) {
continue;
}
// 如果当前值是一个数组，则递归调用自身进行过滤
if (is_array($val)) {
$tmpArr = arrayFilter($val);
// 只有当递归过滤后的子数组不为空时，才将其添加到输出中
if($tmpArr) {
$output[$key] = $tmpArr; // 注意这里直接赋值$tmpArr，而不是array_filter($tmpArr)
}
}
// 如果当前值不是数组（即标量值），且不为“假”，则直接添加到输出中
else {
$output[$key] = $val;
}
}
}
// 注意：原始函数中此处的else分支逻辑可能不符合预期，
// 对于非数组的$inputArr，通常不应有$key和$val的概念，
// 且直接返回$output[$key] = $val; 可能会导致错误。
// 在本教程中，我们假设$inputArr总是数组，或者在外部处理非数组情况。
// 如果$inputArr本身不是数组，我们直接返回它本身（如果非空）
else {
return $inputArr; // 对于非数组输入，如果非空则返回自身
}
return $output;
}
?>stdClass 对象转换为数组：
由于arrayFilter函数期望接收一个数组，因此我们需要将PHP的stdClass对象转换为关联数组。最简便且可靠的方法是先json_encode将其序列化为JSON字符串，然后再json_decode将其反序列化为关联数组（通过传递true作为第二个参数）。
使用示例：
<?php
// 假设有一个深度嵌套的stdClass对象
$obj = (object) [
"id" => null,
"Name" => (object) [
"eng_name" => strval('some name2'),
"de_name" => null,
"more" => (object) [
"fr_name" => strval('some name3'),
"ru_name" => null,
"extra_info" => "" // 也会被过滤掉，因为是falsy
]
],
"status" => 0, // 也会被过滤掉，因为是falsy
"isActive" => false, // 也会被过滤掉，因为是falsy
"description" => "A valid description"
];
// 1. 将stdClass对象转换为关联数组
$array_obj = json_decode(json_encode($obj), true);
// 2. 使用自定义函数过滤数组
$filtered_array = arrayFilter($array_obj);
// 3. 将过滤后的数组转换回JSON字符串
echo json_encode($filtered_array, JSON_PRETTY_PRINT);
?>输出结果：
{
"Name": {
"eng_name": "some name2",
"more": {
"fr_name": "some name3"
}
},
"description": "A valid description"
}优缺点分析：
-
优点：
- 通用性强： 能够处理任意深度嵌套的对象结构。
- 代码整洁： 过滤逻辑集中在一个函数中，易于维护和复用。
- 自动化： 无需手动为每个字段编写条件判断。
-
缺点：
- 性能开销： 涉及两次JSON编解码操作，对于非常大的数据结构可能会有轻微的性能损耗。
- 过滤范围： arrayFilter函数中的!$inputArr[$key]会过滤所有“假”值（null, 0, "", false），如果只希望过滤null，则需要修改判断条件为$inputArr[$key] === null。
注意事项与最佳实践
- 明确过滤逻辑： 仔细考虑您希望过滤掉哪些值。是仅仅NULL，还是所有falsy值（0, "", false等）？根据需求调整过滤函数的条件。例如，如果只过滤NULL，可以将if(!$inputArr[$key]) continue;改为if($inputArr[$key] === null) continue;。
- 性能考量： 对于性能敏感的应用，如果数据量非常庞大，频繁进行json_encode和json_decode可能会带来额外开销。在这种情况下，可以考虑在数据生成阶段就避免NULL值，或者使用更底层的数组操作来减少转换次数。
- API设计一致性： 无论选择哪种方法，都应确保您的API在处理空值时保持一致的行为。清晰地在API文档中说明，NULL字段是否会被省略，这有助于前端或其他服务正确消费您的数据。
- PHP 8+ 的新特性： PHP 8引入了Nullsafe运算符?->和属性提升等特性，虽然它们不能直接用于过滤已存在的NULL字段，但可以在构建对象时以更简洁的方式处理可能为NULL的链式调用。
总结
在PHP中将对象转换为JSON时，根据具体场景选择合适的NULL字段移除策略至关重要。对于简单的对象，条件赋值法直接有效；而对于深度嵌套的复杂对象，自定义递归过滤函数结合JSON编解码转换则提供了更强大、更通用的解决方案。理解两种方法的优缺点，并结合实际需求调整过滤逻辑，将帮助您生成更精简、更符合规范的JSON数据。
