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

ThinkPHP8响应JSON输出,统一返回格式封装方案

夜磊大大_7099

夜磊大大_7099

发布时间:2026-10-05 14:56:26

|

475人浏览过

|

来源于php中文网

原创

直接 return json($data) 无法统一结构,因其仅输出 ['data' => $data],而异常响应为 ['error' => 'xxx'] 或 HTML,导致前端需多套解析逻辑;应重写 Json 响应类接管显式 json(),再通过 setSendCallback 中间件统一封装所有 JSON 响应。

thinkphp8响应json输出,统一返回格式封装方案

为什么直接 return json($data) 无法统一结构

因为 json() 只是调用框架内置的 think\response\Json 类,它默认输出 ['data' => $data],不带 code 和 msg 字段;而异常(如 ValidateException)走的是另一套响应路径,返回 ['error' => 'xxx'] 或 HTML,前端必须写多套解析逻辑。

常见错误现象:前端 JSON.parse() 报 Unexpected token e in JSON at position 0,或 data 字段是字符串而非对象——本质是后端混用了至少 3 种结构:return json()、throw new ValidateException()、未捕获异常。

  • 不要试图在每个控制器里手动拼数组再 json(),维护成本高且易漏
  • 不要重写 Json 类的 __construct 或 init 方法,会破坏状态码映射(比如 json($data, 400) 中的 400 就失效)
  • 关键点在于:显式 json() 和隐式异常响应,必须由不同机制分别接管,再汇入同一出口

重写 Json 响应类,只接管显式 json() 调用

新建 app/common/response/Json.php,继承 think\response\Json,仅重写 output($data):

namespace app\common\response;

use think\response\Json as BaseJson;

class Json extends BaseJson
{
    protected function output($data): string
    {
        $result = [
            'code' => $this->code,
            'msg'  => $this->message,
            'data' => $data,
        ];
        return json_encode($result, JSON_UNESCAPED_UNICODE);
    }
}

然后在 AppServiceProvider::register() 中绑定:

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

$this->app->bind('think\response\Json', \app\common\response\Json::class);

这样所有 return json($data)、return json($data, 400) 都自动套上 code/msg,且状态码仍生效。但注意:它对 throw 出来的异常完全无效。

Feishu calendar sync, local ics to json data for AI agent
Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式,用于飞书日历导入导出及数据集成。

下载

用中间件在 send() 前拦截并统一封装所有响应

必须用 Response::setSendCallback(),而不是 after 中间件——后者执行时响应已发出,改了也白改。

新建中间件 app/middleware/UniformJsonResponse.php:

public function handle($request, \Closure $next)
{
    \think\Response::setSendCallback(function ($response) {
        // 只处理 application/json 响应
        $type = $response->getHeader('Content-Type')[0] ?? '';
        if (strpos($type, 'application/json') === false) {
            return $response;
        }

        $content = $response->getContent();
        $raw = json_decode($content, true);

        // 提取原始结构中的 code/msg/data,或兜底为 500
        $code = $raw['code'] ?? ($response->getCode() ?: 500);
        $msg  = $raw['msg'] ?? ($raw['error'] ?? 'server error');
        $data = $raw['data'] ?? ($raw ?? null);

        $newBody = json_encode([
            'code' => $code,
            'msg'  => $msg,
            'data' => $data
        ], JSON_UNESCAPED_UNICODE);

        return \think\Response::create($newBody, 'json')
            ->header('Content-Length', strlen($newBody));
    });

    return $next($request);
}

注册为全局中间件,并确保它排在 think\middleware\JsonResponse 之前(否则会被覆盖)。验证方式:在中间件中 dump(\think\Pipeline::getMiddleware()) 查顺序。

异常类 render() 里别硬编码 JSON 返回

app/exception/Handler.php 的 render() 方法,只负责把异常转成响应对象,**不负责格式封装**——那该由上面的 UniformJsonResponse 中间件统一干。

