
本文旨在解决PHP开发中,将对象转换为JSON时,如何避免输出值为NULL的字段。我们将探讨两种主要方法:对于简单对象,可以通过条件判断来动态构建;对于包含深层嵌套结构的复杂对象,则推荐使用自定义递归过滤函数,结合json_encode和json_decode进行数组转换后处理,以确保最终生成的JSON数据更加精简和有效,提升数据传输效率和可读性。
问题背景:PHP对象中的NULL值
在php应用中,我们经常需要将数据封装成对象,然后通过json_encode函数将其序列化为json格式进行传输或存储。然而,如果对象中的某些属性值在业务逻辑中可能为null,这些null值在json输出中通常会以”key”: null的形式呈现。虽然这在技术上是合法的json,但在某些场景下,我们可能希望完全省略这些null字段,以减小json负载、提高可读性,或满足特定的api接口规范。
例如,以下PHP代码:
<?php
$id_info = null; // 假设查询结果为NULL
$name_info = 'John Doe';
$obj = (object) [
"id" => strval($id_info), // strval(null) 会变成空字符串 ""
"Name" => (object) [
"eng_name" => strval($name_info)
]
];
echo json_encode($obj);
?>
会输出:
{"id":"","Name":{"eng_name":"John Doe"}}
注意,这里strval(null)导致id字段变为””(空字符串),而不是null。如果直接赋值$id_info为null,则会输出”id”:null。我们的目标是,无论NULL还是””(在某些语境下可能也被视为需要省略的空值),都能被有效地移除。
方法一:简单对象的条件式构建
对于结构相对简单、嵌套层级不深的对象,最直接的方法是在构建对象时进行条件判断。只有当属性值非NULL(或非空)时,才将其添加到对象中。
立即学习“PHP免费学习笔记(深入)”;
<?php
$id_info = ($db->query("SomeSQL query")->fetch_assoc())['id'] ?? null; // 使用null合并运算符处理查询结果
$name_info = 'John Doe';
$age_info = null; // 假设年龄信息为NULL
$data = []; // 使用关联数组构建更灵活
if ($id_info !== null) {
$data["id"] = strval($id_info);
}
// 嵌套对象也可以通过类似方式处理
$name_data = [];
if ($name_info !== null) {
$name_data["eng_name"] = strval($name_info);
}
// 如果Name对象本身可能为空,可以再加一层判断
if (!empty($name_data)) {
$data["Name"] = (object) $name_data;
}
if ($age_info !== null) {
$data["Age"] = $age_info;
}
$obj = (object) $data; // 将数组转换为对象
echo json_encode($obj);
?>
如果$id_info为NULL,则最终JSON输出中将不包含”id”字段。这种方法清晰直观,适用于对象属性数量有限且层级不深的场景。
方法二:针对嵌套结构的递归过滤
当PHP对象包含深层嵌套结构时,手动进行条件判断会变得非常繁琐且容易出错。此时,更优雅的解决方案是先将整个对象转换为数组,然后使用一个递归函数对数组进行过滤,最后再将过滤后的数组编码为JSON。
自定义递归过滤函数 arrayFilter
我们可以编写一个通用的递归函数来遍历数组(或从对象转换而来的数组),并移除其中值为“假值”(false, null, 0, “”, []等)的元素。
<?php
/**
* 递归过滤数组中的“假值”元素。
* 如果元素为数组,则递归过滤其内部元素。
* 如果元素为非空数组,则保留。
* 如果元素为非“假值”的非数组,则保留。
*
* @param array|object $inputData 输入数据,可以是数组或StdClass对象
* @return array|null 过滤后的数组,如果整个输入数据被过滤为空,则返回null
*/
function arrayFilter($inputData) {
$output = [];
// 如果是对象,先转换为数组处理
if (is_object($inputData)) {
$inputData = (array) $inputData;
}
if (is_array($inputData)) {
foreach ($inputData as $key => $val) {
// 注意:这里是过滤“假值” (falsy values),包括 null, 0, false, "", []
// 如果你只想过滤 null,应使用 is_null($val)
if (!$val && !is_numeric($val) && $val !== false) { // 改进条件,确保0和false不会被错误过滤
continue;
}
if (is_array($val) || is_object($val)) {
$tmpArr = arrayFilter($val); // 递归调用
if (!empty($tmpArr)) { // 如果子数组过滤后不为空,则保留
$output[$key] = $tmpArr;
}
} else {
$output[$key] = $val;
}
}
}
return empty($output) ? null : $output; // 如果过滤后为空,返回null
}
?>
使用示例
假设我们有以下一个深层嵌套的PHP对象,其中包含多个NULL值:
<?php
$obj = (object) [
"id" => null,
"Name" => (object) [
"eng_name" => 'some name2',
"de_name" => null,
"more" => (object) [
"fr_name" => 'some name3',
"ru_name" => null,
"empty_arr" => [],
"zero_val" => 0 // 假设0也需要保留
]
],
"address" => null,
"isActive" => false // 假设false也需要保留
];
// 1. 将StdClass对象转换为关联数组
// json_encode -> json_decode(..., true) 是一个将StdClass对象深度转换为关联数组的常用技巧
$arrayObj = json_decode(json_encode($obj), true);
// 2. 使用自定义函数过滤数组
$filteredArray = arrayFilter($arrayObj);
// 3. 将过滤后的数组编码为JSON
echo json_encode($filteredArray, JSON_PRETTY_PRINT);
?>
输出结果:
{
"Name": {
"eng_name": "some name2",
"more": {
"fr_name": "some name3",
"zero_val": 0
}
},
"isActive": false
}
从输出可以看出,id、de_name、ru_name、empty_arr和address等NULL或空值字段都被成功移除了。zero_val和isActive被保留了下来,因为arrayFilter的改进条件确保了0和false不会被误过滤。
arrayFilter 函数的行为与注意事项
- 过滤逻辑: 提供的arrayFilter函数默认过滤的是PHP中的“假值”(falsy值),包括NULL、空字符串””、整数0、浮点数0.0、布尔值false以及空数组[]。在改进后的版本中,通过!$val && !is_numeric($val) && $val !== false条件,我们尝试避免过滤数字0和布尔值false,使其更符合通常的“只移除NULL或空值”的需求。
-
精确过滤NULL: 如果你的需求是严格只过滤NULL值,而不包括0、false或空字符串,你需要修改过滤条件:
// 在arrayFilter函数内部,将 // if (!$val && !is_numeric($val) && $val !== false) { // 替换为: if (is_null($val)) { continue; }登录后复制这样修改后,0、false、””等非NULL的假值都会被保留。
- 性能考量: 对于非常庞大或嵌套极深的对象,json_encode和json_decode的转换以及递归过滤可能会带来一定的性能开销。但在大多数Web应用场景中,这种开销通常可以接受。
- 数据类型转换: json_decode(json_encode($obj), true)是确保对象深度转换为关联数组的关键步骤。直接将StdClass对象强制转换为数组((array) $obj)只会转换第一层属性,嵌套的对象仍会保持为StdClass。
总结与最佳实践
选择哪种方法取决于你的具体需求和对象的复杂程度:
- 简单对象或少量字段: 推荐使用条件式构建。代码直观易懂,没有额外的函数调用开销。
- 复杂嵌套对象: 强烈推荐使用递归过滤函数。它能提供一个通用且可维护的解决方案,避免了大量重复的条件判断逻辑。
无论采用哪种方法,目标都是生成更精简、更符合业务需求的JSON数据,从而优化数据传输和提升应用性能。在实际开发中,根据项目的具体情况和对“空值”的定义(是仅NULL还是所有falsy值),灵活调整过滤逻辑至关重要。
以上就是PHP对象中动态过滤NULL值字段以优化JSON输出的详细内容,更多请关注php中文网其它相关文章!


