TP5.1 项目中封装统一的 API 响应 Json 结构【标准化】

云敏姑娘_7491

云敏姑娘_7491

2026-07-16

592人浏览

原创

tp5.1中需统一api响应结构为{"code":0,"msg":"success","data":{}},通过自定义json响应类、全局中间件兜底及basecontroller封装三步实现,兼顾主动return json()、验证失败、异常抛出及模型序列化兼容性。

tp5.1 项目中封装统一的 api 响应 json 结构【标准化】

TP5.1 项目中需让所有 API 接口返回统一的 {"code":0,"msg":"success","data":{}} 结构,避免控制器里反复手写数组、混用 $this->success() 和 return json() 导致前端解析错乱,同时要兼容验证失败、异常抛出等非主动调用路径。

替换 Json 响应类,接管主动 return json() 调用

第一步:在 app\common\response\Json.php 创建新类,命名空间为 app\common\response,继承 think\response\Json。

第二步:只重写 protected function output($data): string 方法,构造标准结构:['code' => $this->code, 'msg' => $this->message, 'data' => $data],再用 json_encode(..., JSON_UNESCAPED_UNICODE) 返回字符串。

第三步:在 app\common\provider\AppServiceProvider.php 的 register() 方法中绑定容器:$this->app->bind('think\response\Json', \app\common\response\Json::class);。【不覆盖 vendor 文件,否则 composer update 会丢失】

这一步只影响你写的 return json($data),不影响状态码和消息字段——因为 $this->code 和 $this->message 是框架根据 json($data, 400, [], ['code'=>1]) 第四个参数自动设的,乱改 __construct 会导致 return json($data, 400) 失效。

用中间件兜底所有非主动响应路径

方法一:新建中间件 app\middleware\UniformJsonResponse.php,handle() 中判断 $response instanceof \think\Response 且 !$response instanceof \think\response\Json。

方法二:提取原始响应内容——若 $response->getContent() 是 JSON 字符串,用 json_decode($content, true) 解析;若已是数组(如验证异常默认输出),直接取用;否则统一包装为 ['code'=>500,'msg'=>'server error','data'=>null]。

方法三:用 response()->json($wrapped)->header(['Content-Type'=>'application/json; charset=utf-8']) 替换原响应对象,并确保该中间件注册为全局中间件,且执行顺序在 ResponseTrace 之后、输出之前。

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

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

下载

注意:TP5.1 没有 JsonResponse 类型判断,必须靠 getContent() + json_last_error() 双重校验,否则 HTML 响应会被错误转成 JSON。

封装 BaseController 统一业务层输出方法

第一步:新建 app\common\controller\BaseController.php,继承 \think\Controller。

第二步:添加 protected function success($data = [], $msg = 'success', $code = 0) 方法,内部调用 return json(['code' => $code, 'msg' => $msg, 'data' => $data]);。

第三步:添加 protected function error($msg = 'error', $code = -1, $data = null),同样走 return json(...)。

所有 API 控制器改为继承此 BaseController,后续直接写 return $this->success($user) 即可。这比裸写 json() 更安全——【TP5.1 中 $this->json() 会报 Call to undefined method 错误,必须用 return json()】。

处理模型序列化失败的兼容逻辑

在 BaseController::success() 方法内,对 $data 执行预检:if (is_object($data) && !method_exists($data, '__toString')) { $data = []; }。

这能防止模型里含闭包、资源句柄或未实现 __toString() 的自定义对象时,触发 Fatal error: Object of class ... could not be converted to string。

如果项目用了 Eloquent 或自定义模型,建议额外加一层 try { json_encode($data); } catch (\Exception $e) { $data = []; },但不要记录日志——TP5.1 的日志通道可能尚未初始化。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

thinkphp js json

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

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

4156

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

1295

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1678

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

9683

11

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

920

4

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2524

5

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1509

5

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

2023.09.21

4329

3

js生成随机数方法
js生成随机数方法

JavaScript生成随机数的方法,包括使用Math.random()方法生成指定范围内的随机整数、生成随机字符串和生成随机颜色。根据具体需求,可以选择适合的方法来生成随机数,以实现各种功能 。

2023.09.25

2475

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
ThinkPHP5.1企业站点快速开发
ThinkPHP5.1企业站点快速开发

共30课时 | 6.4万人学习

TP5.1博客后台视频教程
TP5.1博客后台视频教程

共8课时 | 1万人学习