0

0

Python接口异常处理规范_错误码设计解析【技巧】

冷炫風刃

冷炫風刃

发布时间:2025-12-25 21:41:29

|

813人浏览过

|

来源于php中文网

原创

错误码需全局唯一、语义明确,统一用常量类管理;异常须分层捕获并映射到对应错误码;返回结构固定为code/msg/data,msg须静态化、国际化友好;自定义异常应继承basebusinesserror并带code属性。

python接口异常处理规范_错误码设计解析【技巧】

错误码必须全局唯一且语义明确

Python接口返回的错误码不是随便编的数字,400500这类HTTP状态码不能替代业务错误码。业务错误码要能直接对应到具体问题类型,比如用户未登录是1001,参数缺失是1002,库存不足是2003。避免用0-1这种泛化值表示所有失败——前端无法据此做差异化处理。

建议用常量类统一管理:

class ErrorCode:
    USER_NOT_LOGIN = 1001
    PARAM_MISSING = 1002
    INSUFFICIENT_STOCK = 2003
    ORDER_NOT_FOUND = 3001

不要把错误码硬编码return里,也不要分散在多个模块中定义。

异常捕获要分层:HTTP层不吞业务异常

FastAPI/Flask等框架里,常见错误是把所有异常都用try...except Exception:包住,然后统一返回{"code": 500, "msg": "服务器错误"}。这会让调试变困难,也掩盖了本该由客户端处理的业务异常(如重复提交、余额不足)。

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

正确做法是分三级捕获:

  • 捕获已知业务异常(如InsufficientStockError),映射到对应ErrorCode.INSUFFICIENT_STOCK
  • 捕获ValidationError等框架级异常,转为ErrorCode.PARAM_MISSING
  • 只对真正未预期的Exception兜底,记录日志并返回500 + 通用提示

关键点:raise InsufficientStockError()return {"code": 2003, ...}更利于测试和链路追踪。

LOGO.com
LOGO.com

在线生成Logo,100%免费

下载

错误信息字段要分离code/msg/data

返回结构必须稳定,不能因为调试需要就临时加debug_info字段,也不能把错误详情全塞进msg里。标准格式应为:

{
  "code": 1002,
  "msg": "缺少必要参数:user_id",
  "data": null
}

msg面向前端用户或调用方,需中文、简洁、无技术术语;data可选,用于携带补救信息(如重试时间、跳转链接);真正的堆或上下文必须进日志,不返给客户端。

特别注意:msg不能拼接变量(如f"用户{uid}不存在"),否则无法被前端国际化或埋点统计——应固定文案,靠data传动态值。

自定义异常类必须继承Exception且带code属性

写一个BaseBusinessError作为基类,强制子类提供codemessage

class BaseBusinessError(Exception):
    def __init__(self, code: int, message: str):
        self.code = code
        self.message = message
        super().__init__(message)

class ParamMissingError(BaseBusinessError):
    def __init__(self, field: str):
        super().__init__(ErrorCode.PARAM_MISSING, f"缺少必要参数:{field}")

这样中间件才能统一识别并序列化。别用ValueErrorRuntimeError代替——它们没有code属性,后续扩展会卡死。

还有个易忽略点:异常类名要体现领域,比如PaymentTimeoutErrorTimeoutError更安全,后者容易和标准库冲突。

热门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 应用中的核心技能。

104

2025.08.25

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

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

81

2025.12.15

什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

182

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

226

2025.12.18

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 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

251

2026.02.06

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

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

1566

2023.10.24

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

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

1566

2023.10.24

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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