使用array_push向JSON文件添加元素数据时的异常问题排查

问题背景 #

你需要给现有JSON文件添加s3对应的数组数据，原JSON内容如下：

{ "s1":[ { "bID":"q4a4xs", "bName":"Package1", "bStep":"slast" }, { "bID":"q4a4xs", "bName":"Package2", "bStep":"s2" } ], "s2":[ { "bID":"q4a4xs", "bName":"Package15", "bStep":"slast" } ] }

你写了一段PHP代码尝试实现，但输出结果出现了错误的"w3":{ "Array":null }（应该是s3的笔误），代码和错误输出如下：

你编写的代码 #

$newdata = ['bID' => 'O4bt2xs','bName' => 'Package91','bStep' => 's1'];
$newBox = 's3';
$encDexJSON = json_decode($json);
array_push($encDexJSON->{$newBox}->{$newdata}, $newdata);

错误输出 #

{ "s1":[ { "bID":"q4a4xs", "bName":"Package1", "bStep":"slast" }, { "bID":"q4a4xs", "bName":"Package2", "bStep":"s2" } ], "s2":[ { "bID":"q4a4xs", "bName":"Package15", "bStep":"slast" } ], "w3":{ "Array":null } }

问题根源 #

你这里犯了两个关键错误：

• 错误1：未初始化目标数组：当你用json_decode($json)默认返回对象时，$encDexJSON->{$newBox}（也就是s3）一开始根本不存在。PHP遇到这种未定义的对象属性时，会自动把它初始化为空对象，而不是你需要的数组，这就导致后续操作完全偏离预期。
• 错误2：array_push参数使用错误：你写的$encDexJSON->{$newBox}->{$newdata}完全不合理，$newdata是你要添加的数组数据，不是对象的属性名，这里根本不需要用->{$newdata}来访问属性。

修复后的代码 #

下面是修正后的完整代码，我还添加了一些健壮性处理：

// 原JSON字符串
$json = '{ "s1":[ { "bID":"q4a4xs", "bName":"Package1", "bStep":"slast" }, { "bID":"q4a4xs", "bName":"Package2", "bStep":"s2" } ], "s2":[ { "bID":"q4a4xs", "bName":"Package15", "bStep":"slast" } ] }';

$newdata = ['bID' => 'O4bt2xs','bName' => 'Package91','bStep' => 's1'];
$newBox = 's3';

// 解码为对象（如果习惯用关联数组，可以加第二个参数true：json_decode($json, true)）
$encDexJSON = json_decode($json);

// 先检查s3是否存在，不存在则初始化为数组
if (!isset($encDexJSON->{$newBox})) {
    $encDexJSON->{$newBox} = [];
}

// 将新数据添加到s3数组中，两种写法任选其一
array_push($encDexJSON->{$newBox}, $newdata);
// 或者更简洁的写法：$encDexJSON->{$newBox}[] = $newdata;

// 重新编码为格式化后的JSON（JSON_PRETTY_PRINT用于美化输出）
$updatedJson = json_encode($encDexJSON, JSON_PRETTY_PRINT);
echo $updatedJson;

正确输出结果 #

运行修正后的代码，你会得到符合预期的JSON：

{
    "s1": [
        {
            "bID": "q4a4xs",
            "bName": "Package1",
            "bStep": "slast"
        },
        {
            "bID": "q4a4xs",
            "bName": "Package2",
            "bStep": "s2"
        }
    ],
    "s2": [
        {
            "bID": "q4a4xs",
            "bName": "Package15",
            "bStep": "slast"
        }
    ],
    "s3": [
        {
            "bID": "O4bt2xs",
            "bName": "Package91",
            "bStep": "s1"
        }
    ]
}

内容的提问来源于stack exchange，提问作者Editor