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

TP6接口返回状态码规范的实现

老瑶酱_4422

老瑶酱_4422

发布时间:2026-08-17 16:23:53

|

196人浏览过

|

来源于php中文网

原创

TP6接口返回状态码规范要求HTTP状态码与业务状态码分层使用:HTTP码(如200/404/500)标识传输层结果,业务码(如1/-1/1001)表达逻辑结果;需配置集中管理、封装统一响应函数show()、控制器中规范调用,并严格区分二者职责边界。

tp6接口返回状态码规范的实现

TP6 接口返回状态码规范的核心是分层统一、语义明确、可维护强:HTTP 状态码管传输层(如 200/404/500),业务状态码管逻辑层(如 1 表成功、-1 表未登录),两者不混用、不替代。

一、定义清晰的业务状态码配置

在 config/ 目录下新建 status.php 或 code.php,集中管理所有业务含义:

  • 避免硬编码数字,例如不用 return ['code' => 1, ...],而用 config('code.success')
  • 推荐结构含「语义键 + 数值 + 可选描述」,例如:
    return [
        'success'      => 1,
        'error'        => 0,
        'need_login'   => -1,
        'invalid_param'=> 1001,
        'not_found'    => 1002,
        'rate_limit'   => 1003,
    ];
  • 配置文件中不写逻辑,只作映射;后续所有控制器、服务层都通过 config('code.xxx') 引用

二、封装统一响应函数(推荐放在 app/common.php)

定义一个轻量、无副作用的全局函数,兼顾灵活性与一致性:

  • 函数签名建议为 show($code, $msg = '', $data = [], $httpCode = 200)
  • $code 传业务码(如 config('code.success')),$httpCode 仅控制 HTTP 层(默认 200,错误时可设 400/422/500)
  • 若 $msg 为空且该 $code 在配置中有对应文案,则自动填充,提升可维护性
  • 最终强制走 json(),不拼接字符串、不 echo、不 return 数组

三、控制器中规范使用方式

禁止直接 return ['code'=>1, 'msg'=>'ok'] 或 echo json_encode(...),应统一调用封装函数:

  • 成功返回:return show(config('code.success'), '操作成功', $user);
  • 参数错误:return show(config('code.invalid_param'), '手机号格式不正确', [], 400);
  • 需登录:return show(config('code.need_login'), '请先登录', null, 401);
  • 数据库查不到:return show(config('code.not_found'), '用户不存在', [], 404);

四、注意 HTTP 状态码与业务码的协作边界

二者职责分明,不可互相覆盖或隐藏问题:

  • HTTP 200 表示请求被服务器正常接收并处理完毕,不代表业务成功(业务成功由 code=1 表达)
  • HTTP 4xx/5xx 应用于客户端错误或服务端异常场景,例如参数校验失败用 400、资源不存在用 404、内部错误用 500
  • 不要为所有失败都返回 200 + code=0 —— 这会让前端无法区分网络失败、超时、服务崩溃等真实问题
  • 前端可通过响应头 Status 或 Axios 的 response.status 快速识别传输层问题,再解析 body.code 做业务分支

热门AI工具

更多
WorkBuddy

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

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

DeepSeek

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

VibeKnow
VibeKnow Hot

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

立刻MV
立刻MV Hot

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

蛙蛙写作

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3208

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

5169

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3849

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

486

2026.01.19

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

80

2026.10.28

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

60

2026.10.28

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

200

2026.10.28

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

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

140

2026.10.22

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

120

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
JavaScript OOP调试技巧视频教程
JavaScript OOP调试技巧视频教程

共5课时 | 1.1万人学习

http状态码大全
http状态码大全

共47课时 | 119万人学习

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

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