PHP对象JSON序列化过滤NULL字段方法

引言：PHP对象JSON序列化中的NULL值问题

在PHP应用程序中，我们经常需要将业务数据封装成对象，然后通过json_encode()函数将其序列化为JSON字符串，供前端或其他服务消费。然而，当对象中的某些属性值为NULL时，json_encode()默认会将这些NULL值字段一并输出到JSON中。例如：

 $id_info,
    "Name" => (object) [
        "eng_name" => $name_info
    ]
];

echo json_encode($obj, JSON_PRETTY_PRINT);
?>

上述代码的输出将是：

{
    "id": null,
    "Name": {
        "eng_name": "John Doe"
    }
}

可以看到，即使id为NULL，它仍然作为"id": null出现在JSON中。在某些场景下，我们希望这些NULL字段不被输出，以使JSON数据更精简。

方法一：构建对象时的条件判断

对于结构相对简单、层级不深的PHP对象，最直接的方法是在构建对象时，对每个属性进行条件判断。只有当属性值非NULL时，才将其添加到对象中。

query("SELECT id FROM some_table WHERE condition LIMIT 1");
$id_info = $result ? ($result->fetch_assoc()['id'] ?? null) : null;

$name_info = "John Doe"; // 假设 $name_info 总是存在

// 构建对象时进行条件判断
$obj = (object) [];

if ($id_info !== null) {
    $obj->id = strval($id_info);
}

// 嵌套对象也需要类似处理
$nameObj = (object) [];
if ($name_info !== null) {
    $nameObj->eng_name = strval($name_info);
}
if (!empty((array)$nameObj)) { // 只有当nameObj不为空时才添加
    $obj->Name = $nameObj;
}

echo json_encode($obj, JSON_PRETTY_PRINT);
?>

通过这种方式，如果$id_info为NULL，则id属性不会被添加到$obj中，最终的JSON输出将不包含"id": null。

方法二：递归过滤复杂嵌套结构

当PHP对象结构复杂，包含多层嵌套时，手动进行条件判断会变得非常繁琐且容易出错。此时，更优雅的解决方案是利用递归函数对整个对象（或转换为数组后）进行深度过滤。

这种方法的核心步骤是：

1. 将PHP的stdClass对象转换为关联数组。
2. 编写一个递归函数，遍历数组，移除所有值为NULL的键值对。
3. 将过滤后的数组再次编码为JSON。

将stdClass对象转换为关联数组的常用技巧是先json_encode再json_decode：

$array_form = json_decode(json_encode($obj), true);

接下来，我们定义一个自定义的递归过滤函数：

自定义递归过滤函数 arrayFilter

这个函数能够深度遍历多维数组，并移除其中值为NULL的元素。

 $val) {
            // 如果值为null，则跳过不添加到输出
            if ($val === null) {
                continue;
            }

            if (is_array($val)) {
                // 如果是数组，则递归调用自身进行过滤
                $tmpArr = arrayFilter($val);
                // 如果递归过滤后的子数组不为空，则添加到输出
                if ($tmpArr !== null && !empty($tmpArr)) { // 确保不是null且不是空数组
                    $output[$key] = $tmpArr;
                }
            } else {
                // 非数组且非null的值直接添加到输出
                $output[$key] = $val;
            }
        }
    }
    // 如果过滤后的输出数组为空，则返回null，否则返回过滤后的数组
    return empty($output) ? null : $output;
}

// 示例：一个深度嵌套的PHP对象
$obj = (object) [
    "id" => null,
    "Name" => (object) [
        "eng_name" => strval('some name2'),
        "de_name" => null,
        "more" => (object) [
            "fr_name" => strval('some name3'),
            "ru_name" => null,
            "empty_section" => (object)[] // 示例：空对象
        ]
    ],
    "address" => null,
    "contact" => (object)[] // 示例：空对象
];

// 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);

?>

示例输出

经过上述过滤处理后，echo json_encode($filtered_array, JSON_PRETTY_PRINT); 将生成以下JSON输出：

{
    "Name": {
        "eng_name": "some name2",
        "more": {
            "fr_name": "some name3"
        }
    }
}

可以看到，所有值为NULL的字段（如id、de_name、ru_name、address），以及过滤后为空的嵌套对象（如empty_section和contact），都已从最终的JSON输出中移除，生成了更加简洁和符合预期的JSON结构。

注意事项与最佳实践

1. 性能考量：对于非常庞大或深度极高的对象/数组，递归操作可能会带来一定的性能开销。在性能敏感的场景下，需要权衡其带来的便利性与潜在的性能影响。
2. 数据类型转换：json_decode(json_encode($obj), true) 是将stdClass对象转换为关联数组的常用且有效方法。需要注意的是，json_decode的第二个参数true至关重要，它确保了返回的是关联数组而不是stdClass对象。
3. 空数组/空对象处理：上述arrayFilter函数在递归处理时，如果子数组经过过滤后变为空数组，也会将其从父数组中移除。这有助于进一步精简JSON结构，避免出现"key": {}这样的空对象。
4. PHP内置函数array_filter：array_filter()函数可以过滤数组中的空值，但它默认只处理数组的第一层。如果需要深度过滤，则必须结合array_walk_recursive()或如本文所示的自定义递归函数。
5. JsonSerializable接口：对于更复杂的自定义类，可以考虑实现JsonSerializable接口。这允许类自定义其在json_encode()时的序列化行为，从而在类内部控制哪些属性被输出，哪些被忽略。但这种方法通常用于更高级的场景，且需要对每个类进行定制。

总结

在PHP中处理对象到JSON的序列化时，有效管理NULL值字段的输出是生成高质量JSON数据的关键。对于简单场景，可以在对象构建阶段通过条件判断直接控制；而对于复杂嵌套的对象结构，采用将对象转换为数组后，再通过自定义递归过滤函数进行深度处理的方法，能够提供更灵活、更强大的解决方案。理解并运用这些策略，将帮助开发者生成更精简、更符合业务需求的JSON数据。