PHP生成APP接口_返回JSON数据格式规范【说明】

夏明吖_5963

夏明吖_5963

2026-05-07

909人浏览

原创

PHP返回JSON给App的核心是确保App能干净稳定解析,90%问题源于响应头缺失或响应体污染,而非json_encode()错误;必须前置设置header('Content-Type: application/json; charset=utf-8'),校验json_encode()返回值,清除BOM、警告及多余输出,并统一响应结构。

php生成app接口_返回json数据格式规范【说明】

PHP 返回 JSON 给 App,核心问题不是“怎么转”,而是“App 能不能干净、稳定、无歧义地拿到并解析”。90% 的报错(Invalid JSON、Unexpected EOF、空响应)都源于响应体被污染或响应头缺失,不是 json_encode() 写错了。

必须在输出前设对 Content-Type 和 charset

App(尤其是 iOS 的 URLSession、Android 的 OkHttp)严格依赖 Content-Type: application/json; charset=utf-8 判断如何解码和解析。漏设、设成 text/html、或只写 application/json 不带 charset,都会导致中文乱码或解析失败。

  • header('Content-Type: application/json; charset=utf-8') 必须出现在任何 echo、print、空白符、BOM 之前;放在文件最顶部仍可能因 BOM 失效
  • 用框架(如 Laravel)时,优先用 response()->json(),它自动处理头+编码+状态码,避免手动 header() 被覆盖
  • 调试时用 curl -I http://api.example.com/user 看响应头,再用 curl http://api.example.com/user 看原始响应体——开头不能有空行、Warning:、HTML 片段

json_encode() 返回 false 就是失败,不是“没数据”

json_encode() 遇到资源句柄(如 PDOStatement)、循环引用对象、非 UTF-8 字符串、INF/NAN 值时,静默返回 false,不会报错也不会抛异常。此时 echo json_encode($data) 实际输出的是空字符串,App 收到的就是空响应。

  • 务必检查返回值:$json = json_encode($data, JSON_UNESCAPED_UNICODE); if ($json === false) { error_log('JSON encode failed: ' . json_last_error_msg()); http_response_code(500); echo json_encode(['error' => 'server_error']); exit; }
  • 数据库查询结果不能直接传给 json_encode():先 fetchAll(PDO::FETCH_ASSOC) 或 mysqli_fetch_all($result, MYSQLI_ASSOC)
  • 含中文字段来自 MySQL 时,确认连接已设 charset=utf8mb4,且执行过 SET NAMES utf8mb4;否则 json_encode() 可能因 GBK 字节失败

别让意外输出污染响应体

PHP 文件开头的 BOM、结尾的空行、var_dump() 调试语句、未捕获的 PHP 警告(如 Undefined index),都会在 JSON 前/后混入不可见字符或文本,导致 App 解析失败。

JS X Monitor
JS X Monitor

X.com (Twitter) 账号监控自动化:定时抓取指定账号最新推文,发现新内容即时推送通知。

下载
  • 用编辑器(如 VS Code、Sublime)保存为 “UTF-8 without BOM” 格式,别信文件名带 “utf8” 就安全
  • 输出前清缓冲:ob_end_clean() 放在 json_encode() 前,尤其在 include 其他文件后
  • 生产环境关闭 display_errors = Off,避免警告文字泄露到响应体中
  • 不要用 exit($json),改用 http_response_code(200); echo $json; exit;,确保只有一段 JSON 字符串

统一结构比“能返回”更重要

App 期望的是可预测的响应契约,不是裸 JSON。每次返回都应包含 code、msg、data 字段,哪怕 data 为空数组,也比直接返回原始数据更可靠。

  • 避免在不同接口里有的返回 {'users': [...]},有的返回 ['a','b'],前端必须写多套解析逻辑
  • 敏感字段(如 password、token)必须在 json_encode() 前 unset(),别指望前端过滤
  • 时间字段别直接输出 MySQL 的 DATETIME 字符串,统一转为时间戳或 ISO8601:date('c', strtotime($row['created_at']))

最难调的从来不是 json_encode() 语法,而是你根本没意识到那三个看不见的 BOM 字节、一行被遗忘的 print_r()、或者数据库连接漏了 charset 参数——它们都在安静地破坏整个 JSON 流。调试时第一反应不该是“JSON 怎么写”,而是“原始响应体到底长什么样”。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

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

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

下载

相关标签:

php js json

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11724

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6741

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2175

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4288

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4994

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3931

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5657

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4442

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12342

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习