ci4中应直接使用$this->response->setjson()返回json响应,它自动设置content-type、编码并终止输出;切勿混用echo、view()或手动header(),并确保php文件为utf-8无bom编码。

CI4控制器里直接用 $this->response->setJSON() 就行
不用手写 header(),不用 echo json_encode(),更别碰 exit。CI4 的 $this->response 对象专为这种响应设计,自动设 Content-Type: application/json; charset=utf-8、调用 json_encode()、处理 UTF-8 编码,并终止后续输出流程。
常见错误是混用输出方式:比如在调用 setJSON() 前不小心 echo 了点东西,或后面又写了 return view() —— 这会导致 headers already sent 错误,或者返回乱码/空响应。
-
setJSON()默认使用JSON_UNESCAPED_UNICODE | JSON_PARTIAL_OUTPUT_ON_ERROR,中文不转义,遇到不可序列化值(如资源、闭包)也不会整个失败,而是跳过或报错提示 - 想改状态码?链式调用:
$this->response->setStatusCode(201)->setJSON($data) - 要返回空 JSON 对象?
return $this->response->setJSON([])或return $this->response->setJSON(new \stdClass()) - 不能在同一个方法里既用
setJSON()又用view(),CI4 要求响应路径唯一
别让 BOM 和空白字符毁掉 header
即使代码逻辑完全正确,只要控制器 PHP 文件开头有 BOM(比如用 Windows 记事本保存过),或文件顶部有空格、空行、UTF-8 BOM 字节(\xEF\xBB\xBF),PHP 就会提前输出内容,导致 setJSON() 内部的 header() 失败,浏览器收到的是 text/html 响应体,前端解析成字符串而非对象。
验证方法:用 curl -I http://yourdomain.com/api/xxx 看响应头是否含 Content-Type: application/json;或者打开开发者工具 Network 标签页,点开请求,看 Response Headers 里有没有这行。
- 用 VS Code、PhpStorm 等编辑器打开控制器文件,右下角确认编码是
UTF-8 without BOM - 检查文件第一行是不是
<?php,前面绝不能有任何字符(包括空格、换行) - 如果用了 Traits 或 require 文件,也要一并检查那些文件是否带 BOM
需要自定义 JSON 结构?先处理数据,再传给 setJSON()
setJSON() 只负责安全输出,不负责数据变形。如果前端要的是 [ [1623456000000, 972.94], [...] ] 这种二维数组,而不是默认的关联数组,就得在控制器里手动转换。
典型场景:数据库查出 ['date_issued' => '2021-03-01', 'grand_total' => '972.94'],但图表库只认 [时间戳毫秒, 数值]。
- 用
array_map()遍历重构:$price = array_map(fn($row) => [(strtotime($row->date_issued) * 1000), (float)$row->grand_total], $invoices) - 注意
strtotime()对无效日期返回false,建议加判空或用DateTime::createFromFormat() - 最终调用:
return $this->response->setJSON(['price' => $price]) - 别在
setJSON()里塞复杂表达式,先赋值给变量,方便调试和类型检查
调试时怎么快速确认 JSON 是否正常?
最直接的办法不是看浏览器控制台,而是用命令行 curl + -v 参数看原始响应:
curl -v http://localhost:8080/api/invoices
重点看两块:一是响应头里有没有 Content-Type: application/json,二是响应体是否是合法 JSON(无 PHP 错误、无 HTML 片段、无额外空格)。
- 如果看到
Warning: Cannot modify header information...,基本就是 BOM 或前置输出问题 - 如果返回的是
{"price":null},说明数据源是空或转换逻辑没走通,加log_message('debug', print_r($invoices, true))查中间态 - CI4 默认关闭 display_errors,线上环境看不到 PHP 错误,必须靠日志或
error_log()捕获
实际项目中最容易被忽略的,是模型层返回的数据结构和控制器预期之间的隐性契约——比如模型返回对象数组,控制器却按关联数组遍历字段,结果某次字段名拼错或类型变更,setJSON() 照常执行,但前端拿到的是 null 或空数组,排查时容易绕远路。











