讲师中心 微信公众号
AI工具推荐 视频效率加速

ThinkPHP统一JSON响应中间件怎么写

老雪吖_6983

老雪吖_6983

发布时间:2026-09-01 13:14:17

|

787人浏览过

|

来源于php中文网

原创

必须用Response::setSendCallback()在send()前拦截重写,仅处理Content-Type为application/json的响应,并确保中间件优先级高于JsonResponse。

thinkphp统一json响应中间件怎么写

中间件里怎么统一拦截并转换响应为 JSON

ThinkPHP 的中间件在 app/middleware.php 或路由/控制器绑定中生效,但关键点在于:不能在中间件里直接修改已输出的响应体。真正可行的方式是拦截 Response 对象,在它被发送前重写内容和 Header。

常见错误是试图在中间件里用 echo json_encode(...) 或直接 return 新 Response,结果导致重复输出或 header 已发送报错(Cannot modify header information)。

  • 必须使用 $response->withContent() + ->header() 重建响应对象
  • 推荐在中间件 handle() 方法末尾返回修改后的 $response,而不是提前 return
  • 若控制器已返回 JSON 字符串(如 return json([...])),该中间件会二次编码——需先判断原始响应类型

如何识别并跳过已为 JSON 的响应

ThinkPHP 原生 json() 函数返回的是 think\Response 实例,其 getHeader('content-type') 通常含 application/json;而普通数组或字符串响应则没有。靠这个判断可避免套娃:

if (strpos($response->getHeader('content-type')[0] ?? '', 'application/json') !== false) {
    return $response;
}

更稳妥的做法是检查响应内容是否已为合法 JSON 字符串(用 json_decode($response->getContent(), true) 并判断是否非 null 且无 JSON_ERROR_SYNTAX)。

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

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 不要只看控制器 return 类型——有些逻辑可能 return 数组,有些 return view(),中间件需一视同仁
  • 若项目混用 HTML 和 API 路由,建议通过路由分组或中间件参数控制生效范围,比如只对 api/ 前缀启用
  • 注意 CLI 环境下 getHeader() 可能返回空数组,需加空值判断

怎么兼容异常和错误时的 JSON 输出

默认异常页面是 HTML,但 API 场景下需要统一返回 JSON 错误结构。这不能单靠中间件解决——异常处理流程在中间件之前就可能终止执行。

正确做法是配合 app/exception.php 中的 render() 方法,对 HttpException 和自定义业务异常统一转 JSON:

if (request()->isAjax() || request()->header('accept') === 'application/json') {
    return json(['code' => $e->getCode() ?: 500, 'msg' => $e->getMessage()]);
}

中间件只管“正常流程”的响应,异常流必须另走异常处理器,两者缺一不可。

  • 别指望中间件捕获所有 throw new Exception ——未被捕获的异常会直接触发 render()
  • request()->isAjax() 不可靠,建议优先检查 Accept header 或约定请求带 X-Requested-With: XMLHttpRequest
  • 404、405 等 HTTP 异常默认不进中间件 handle,必须在 render() 里显式处理

实际部署时 Content-Type 和状态码容易漏设

很多人只改了 body,忘了设 Content-Type: application/json; charset=utf-8 和正确的 HTTP 状态码,导致前端解析失败或 axios 默认 reject 2xx 以外的状态。

完整重写响应应包含三要素:

$data = ['code' => 0, 'msg' => 'ok', 'data' => $response->getContent()];
$json = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
return $response->withContent($json)
    ->header('Content-Type', 'application/json; charset=utf-8')
    ->code(200);
  • JSON_UNESCAPED_UNICODE 避免中文变 \uXXXX
  • 如果原始响应是 400 错误,中间件里仍设 200 就会掩盖问题——建议透传原状态码:->code($response->getCode())
  • Apache 下注意 AddType application/json .json 这类配置不会影响 PHP 输出,无需额外处理
中间件本身不难写,难点在于厘清 ThinkPHP 响应生命周期里「谁在什么时候生成、修改、发送响应」——尤其是异常路径和正常路径完全走两套机制,漏掉任意一环都会导致前后端联调时出现看似随机的格式错乱。

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

相关专题

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

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

11524

2023.09.01

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

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

6661

2023.10.11

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

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

2175

2023.10.11

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

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

4208

2023.10.23

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

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

4934

2023.10.23

html怎么上传
html怎么上传

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

3871

2023.11.03

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

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

5577

2023.11.09

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

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

4362

2023.11.13

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

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

精品课程

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn