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

ThinkPHP接口返回格式规范

秋丽姑娘_7631

秋丽姑娘_7631

发布时间:2026-05-15 09:58:27

|

447人浏览过

|

来源于php中文网

原创

ThinkPHP6接口必须用json()函数返回JSON数据,因直接return数组会触发模板渲染或类型错误;统一响应结构应为{"code":200,"msg":"操作成功","data":{}},需手动封装或继承基类实现。

thinkphp接口返回格式规范

ThinkPHP 接口必须用 json() 返回,直接 return $data 会触发模板渲染或类型错误;统一结构应为 { "code": 200, "msg": "操作成功", "data": {} },不能靠框架自动补全,得手动封装或继承基类。

为什么不能直接 return 数组

TP6 的响应机制按返回值类型匹配 Response 子类。直接 return ['code' => 200],框架识别不出是 JSON,会走视图流程——轻则报 Template not found,重则输出 HTML 源码或空白页。而 json($data) 返回的是 think\Response\Json 实例,自带 Content-Type: application/json; charset=utf-8 响应头,且默认状态码为 200。

  • 在中间件或控制器开头调用 $request->withJson(true)(仅 TP6.1+)只影响请求体解析,和返回无关,别混淆
  • 若用了 echo json_encode(...); die;,响应头没设、中文可能乱码、fetch().json() 会抛 Unexpected token
  • TP5.1 的 json() 不默认启用 JSON_UNESCAPED_UNICODE,中文会被转成 \u4f60,必须显式传参:json($data, 200, [], ['json_encode_param' => JSON_UNESCAPED_UNICODE])

怎么封装统一返回结构

硬编码每个接口的 json(['code'=>200, 'msg'=>'xxx', 'data'=>$x]) 不可持续。推荐两种落地方式:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • 在 app/common.php 定义助手函数:function api($code = 200, $msg = '操作成功', $data = null, $httpCode = 200) { return json(['code' => $code, 'msg' => $msg, 'data' => $data])->code($httpCode); },控制器中直接 return api(200, 'ok', $user);
  • 建 BaseController,定义 success($data, $msg = '操作成功') 和 error($msg, $code = 400) 方法,子控制器继承后调用 $this->success($user)
  • 避免用 ajaxReturn()(TP5.1 已废弃),继续用会报 Method not found: think\Response::ajaxReturn

带语言标识和 HTTP 状态码的细节处理

多语言 API 不能依赖 json() 自动翻译文案,lang('success') 得手动调用;语言标识建议塞进 JSON body,而不是只靠响应头:

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

  • 返回时显式加 'lang' => app()->getLocale() 字段,app()->getLocale() 是运行时实际语言码(如 zh-cn),不是配置里的默认值
  • HTTP 状态码和业务 code 要分清:权限拒绝该用 throw new \think\exception\HttpException(403, '无操作权限'),表单验证失败需手动 return json(['code'=>422, 'msg'=>$validate->getError()])->code(422)
  • 中间件(如跨域、日志)可能覆盖 Content-Type,可在控制器末尾加 dump(response()->getHeader('Content-Type')) 排查;跨域请用 allowCrossDomain(),别混用 header('Access-Control-Allow-Origin: *')

最容易被忽略的是:语言包必须 UTF-8 无 BOM;json() 不接受资源类型(如 PDOStatement 或 mysqli_result),传之前得先 fetchAll();DateTime 对象会自动转字符串,要自定义格式得先 format('Y-m-d H:i:s')。

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
墨刀AI
墨刀AI Hot

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

DeepSeek

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

豆包大模型

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

WorkBuddy

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

Seko
Seko Hot

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

切问学术

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

立刻MV
立刻MV Hot

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

相关专题

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

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

11364

2023.09.01

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

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

6581

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数据库的详细内容,可以访问下面的文章。

4168

2023.10.23

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

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

4874

2023.10.23

html怎么上传
html怎么上传

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

3831

2023.11.03

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

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

5517

2023.11.09

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

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

4322

2023.11.13

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

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

20

2026.10.22

热门下载

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

精品课程

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

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