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=服务炸了),而业务错误码表达的是领域逻辑结果(如“优惠券已用完”“实名认证未通过”)。二者应配合,而非替代。

自由画布
自由画布

百度文库和百度网盘联合开发的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 状态、典型触发条件、建议前端处理方式

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Flask框架
Python Flask框架

本专题专注于 Python 轻量级 Web 框架 Flask 的学习与实战,内容涵盖路由与视图、模板渲染、表单处理、数据库集成、用户认证以及RESTful API 开发。通过博客系统、任务管理工具与微服务接口等项目实战,帮助学员掌握 Flask 在快速构建小型到中型 Web 应用中的核心技能。

98

2025.08.25

Python Flask Web框架与API开发
Python Flask Web框架与API开发

本专题系统介绍 Python Flask Web框架的基础与进阶应用,包括Flask路由、请求与响应、模板渲染、表单处理、安全性加固、数据库集成(SQLAlchemy)、以及使用Flask构建 RESTful API 服务。通过多个实战项目,帮助学习者掌握使用 Flask 开发高效、可扩展的 Web 应用与 API。

78

2025.12.15

json数据格式
json数据格式

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

450

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

326

2023.10.13

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

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

81

2025.09.10

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

28

2025.12.22

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

249

2026.02.06

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

24

2026.02.28

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.6万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.7万人学习

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

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