所以 render() 里只需做两件事:

  • 判断请求是否期望 JSON(检查 Accept 头),不是就交给父类处理(返回 HTML 错误页)
  • 是 JSON 请求,就返回 json(['error' => $e->getMessage()], $e->getStatusCode()),让后续中间件去套壳

别在这里手动拼 ['code'=>500,'msg'=>'xxx','data'=>null],否则和中间件逻辑重复,且容易漏掉 ValidateException 等框架级异常的字段提取逻辑。

最易被忽略的一点:中间件里的 setSendCallback 是唯一能真正拦截所有响应类型的钩子,包括文件下载、视图渲染失败等非 JSON 场景——你得靠 Content-Type 主动过滤,而不是无差别重写。

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
WorkBuddy

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

墨刀AI
墨刀AI Hot

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

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

相关专题

更多
thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3721

2024.04.10

thinkphp性能怎么样
thinkphp性能怎么样

thinkphp 是一款高性能的 php 框架,具备缓存机制、代码优化、并行处理和数据库优化等优势。官方性能测试显示,它每秒可处理超过 10,000 个请求,实际应用中被广泛用于京东商城、携程网等大型网站和企业系统。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1260

2024.04.10

ThinkPHP6后台管理系统开发与RBAC权限控制实践
ThinkPHP6后台管理系统开发与RBAC权限控制实践

本专题围绕 ThinkPHP6 在后台管理系统开发中的应用展开,重点讲解基于 RBAC 模型的权限控制实现方案。内容涵盖管理员角色设计、菜单权限分配、接口鉴权、中间件拦截机制以及后台模块化开发思路。同时结合实际案例,讲解如何构建完整的后台管理系统,包括用户管理、权限管理与操作日志记录,帮助开发者搭建安全、可扩展的企业级后台系统。

483

2026.03.20

ThinkPHP API接口开发与前后端分离实战
ThinkPHP API接口开发与前后端分离实战

本专题围绕ThinkPHP在前后端分离项目中的 API 开发展开,系统讲解 RESTful 接口设计规范、统一返回结构、参数验证与异常处理机制。内容涵盖 Token 鉴权、跨域处理、接口版本管理以及接口文档生成方案。通过完整项目案例,帮助开发者构建规范、高效、易维护的后端接口服务体系。

324

2026.03.20

ThinkPHP ORM模型关系与数据库操作优化实践
ThinkPHP ORM模型关系与数据库操作优化实践

本专题聚焦ThinkPHP中 ORM 模型的高级用法与数据库操作优化技巧。内容包括一对一、一对多、多对多关系定义与使用、关联预加载、查询构建器优化以及复杂查询封装方法。同时结合实际业务场景,讲解如何避免 N+1 查询问题、提升数据库访问效率,帮助开发者编写高性能的数据访问层代码。

219

2026.03.20

ThinkPHP模型详解
ThinkPHP模型详解

本专题整合了ThinkPHP模型相关内容,阅读专题下面的文章了解更多详细介绍。

258

2026.03.26

ThinkPHP表单验证与数据安全处理实战
ThinkPHP表单验证与数据安全处理实战

本专题聚焦 ThinkPHP 在表单处理中的验证与安全机制,系统讲解验证器使用、自定义规则、场景验证以及错误提示处理。内容涵盖 XSS 防护、SQL 注入防御、数据过滤与输入校验等关键安全措施。通过实际案例,帮助开发者构建安全可靠的数据处理流程。

221

2026.03.30

ThinkPHP日志系统设计与异常监控实践
ThinkPHP日志系统设计与异常监控实践

本专题围绕 ThinkPHP 日志系统展开,深入讲解日志记录机制、日志级别划分、日志文件管理以及自定义日志通道配置。内容涵盖异常捕获、错误追踪、调试信息输出以及日志分析方法。通过实战讲解,帮助开发者提升系统问题定位能力与运维效率。

428

2026.03.30

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

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

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