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。

核心思想:

Cursor
Cursor

一个新的IDE,使用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数据。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

420

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

536

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

312

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

237

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

458

2024.03.01

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1503

2023.10.24

Go语言中的运算符有哪些
Go语言中的运算符有哪些

Go语言中的运算符有:1、加法运算符;2、减法运算符;3、乘法运算符;4、除法运算符;5、取余运算符;6、比较运算符;7、位运算符;8、按位与运算符;9、按位或运算符;10、按位异或运算符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

233

2024.02.23

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

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

共137课时 | 10.4万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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