php如何返回json数据文件_生成并返回json文件【操作】

1次阅读

php直接输出json需设header(‘content-type: application/json; charset=utf-8’)并用json_encode($data, json_unescaped_unicode | json_unescaped_slashes),避免bom/空格,检查返回值;生成文件下载则用file_put_contents+attachment头+unlink清理。

php如何返回json数据文件_生成并返回json文件【操作】

PHP 直接输出 JSON 数据(不生成文件)

绝大多数场景下,你并不需要「生成并保存为 .json 文件」,而是让 PHP 脚本直接返回 JSON 响应给前端或 API 调用方。关键在于设置正确的响应头 + 正确编码数据。

常见错误是只调用 json_encode() 但没设 Content-Type: application/json,导致前端收到文本却解析失败,或浏览器直接下载/乱码。

  • 必须调用 header('Content-Type: application/json; charset=utf-8'),且在任何输出前执行
  • 推荐使用 json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) 避免中文转义、URL 斜杠被转义
  • 务必检查 json_encode() 返回值是否为 false,可用 json_last_error_msg() 查错
  • 不要在 echo json_encode(...) 前有空格、BOM 或 print/var_dump 等输出,否则响应头失效
header('Content-Type: application/json; charset=utf-8'); $data = ['name' => '张三', 'score' => 95]; echo json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);

PHP 生成物理 JSON 文件并强制下载

只有当明确需要用户点击下载一个 .json 文件(比如导出配置、备份数据),才走「写入文件 + 发送下载头」流程。注意:这不是 API 返回方式,而是文件交付行为。

容易踩的坑是混淆「下载」和「响应 JSON」——前者会触发浏览器保存对话框,后者是程序间通信。

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

  • 先用 file_put_contents($filepath, $json_str) 写入文件(确保目录可写)
  • 再用 header('Content-Disposition: attachment; filename="data.json"') 触发下载
  • 必须搭配 header('Content-Type: application/octet-stream'),不能用 application/json,否则部分浏览器不弹下载框
  • 下载后建议用 unlink($filepath) 清理临时文件,否则磁盘会被占满
$data = ['items' => [['id'=>1,'title'=>'A'], ['id'=>2,'title'=>'B']]]; $json_str = json_encode($data, JSON_UNESCAPED_UNICODE); $filepath = sys_get_temp_dir() . '/export_' . time() . '.json'; file_put_contents($filepath, $json_str);  header('Content-Type: application/octet-stream'); header('Content-Disposition: attachment; filename="export.json"'); header('Content-Length: ' . filesize($filepath)); readfile($filepath); unlink($filepath); // 立即删除

为什么不该用 file_get_contents + echo 返回 JSON 文件

有人想“先生成文件,再读出来 echo”,这完全多余,还引入 IO 开销和竞态风险(如文件被删、权限变、内容被改)。

典型错误写法:echo file_get_contents('output.json'); —— 它漏了响应头,且绕过 JSON 编码校验,一旦文件损坏或含 BOM,前端解析必崩。

  • 若已存在合法 JSON 文件,应先 json_decode(file_get_contents($f), true) 校验有效性,再 json_encode() 输出
  • 直接 readfile() + application/json 头仅适用于静态、可信、无需动态处理的场景(极少见)
  • Web 服务器(如 nginx)对 .json 后缀默认不执行 PHP,所以靠 URL 访问本地 .json 文件 ≠ 执行 PHP 逻辑

调试时如何确认返回的是有效 JSON

别依赖浏览器地址栏打开看——它可能渲染成 HTML 或触发下载。真实验证方式就两个:

  • curl -I http://your-site/api.php 检查响应头是否含 Content-Type: application/json
  • curl -s http://your-site/api.php | python3 -m json.tool(或 jq)验证格式是否合法;报错说明 json_encode() 出了问题(比如资源类型、循环引用、非 UTF-8 字符)
  • chrome DevTools 的 Network → Preview 标签页能直观显示解析后的 JSON 结构,比 Response 更可靠

最常被忽略的是字符编码:mysql 查询结果、文件读取、xml 解析等来源的数据若含 GBK 或 Latin1 字符,json_encode() 会静默失败,必须提前转为 UTF-8。

text=ZqhQzanResources