0

0

PHP 数组在接口返回中的规范写法

冷炫風刃

冷炫風刃

发布时间:2026-03-09 15:59:25

|

394人浏览过

|

来源于php中文网

原创

php接口返回数组应统一使用data+code+msg结构:code为整数状态码,msg为简明提示,data始终为数组(空时为[]);分页需含list/total等元信息;错误响应结构一致;避免null/false混用、对象未转数组、键名不统一等问题。

php 数组在接口返回中的规范写法

PHP 接口返回数组时,核心是统一结构、明确语义、兼顾可读性与机器解析。不推荐直接 return $data,而应封装为标准响应格式。

统一响应结构(推荐使用 data + code + msg)

绝大多数 RESTful 接口应返回一致的顶层结构,便于前端统一处理:

  • code:状态码(如 0 表示成功,非 0 表示错误,建议用整数,避免字符串)
  • msg:简明提示信息(面向开发者或用户,不包含敏感内容)
  • data:实际业务数据,始终为数组(即使为空也设为 [],而非 null 或省略)

示例:

return [
    'code' => 0,
    'msg'  => 'success',
    'data' => [
        'id'   => 123,
        'name' => '张三',
        'tags' => ['php', 'api']
    ]
];

空数据/分页列表需显式表达

避免让调用方猜测空值含义。列表接口即使无结果,data 仍应为数组:

立即学习PHP免费学习笔记(深入)”;

Palette
Palette

在线生成整套UI调色板

下载
  • 查无结果: 'data' => []
  • 分页结果:统一用 'list' 键包裹数组,并附带 'total''page' 等元信息

示例(分页):

return [
    'code'  => 0,
    'msg'   => 'ok',
    'data'  => [
        'list'  => [],
        'total' => 0,
        'page'  => 1,
        'size'  => 10
    ]
];

错误响应保持结构一致

失败时仍返回完整三字段结构,仅改变 codemsgdata 可为 [] 或含调试信息的关联数组(生产环境建议清空 data 或仅留必要上下文):

return [
    'code' => 404,
    'msg'  => '用户不存在',
    'data' => []
];

开发阶段可临时加入 'debug' => [...],但上线前应移除或由配置控制。

避免常见陷阱

以下写法虽能运行,但不利于协作和维护:

  • 混用 nullfalse[] 表示“无数据”——统一用空数组
  • 响应中出现 PHP 特有类型(如 stdClass 对象)——始终用 array,必要时用 (array)$obj 转换
  • 键名大小写混乱(如 UserIDuser_id 并存)——全项目统一小写下划线(user_id)或小驼峰(userId),推荐前者
  • data 外直接塞业务字段(如 'user' => [...])——破坏约定,增加前端适配成本

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

179

2025.11.26

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

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

253

2023.09.22

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

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

1069

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

739

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

220

2023.09.04

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

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

1563

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

649

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1188

2024.03.22

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

59

2026.03.06

热门下载

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

精品课程

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

共137课时 | 13.2万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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