PHP生成JSON避免多余数组层级的方法

文章不知道大家是否熟悉？今天我将给大家介绍《PHP动态生成JSON，避免多余数组层级》，这篇文章主要会讲到等等知识点，如果你在看完本篇文章后，有更好的建议或者发现哪里有问题，希望大家都能积极评论指出，谢谢！希望我们能一起加油进步！

PHP数组与JSON结构的映射原理

在PHP中，将数据结构转换为JSON字符串是常见的操作，这主要通过json_encode()函数实现。理解PHP数组类型如何映射到JSON结构是至关重要的：

1. 索引数组 (Indexed Arrays) 映射为JSON数组 (JSON Arrays) 如果一个PHP数组的所有键都是连续的整数（从0开始），或者它被显式地定义为一个列表，json_encode()会将其视为一个索引数组，并转换为JSON数组（用方括号[]包围）。 例如：$arr = ['apple', 'banana', 'orange']; 转换为 ["apple", "banana", "orange"]。

2. 关联数组 (Associative Arrays) 映射为JSON对象 (JSON Objects) 如果一个PHP数组包含字符串键，或者其整数键不是连续的（例如，键不是从0开始，或者中间有跳跃），json_encode()会将其视为一个关联数组，并转换为JSON对象（用花括号{}包围）。 例如：$arr = ['name' => 'Alice', 'age' => 30]; 转换为 {"name": "Alice", "age": 30}。

问题剖析：不必要的JSON数组层级

在实际开发中，我们有时会遇到希望生成JSON对象，但却意外得到JSON数组的情况。这通常是由于PHP数组的构建方式不符合预期。考虑以下PHP代码片段，它旨在构建一个包含加密货币汇率数据的JSON结构：

 'BTC'],
    ['symbol' => 'ETH'],
    // ... 更多数据
];

$data = array(
    'base' => 'USD',
    'alter' => 'ETH',
    'data' => array() // 初始化为一个空数组
);

foreach ($cryptos as $row) {
    $sy = $row["symbol"];
    // 错误的做法：这会向 $data['data'] 中添加一个索引元素
    $data['data'][] = array(
       "$sy"  => [
            "rate" => 1.552000000000000,
            "min" => 1.0077600000000000,
            "max" => 10.077600000000000,
            "code" => $row["symbol"],
            "dp" => 8
        ],
    );
}
echo json_encode($data, JSON_PRETTY_PRINT);
?>

上述代码中的关键行是 $data['data'][] = array("$sy" => [...]);。这里的 [] 操作符表示向 $data['data'] 这个数组的末尾添加一个新元素，并且该元素是一个关联数组（例如 ["BTC" => {...}]）。因此，$data['data'] 最终会变成一个索引数组，其每个元素都是一个包含单个键值对的关联数组。

执行上述代码后，json_encode() 会生成如下的JSON结构：

{
   "base":"USD",
   "alter":"ETH",
   "data":[
      {
         "BTC":{
            "rate": 1.552,
            "min": 1.00776,
            "max": 10.0776,
            "code":"BTC",
            "dp":8
         }
      },
      {
         "ETH":{
            "rate": 1.552,
            "min": 1.00776,
            "max": 10.0776,
            "code":"ETH",
            "dp":8
         }
      }
   ]
}

可以看到，"data" 键的值是一个JSON数组 []，而不是我们期望的JSON对象 {}。这是因为 $data['data'] 在PHP中被构建成了一个索引数组。

解决方案：构建动态JSON对象

要实现将 "data" 键的值直接表示为JSON对象，我们需要确保在PHP中 $data['data'] 是一个关联数组，并且其键是动态生成的加密货币符号。这可以通过直接使用变量作为数组的键来实现，而不是使用 [] 来追加元素。

修正后的PHP代码如下：

 'BTC'],
    ['symbol' => 'ETH'],
    ['symbol' => 'XRP'],
    // ... 更多数据
];

$data = array(
    'base' => 'USD',
    'alter' => 'ETH',
    'data' => array() // 初始化为一个空数组
);

foreach ($cryptos as $row) {
    $sy = $row["symbol"];
    // 正确的做法：直接使用 $sy 作为键，构建关联数组
    $data['data'][$sy] = [
        "rate" => 1.552000000000000,
        "min" => 1.0077600000000000,
        "max" => 10.077600000000000,
        "code" => $row["symbol"],
        "dp" => 8
    ];
}
echo json_encode($data, JSON_PRETTY_PRINT);
?>

在修正后的代码中，$data['data'][$sy] = [...] 这行代码指示PHP将 $sy （例如 "BTC", "ETH"）作为键，将右侧的数组作为值，添加到 $data['data'] 中。这样，$data['data'] 在PHP内部就成为一个关联数组，其结构类似于：

[
    "BTC" => [ /* BTC 详情 */ ],
    "ETH" => [ /* ETH 详情 */ ],
    "XRP" => [ /* XRP 详情 */ ],
]

当 json_encode() 处理这样一个关联数组时，它会将其转换为一个JSON对象。

执行修正后的代码，将得到我们期望的JSON结构：

{
   "base":"USD",
   "alter":"ETH",
   "data":{
      "BTC":{
         "rate": 1.552,
         "min": 1.00776,
         "max": 10.0776,
         "code":"BTC",
         "dp":8
      },
      "ETH":{
         "rate": 1.552,
         "min": 1.00776,
         "max": 10.0776,
         "code":"ETH",
         "dp":8
      },
      "XRP":{
         "rate": 1.552,
         "min": 1.00776,
         "max": 10.0776,
         "code":"XRP",
         "dp":8
      }
   }
}

关键注意事项

• 理解PHP数组类型与JSON映射的本质：这是避免JSON结构意外的关键。当需要JSON对象时，请确保构建的是PHP关联数组；当需要JSON数组时，请构建PHP索引数组。
• 动态键名赋值：在循环中构建数据时，如果希望以某个变量的值作为JSON对象的键，直接使用 $array[$variable_key] = $value; 这种形式是正确的做法。
• json_encode选项：虽然本例通过改变PHP数组结构解决了问题，但有时json_encode的选项，如 JSON_FORCE_OBJECT，也可以强制将索引数组转换为JSON对象。然而，这通常用于特定场景，并且可能不是最直观的解决方案，直接构建正确的PHP数组结构通常更佳。
• 调试技巧：在json_encode之前，使用print_r()或var_dump()打印出PHP数组的结构，可以帮助你理解数组的实际形态，从而更容易发现与预期不符之处。

总结

通过精确控制PHP中数组的构建方式，我们可以有效地管理json_encode()的输出结构。本教程演示了如何将一个PHP索引数组转换为关联数组，从而将JSON中的数组层级 [] 转换为对象层级 {}。掌握这一技巧对于生成符合特定API或前端需求的JSON数据至关重要。始终牢记PHP数组的内部表示如何影响最终的JSON输出，将有助于您编写更健壮、更可预测的代码。

到这里，我们也就讲完了《PHP生成JSON避免多余数组层级的方法》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！