0

0

Python 自定义异常在工程中的设计规范

舞夢輝影

舞夢輝影

发布时间:2026-02-05 18:48:58

|

789人浏览过

|

来源于php中文网

原创

工程中不能直接 raise Exception('xxx'),因其导致错误类型无法区分、日志监控失效、单元测试难断言;应继承具体异常类并按领域语义命名,集中定义、分层设计(领域/基础设施/封装异常),构造函数需保留上下文,__str__ 避免敏感信息,对预期业务分支建议用 Result 类型而非异常。

python 自定义异常在工程中的设计规范

为什么不能直接 raise Exception('xxx')

工程中直接 raise Exception('xxx') 会导致调用方无法区分错误类型,所有异常都落在同一个基类上,没法做针对性处理。比如数据库连接失败、参数校验不通过、第三方服务超时,这三类问题本应触发不同恢复逻辑,但全被 Exception 吞掉后,只能统一打印日志或重启服务。

更实际的问题是:日志监控系统(如 Sentry、ELK)靠异常类名做聚合告警,如果全是 Exception,就失去分类统计意义;单元测试里也很难精准 assertRaises 某个业务场景。

  • 必须继承 Exception 或其子类(如 ValueErrorRuntimeError),不能裸用基类
  • 异常类名要体现领域语义,例如 UserNotFoundErrorPaymentValidationFailed,而不是 MyException
  • 模块内异常建议集中定义在 exceptions.py,避免散落在各处导致重复或遗漏

如何设计分层的异常继承体系

大型项目需要按错误来源和处理责任分层,不是所有异常都要平级定义。常见三层结构:

  • 领域异常(Domain Exceptions):如 InsufficientBalanceError,表示业务规则被违反,调用方应检查输入或引导用户操作
  • 基础设施异常(Infrastructure Exceptions):如 DatabaseConnectionErrorRedisTimeoutError,表示外部依赖不可用,通常需重试或降级
  • 封装异常(Wrapper Exceptions):如 UserServiceError,用于对外暴露统一入口异常,屏蔽内部实现细节

注意:不要为了分层而深继承。例如 class DatabaseConnectionError(InfraError)class InfraError(ServiceError)class ServiceError(Exception) 这种四层链容易让开发者困惑“到底该 catch 哪一层”。一般两层足够:BaseAppError + 具体业务/ infra 异常。

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

轩宇淘宝客系统
轩宇淘宝客系统

轩宇淘宝客是一款适用于淘宝客打折单品推广的程序,无论老手或新手都能短时间内赚取大量佣金的淘宝客网站程序,不同于现在广泛的淘宝客推广网站。本程序可手动添加商品,同时也配置强大的多功能采集插件,可采集评论,也可自定义采集规则,全自动无人值守采集更新网站,无需人工维护。默认提供精美的页面设计模版,超好的用户访问体验,超高转化率。对搜索引擎收录友好,整站伪静态技术,访问速度快,无需等待漫长的生成HTML页

下载

__init__ 和 __str__ 怎么写才利于调试

自定义异常的构造函数别只传 message,要保留原始上下文。尤其当异常是包装底层异常(如把 psycopg2.OperationalError 转成自己的 DatabaseError)时,必须用 cause 参数或 __cause__ 显式关联,否则 traceback 会丢失根因。

class DatabaseError(Exception):
    def __init__(self, operation: str, detail: str = "", original_error: Exception = None):
        self.operation = operation
        self.detail = detail
        self.original_error = original_error
        message = f"DB {operation} failed: {detail}"
        super().__init__(message)

    def __str__(self):
        s = super().__str__()
        if self.original_error:
            s += f" (caused by {type(self.original_error).__name__})"
        return s
  • 避免在 __str__ 里拼接敏感数据(如密码、token),生产环境可能被日志明文记录
  • 如果异常带字段(如 self.user_id),确保这些字段能被结构化日志采集器(如 structlog)自动提取
  • 不要重载 __repr__,除非有明确序列化需求;默认行为已足够调试

什么时候该用异常,什么时候该返回 Result 类型

Python 没有内置 Result 类型,但像 result 库或手写的 Ok/Error 元组,在某些场景比抛异常更合适——尤其是错误是正常业务流一部分时。例如用户登录时邮箱格式错误,这不是“异常情况”,而是预期中的输入校验分支。

  • 用异常:表示「程序无法继续执行」或「契约被破坏」,如文件不存在却必须读取、HTTP 500 响应、数据库事务中断
  • 用返回值:表示「有多种合法结果」,如搜索接口查无结果(NoneResult.empty())、API 返回 404(可转为 NotFound 对象而非抛异常)
  • 混用风险:同一模块里既抛 UserNotFoundError 又返回 Optional[User],会让调用方无所适从。建议按模块职责约定:DAO 层可用异常,Service 层倾向返回值,API 层再根据 HTTP 状态码决定是否转为异常

真正难处理的不是定义异常,而是团队对“什么算错误”的认知是否一致。一个 OrderAlreadyPaidError 在支付网关模块是 fatal,在订单查询模块可能只是返回 False —— 这种差异必须写进接口文档,而不是靠异常名猜。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

309

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

317

2023.10.25

登录token无效
登录token无效

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

6296

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

825

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1075

2023.12.21

token什么意思
token什么意思

token是一种用于表示用户权限、记录交易信息、支付虚拟货币的数字货币。可以用来在特定的网络上进行交易,用来购买或出售特定的虚拟货币,也可以用来支付特定的服务费用。想了解更多token什么意思的相关内容可以访问本专题下面的文章。

1462

2024.03.01

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1258

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

275

2025.10.17

java连接字符串方法汇总
java连接字符串方法汇总

本专题整合了java连接字符串教程合集,阅读专题下面的文章了解更多详细操作。

7

2026.02.05

热门下载

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

精品课程

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

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 3.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.4万人学习

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

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