PHP实现API风格统一_统一错误码和错误信息规范【介绍】

云丽小哥_8887

云丽小哥_8887

2026-05-10

392人浏览

原创

统一错误码和错误信息必须做,关键在于规范定义、分层处理与结构统一:集中管理带语义前缀的错误码(如user_001),区分http状态码与业务码,固定响应结构,全程保留上下文并强化日志与测试。

php实现api风格统一_统一错误码和错误信息规范【介绍】

直接说结论:统一错误码和错误信息不是“要不要做”的问题,而是“怎么做才不翻车”的问题。硬编码字符串、随意返回 200 套错误体、把 500 当万能兜底——这些做法在小项目里能跑,在联调或上线后必然被前端拉清单、被运维查日志、被自己半夜改 bug。

错误码必须集中定义,且带语义分段

把所有错误码塞进一个数组或常量类里,是底线要求;但更关键的是结构要有可读性。比如 USER_001 比 1001 更容易定位模块和问题类型。

  • 前缀(如 USER、ORDER、DB)明确归属域,避免跨模块冲突
  • 后缀编号(如 001)按错误严重程度或发生频率递增,方便排序和文档索引
  • 禁止用纯数字码(如 1001)直接写死在控制器里,否则改一个要 grep 全局
  • 每个码必须对应一条可读的 message,且支持占位符(如 "用户 <code>{id} 不存在"),便于动态填充

HTTP 状态码不能和业务码混为一谈

很多 PHP 项目习惯全用 200 + 自定义 code 字段返回所有结果,这会让 Nginx 日志、CDN 缓存、前端 fetch 的 response.ok 判断全部失效。

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

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

下载
  • 400 用于参数校验失败(如缺失字段、格式错误)
  • 401 仅用于 token 过期或未携带认证头,不是“登录态失效”的万能码
  • 403 表示权限不足(有身份但无操作权),不是“接口不存在”的替代品
  • 404 必须真实对应资源未找到(如 GET /users/9999),而不是用来掩盖路由错误
  • 500 只留给未捕获异常,业务逻辑里的可预期错误(如余额不足)绝不能扔给它

错误响应体结构必须固定,且兼容 RFC7807

前端最怕的不是报错,而是每次都要重写解析逻辑。一个字段名从 msg 变成 message,就能让 JS 报 undefined。

  • 顶层字段强制三选一:code(业务码)、message(人类可读提示)、data(空对象或 null,不可省略)
  • 拒绝出现 error、errmsg、status 等非标字段,历史包袱用中间件转换,不放行到新接口
  • 推荐引入 phpro/api-problem,它生成的 JSON 自动带 type、title、detail,且状态码直透 HTTP 层,不用手动 http_response_code()
  • 如果不用第三方包,至少确保所有 error() 方法最终调用同一个封装函数,例如 api_error($code, $message, $details = [])

别忽略错误码的传播路径和调试成本

一个 ORDER_CANCEL_FAILED 错误从数据库层抛出,经过 service → controller → response,中间每层都可能丢失上下文或覆盖原始码。

  • 数据库异常不要直接转成 DB_ERROR 就完事,应结合 PDO 的 $e->getCode() 和 SQLSTATE 做细分(如唯一约束失败 vs 连接超时)
  • 中间件里捕获异常时,优先从异常对象里提取预设的 getErrorCode() 方法,而不是靠 get_class() 匹配字符串
  • 日志记录必须同时打:HTTP 状态码、业务错误码、trace_id、原始异常 message,缺一不可
  • 测试时用 PHPUnit 断言响应体的 code 和 message,而不仅是 HTTP 状态码

真正难的不是定义一百个错误码,而是在新增接口时,下意识去查 errors.php 而不是随手写个 "操作失败,请重试"。这个动作是否发生,决定了你的 API 是“能用”,还是“敢交出去”。

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

相关文章

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

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

下载

相关标签:

php

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

相关专题

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

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

2023.09.01

10424

6

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

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

2023.10.11

6121

5

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

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

2023.10.11

2115

5

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

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

2023.10.23

3868

4

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

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

2023.10.23

4554

6

html怎么上传
html怎么上传

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

2023.11.03

3571

9

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

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

2023.11.09

5117

8

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

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

2023.11.13

4002

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11982

4

热门下载

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

精品课程

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

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

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

共0课时 | 0人学习