0

0

PHP对象转JSON时优雅移除空值字段的教程

心靈之曲

心靈之曲

发布时间:2025-09-21 12:06:01

|

860人浏览过

|

来源于php中文网

原创

php对象转json时优雅移除空值字段的教程

在PHP中将对象转换为JSON时,若需避免输出值为NULL的字段,可采用两种主要策略。对于结构简单的对象,可使用条件赋值逐个构建;而对于深度嵌套的对象,则推荐使用自定义递归过滤函数,结合json_encode和json_decode进行对象与数组间的转换,实现高效且灵活的字段清理,确保生成的JSON数据精简且符合需求。

引言:PHP对象转JSON时移除空值字段的需求

在Web开发中,我们经常需要将PHP数据结构(如对象或数组)转换为JSON格式,以便通过API接口传输给前端或其他服务。然而,有时数据源中某些字段可能为NULL,如果直接将这些字段包含在JSON输出中,可能会增加数据量,或导致前端解析逻辑复杂化。因此,一种常见的需求是,在生成JSON时,自动排除那些值为NULL的字段,使输出的JSON数据更加精简和有效。

本文将介绍两种在PHP中实现这一目标的方法:一种适用于结构简单的对象,另一种则更适用于处理深度嵌套的复杂对象。

方法一:条件赋值构建对象

对于结构相对扁平或嵌套层级不深的对象,最直接的方法是在构建对象时进行条件判断。只有当字段的值不为NULL时,才将其添加到最终的对象中。

示例代码:

立即学习PHP免费学习笔记(深入)”;

假设我们有以下数据:

输出结果:

{
    "Name": {
        "eng_name": "John Doe"
    },
    "Age": 30
}

优缺点分析:

  • 优点:
    • 逻辑直观,易于理解和实现。
    • 对于简单的对象结构,代码量适中。
    • 避免了额外的转换开销。
  • 缺点:
    • 当对象结构变得复杂,嵌套层级增多时,条件判断会散布在代码的各个部分,导致代码冗余且难以维护。
    • 不具备通用性,每次遇到新字段或新嵌套层级都需要手动添加判断。

方法二:递归过滤函数处理深度嵌套对象

当需要处理深度嵌套的对象,并且希望以更通用、更自动化的方式移除NULL字段时,可以编写一个递归过滤函数。这种方法通常涉及将stdClass对象转换为关联数组,进行过滤,然后再根据需要转换回对象或直接json_encode。

核心思想:

Anyword
Anyword

AI文案写作助手和文本生成器,具有可预测结果的文案 AI

下载
  1. 将stdClass对象转换为关联数组,因为数组更容易进行迭代和修改。
  2. 编写一个递归函数,遍历数组的每个元素。
  3. 如果元素是数组,则递归调用自身进行过滤。
  4. 如果元素的值为NULL(或任何其他需要过滤的“空”值),则跳过该字段。

arrayFilter 函数解析:

以下是一个自定义的递归过滤函数,它可以处理深度嵌套的数组(或从对象转换而来的数组),并移除值为“假” (falsy) 的字段(包括null、0、""、false等)。

 $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作为第二个参数)。

使用示例:

 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。

注意事项与最佳实践

  1. 明确过滤逻辑: 仔细考虑您希望过滤掉哪些值。是仅仅NULL,还是所有falsy值(0, "", false等)?根据需求调整过滤函数的条件。例如,如果只过滤NULL,可以将if(!$inputArr[$key]) continue;改为if($inputArr[$key] === null) continue;。
  2. 性能考量: 对于性能敏感的应用,如果数据量非常庞大,频繁进行json_encode和json_decode可能会带来额外开销。在这种情况下,可以考虑在数据生成阶段就避免NULL值,或者使用更底层的数组操作来减少转换次数。
  3. API设计一致性: 无论选择哪种方法,都应确保您的API在处理空值时保持一致的行为。清晰地在API文档中说明,NULL字段是否会被省略,这有助于前端或其他服务正确消费您的数据。
  4. PHP 8+ 的新特性: PHP 8引入了Nullsafe运算符?->和属性提升等特性,虽然它们不能直接用于过滤已存在的NULL字段,但可以在构建对象时以更简洁的方式处理可能为NULL的链式调用。

总结

在PHP中将对象转换为JSON时,根据具体场景选择合适的NULL字段移除策略至关重要。对于简单的对象,条件赋值法直接有效;而对于深度嵌套的复杂对象,自定义递归过滤函数结合JSON编解码转换则提供了更强大、更通用的解决方案。理解两种方法的优缺点,并结合实际需求调整过滤逻辑,将帮助您生成更精简、更符合规范的JSON数据。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2706

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1667

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1527

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

974

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1444

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1235

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1529

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1307

2023.11.13

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 9万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号