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

Python 对外接口错误码的设计规范

千瑶吖_2949

千瑶吖_2949

发布时间:2026-02-22 21:42:12

|

247人浏览过

|

来源于php中文网

原创

错误码应使用带前缀的字符串枚举而非数字,如"auth_token_expired",以提升可读性、可搜索性和版本可控性,并避免歧义与硬编码问题。

python 对外接口错误码的设计规范

错误码该不该用数字?

数字错误码看似直观,但实际协作中极易引发歧义——4001 到底是“参数缺失”还是“用户未登录”?不同模块各自定义,前端硬编码比对,后期改一个码就得全链路排查。更麻烦的是,数字无法携带语义,日志里只看到 error_code=5003,不翻文档根本不知道发生了什么。

推荐做法:全部使用带前缀的字符串枚举,例如 "auth_token_expired"、"payment_amount_too_low"。这样既可读、可搜索、可版本化,又避免整数溢出或类型混淆(比如 Python 里误把 int 当 str 传给 JSON 序列化)。

常见错误现象:

  • 后端返回 4001,前端写死 if code === 4001,结果某次发布悄悄改成 4002,接口直接挂掉
  • 错误码混用 HTTP 状态码含义(如用 500 表示“余额不足”,掩盖真实服务异常)

如何组织错误码常量?

别散落在各个 view 或 service 文件里。所有错误码必须集中定义、唯一来源,否则复制粘贴一次,就埋下三个不一致的坑。

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

实操建议:

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
  • 新建 errors.py,用 Enum 定义(Python 3.4+),每个成员值为元组:("auth_token_expired", "Token 已过期,请重新登录")
  • 对外只暴露 .code 和 .message 属性,禁止直接用字符串字面量
  • 加一层 make_error_response() 工具函数,统一包装成 {"code": "...", "message": "...", "data": null} 结构
  • 如果支持多语言,message 字段留空,靠前端根据 code 查 i18n 表,后端绝不拼接中文

HTTP 状态码和业务错误码怎么配合?

HTTP 状态码不是摆设,也不是万能筐。它表达的是通信层/协议层状态,不是业务逻辑状态。

正确姿势:

  • 401 只用于认证失败(无 token / token 格式错),403 用于鉴权失败(token 有效但权限不足)
  • 业务错误如“库存不足”“订单已取消”,一律返回 200 + 自定义 code 字段,避免前端把 400 当网络错误重试
  • 真正需要重试的场景(如临时性限流),才用 429;服务器崩溃必须是 500,不能用 200 + "server_internal_error" 掩盖

性能影响:滥用非 200 状态码会触发浏览器/网关默认重试逻辑,可能造成重复扣款等严重后果。

要不要给错误码加分类层级?

简单项目不需要。一上来就设计 "USER_001"、"ORDER_002" 这类带模块前缀的码,反而增加维护成本——模块拆分、合并、重命名时,错误码得跟着动,但调用方未必同步更新。

更务实的做法:

  • 初期用扁平命名:"insufficient_balance"、"order_not_found"
  • 当错误码数量超 50 个、且明显归属多个子域时,再按模块拆包,例如 user_errors.InsufficientBalance、order_errors.OrderNotFound
  • 永远不要在错误码里塞动态内容(如 "user_123_not_found"),这会让前端无法做静态判断,也破坏日志聚合分析

容易被忽略的一点:错误码的变更必须向后兼容。新加码可以,但已有码的含义绝不能变——哪怕它当初起名起错了,也得将错就错,另起新码替代。

热门AI工具

更多
UpDream
UpDream Hot

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

咔片AIPPT

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

DeepSeek

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

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

Seko
Seko Hot

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

墨刀AI
墨刀AI Hot

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2035

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2962

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1016

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

3339

2025.09.10

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

529

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1678

2024.03.01

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

5924

2023.10.24

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

12866

2023.09.14

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

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

100

2026.09.30

热门下载

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

精品课程

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

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