
PHP 数组在接口返回数据中应以结构清晰、类型明确、可预测的方式组织,避免嵌套过深、键名不统一、空值处理随意等问题,确保前后端协作高效、稳定。
统一使用关联数组(key-value),禁用纯数字索引
接口返回的数据本质是结构化信息,需通过语义化键名表达含义。即使返回列表,也应包裹在有意义的字段下:
- ✅ 推荐:
["users" => [{"id" => 1, "name" => "张三"}, {"id" => 2, "name" => "李四"}]] - ❌ 避免:
[{"id" => 1, "name" => "张三"}, {"id" => 2, "name" => "李四"}](顶层无 key,前端难识别数据意图)
固定顶层字段结构,预留通用元信息
每个接口响应建议包含标准字段,便于统一处理错误、分页和状态:
- code:整型状态码(如 0=成功,1001=参数错误)
- message:简明提示(成功时可为 "ok",失败时说明原因)
- data:业务主体数据(始终存在,即使为空数组或 null)
- (可选)meta:分页/统计等附加信息(如
["total" => 120, "page" => 1, "per_page" => 20])
严格约束数组内容,避免动态键名与混合类型
不要因“方便”而让同一数组键对应不同结构的数据:
立即学习“PHP免费学习笔记(深入)”;
- ❌ 危险示例:
["result" => $user]和["result" => ["error" => "not found"]]混用,前端需反复判断类型 - ✅ 正确做法:失败时仍返回完整结构,
data设为null或空数组,并通过code和message表达结果 - 所有字段键名全小写、下划线分隔(如
user_id、created_at),保持命名一致性
空值与默认值显式声明,不依赖隐式转换
PHP 的 null、''、[]、false 在 JSON 中表现不同,易引发前端解析异常:
- 字符串字段为空时,明确赋值
"",而非null(除非语义上确实“未设置”) - 数组字段若无数据,返回
[]而非null,避免前端res.data.map报错 - 数值字段禁止用空字符串代替
0,避免 JavaScript 中"0" == false类型陷阱
规范不是束缚,而是降低协作成本的共识。用数组承载接口数据时,多一分结构意识,少十分调试时间。











