Hyperf控制器怎么返回JSON

秋明大大_2783

秋明大大_2783

2026-09-03

246人浏览

原创

不能直接echo json_encode(),因为Hyperf是Swoole常驻内存框架,echo会绕过响应生命周期管理,导致Content-Type错误、状态码无法动态设置、中间件失效、CLI下报错;正确做法是依赖注入ResponseInterface并调用json()方法。

hyperf控制器怎么返回json

ResponseInterface 的 json() 方法是 Hyperf 控制器返回 JSON 的标准方式,无需手动 json_encode() 或设置 Header。

为什么不能直接 echo json_encode()?

Hyperf 是基于 Swoole 的常驻内存框架,直接 echo 会绕过响应生命周期管理,导致:

  • Content-Type 不是 application/json(默认是 text/html)
  • HTTP 状态码固定为 200,无法动态设为 400/500 等
  • 后续中间件(如 CORS、日志记录)可能收不到完整响应对象
  • 在 CLI 模式下(如测试、定时任务)可能直接报错或静默失败

正确用法:注入 ResponseInterface 并调用 json()

必须通过依赖注入获取 ResponseInterface 实例,不能 new 或静态调用。示例如下:

use Hyperf\HttpServer\Contract\ResponseInterface;
use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;

public function index(ResponseInterface $response): Psr7ResponseInterface
{
    $data = ['code' => 200, 'msg' => 'ok', 'data' => ['id' => 1]];
    return $response->json($data);
}
  • $response->json() 自动设置 Content-Type: application/json; charset=utf-8
  • 支持传入第二个参数指定状态码:$response->json($data, 201)
  • 第三个参数可传入 JSON 标志位,如 JSON_UNESCAPED_UNICODE
  • 返回值类型必须声明为 Psr7ResponseInterface,否则 Swoole 可能无法识别响应体

常见错误:raw() + 手动 json_encode() 代替 json()

有人写成这样:

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
return $response->raw(json_encode($data)); // ❌ 错误

问题在于:

  • raw() 不自动设 Content-Type,前端可能解析失败
  • 中文字符若未加 JSON_UNESCAPED_UNICODE 会被转义成 \uXXXX
  • 空数组 [] 和关联数组 [] 在 PHP 中表现一致,但 json() 内部做了类型推导,raw() 没有
  • 异常时无法统一拦截 JSON 渲染逻辑(比如全局加 trace_id)

真正需要定制 JSON 行为(如统一加字段、改状态结构)应该在中间件或自定义 ResponseInterface 实现里处理,而不是在每个控制器里退化成 raw()。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

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

相关专题

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

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

2023.09.01

11564

6

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

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

2023.10.11

6681

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

4228

4

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

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

2023.10.23

4954

6

html怎么上传
html怎么上传

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

2023.11.03

3871

9

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

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

2023.11.09

5597

8

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

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

2023.11.13

4382

8

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

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

2023.11.27

12302

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习