0

0

Python错误码设计教程_接口异常统一规范

冷漠man

冷漠man

发布时间:2026-01-07 15:20:02

|

505人浏览过

|

来源于php中文网

原创

Python接口错误码需语义明确、层级分明、可扩展、不重复,推荐三位或四位分段编码(如2001表示用户模块参数错误),首位数字标识大类(1系统/2用户/3数据/4参数/5服务端/6第三方),后位标识具体场景;须用Enum定义并继承统一异常基类,配合HTTP状态码协同使用(如400+4001),禁止魔数硬写或滥用200响应业务错误,且需文档化、版本化管理。

python错误码设计教程_接口异常统一规范

Python接口开发中,错误码不是随便编个数字就行,关键是要让前后端协作高效、排查问题快速、后期维护清晰。核心原则是:语义明确、层级分明、可扩展、不重复。

错误码结构设计:三位或四位分段式编码

推荐采用 三位十进制数(如 100401503)或 四位分段编码(如 2001 表示「用户模块-参数错误」),兼顾HTTP状态码习惯与业务可读性。

  • 首位数字表示错误大类:1=通用/系统级,2=用户/权限类,3=数据类(查不到、冲突),4=参数/客户端错误,5=服务端异常,6=第三方调用失败
  • 后两位(或后三位)标识具体场景:例如 401 是标准未授权,但业务中可定义 2001(用户不存在)、2002(密码错误)、2003(账号被禁用)
  • 避免使用纯顺序编号(如 1001、1002…),否则无法一眼识别归属模块;也别直接复用HTTP状态码做全部业务码(比如用 404 表示“订单不存在”可以,但不能用 404 表示“库存不足”)

统一异常基类 + 枚举管理错误码

不靠字符串拼接或魔法数字硬写,而是用 Python 枚举(Enum)定义所有错误码,并继承一个自定义异常基类,确保抛出、捕获、序列化行为一致。

  • 定义 ErrorCode 枚举,每个成员包含 code(数字)、message(中文提示)、http_status(对应HTTP状态,如400/401/500)
  • 实现 APIException 基类,接收枚举实例初始化,自动携带 code/message/status
  • 全局异常处理器(如 FastAPI 的 @app.exception_handler(APIException) 或 Flask 的 errorhandler)统一返回 JSON 格式:{"code": 2001, "message": "用户不存在", "data": null}

错误码与 HTTP 状态码协同,不强行一一映射

HTTP 状态码表达的是通信/协议层语义(如 400=请求无效,500=服务炸了),而业务错误码表达的是领域逻辑结果(如“优惠券已用完”“实名认证未通过”)。二者应配合,而非替代。

Yellow.ai
Yellow.ai

帮您打造企业级对话式AI平台

下载

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

  • 参数校验失败 → HTTP 400 + 业务码 4001
  • 未登录/Token过期 → HTTP 401 + 业务码 2004
  • 数据库唯一约束冲突 → HTTP 409 + 业务码 3002
  • 下游服务超时 → HTTP 503 + 业务码 6003
  • 绝不用 200 响应体里塞一个 "code": 500 —— 这会绕过前端的网络错误拦截逻辑

配套文档与演进管理:错误码不是写完就扔

错误码是接口契约的一部分,必须和 OpenAPI 文档、SDK、前端常量表同步更新。

  • pydantic 模型定义标准响应结构,把 code 字段类型设为 Literal 或关联枚举,支持 IDE 提示和校验
  • 在 Swagger / Redoc 文档中标注每个接口可能返回的错误码及含义(可用 x-code-samples 或自定义字段)
  • 新增错误码必须走 CR(Code Review),禁止私下添加;废弃错误码保留历史记录,标记 deprecated,至少保留一个大版本
  • 建议生成一份可搜索的 error_codes.md,按模块/场景分类,附 HTTP 状态、典型触发条件、建议前端处理方式

不复杂但容易忽略:错误码的价值不在定义那一刻,而在每一次被准确抛出、被前端友好展示、被日志精准归因、被新同学快速看懂。从第一个接口开始就定好规范,后面省下的调试时间远超初期多写的那几十行代码。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

734

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

631

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

755

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1259

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

705

2023.08.11

java学习网站推荐汇总
java学习网站推荐汇总

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

5

2026.01.08

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号