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

在Java里异常信息应该如何规范编写_Java异常提示规范说明

陌萱小哥_4505

陌萱小哥_4505

发布时间:2026-01-31 12:47:02

|

712人浏览过

|

来源于php中文网

原创

异常信息须含可定位上下文:明确类/方法、操作对象及失败原因;禁用泛化消息;自定义异常需重写getMessage()且不抛新异常;业务校验不用异常;包装异常须保留真实cause链。

在java里异常信息应该如何规范编写_java异常提示规范说明

异常信息必须包含“可定位的上下文”

Java里抛出的异常如果只写 "Error occurred" 这类泛化消息,等于没写。调用方根本无法判断是参数错、资源不可用,还是逻辑分支没覆盖。真正有用的异常信息要能回答三个问题:在哪发生的(类/方法)、对什么操作失败了(关键输入或状态)、为什么失败(直接原因)。

实操建议:

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

cn-json-diff
cn-json-diff

比较两个 JSON 文件并显示差异。支持嵌套结构、数组及值变更。纯 Python 标准库实现,无需 API 密钥。

下载
  • 用模板句式:"Failed to [verb] [resource/object] due to [specific cause]",例如 "Failed to parse JSON string 'user_data' due to malformed UTF-8 byte sequence"
  • 避免在消息里拼接敏感数据(如密码、token),可用占位符代替:"Failed to connect to database at jdbc:mysql://***:3306/mydb"
  • 不要依赖日志级别来“补全”信息——catch 块里 log.error("xxx", e) 的日志内容,和 e.getMessage() 应该各自完整,不能互相依赖

自定义异常类必须重写 getMessage() 且不抛出新异常

很多团队建了 UserNotFoundException 却没重写 getMessage(),导致实际抛出时只有类名,或者重写时又调用了可能抛异常的方法(比如去查数据库拼消息),这会让原始错误被掩盖甚至引发 StackOverflowError。

实操建议:

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

  • 所有自定义异常必须显式覆写 getMessage(),且只基于构造时传入的字段拼接,不调用外部方法
  • 推荐构造函数签名统一为:public MyException(String message, Throwable cause) 和 public MyException(String template, Object... args)(用 String.format 安全填充)
  • 禁止在 getMessage() 中做格式化失败兜底(比如 try-catch 吞掉 IllegalFormatException),那说明模板本身就有问题,该在测试阶段暴露

不要用异常信息替代业务校验提示

用户提交手机号为空,后端抛 IllegalArgumentException("phone is null") 并返回 HTTP 500,这是典型误用。异常是给开发者看的故障信号,不是给终端用户读的友好提示。

实操建议:

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

  • 参数校验失败、业务规则拒绝等预期场景,应走正常返回路径(如 ResponseEntity.badRequest().body(...)),附带结构化错误码和用户语言提示
  • 异常仅用于非预期路径:文件突然被删、远程服务无响应、JSON 解析器内部状态损坏等“程序不该走到这里”的情况
  • 若框架强制要求异常转响应(如 Spring 的 @ExceptionHandler),也要在 handler 里剥离技术细节,重新组装面向用户的提示,而不是直接返回 e.getMessage()

getCause() 链必须保持真实且不截断

常见错误是捕获异常后“美化”再抛出:throw new ServiceException("Operation failed", e.getCause()),结果把中间一层 SQLException 给丢了,只剩最外层包装。调试时看到的是 ServiceException 套着 NullPointerException,但真实根因是数据库连接池耗尽。

实操建议:

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

  • 包装异常时,始终用原始异常作 cause,不要取 e.getCause() 再传——除非你明确知道那层是冗余噪音(极少见)
  • 避免多层无意义包装:不要从 IOException → DaoException → ServiceException → ApiException,保留两层以内更利于归因
  • 日志打印时务必用 logger.error("xxx", e) 而不是 logger.error("xxx " + e.getMessage()),否则堆栈链丢失
异常信息规范最难的部分不在写法,而在团队对“什么是预期/非预期”的共识。同一段代码,有人觉得空指针是bug,有人觉得是前端没校验——这种分歧会直接反映在异常层级和消息粒度上。别指望靠文档一次性对齐,得靠 Code Review 时具体问:“这个异常,运维看到第一条消息能立刻执行哪条命令?”

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

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

UP简历
UP简历 Hot

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

墨刀AI
墨刀AI Hot

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

相关专题

更多
mysql修改数据表名
mysql修改数据表名

MySQL修改数据表:1、首先查看数据库中所有的表,代码为:‘SHOW TABLES;’;2、修改表名,代码为:‘ALTER TABLE 旧表名 RENAME [TO] 新表名;’。php中文网还提供MySQL的相关下载、相关课程等内容,供大家免费下载使用。

2473

2023.06.20

MySQL创建存储过程
MySQL创建存储过程

存储程序可以分为存储过程和函数,MySQL中创建存储过程和函数使用的语句分别为CREATE PROCEDURE和CREATE FUNCTION。使用CALL语句调用存储过程智能用输出变量返回值。函数可以从语句外调用(通过引用函数名),也能返回标量值。存储过程也可以调用其他存储过程。php中文网还提供MySQL创建存储过程的相关下载、相关课程等内容,供大家免费下载使用。

1499

2023.06.21

mongodb和mysql的区别
mongodb和mysql的区别

mongodb和mysql的区别:1、数据模型;2、查询语言;3、扩展性和性能;4、可靠性。本专题为大家提供mongodb和mysql的区别的相关的文章、下载、课程内容,供大家免费下载体验。

875

2023.07.18

mysql密码忘了怎么查看
mysql密码忘了怎么查看

MySQL是一个关系型数据库管理系统,由瑞典MySQL AB 公司开发,属于 Oracle 旗下产品。MySQL 是最流行的关系型数据库管理系统之一,在 WEB 应用方面,MySQL是最好的 RDBMS 应用软件之一。那么mysql密码忘了怎么办呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

3512

2023.07.19

mysql创建数据库
mysql创建数据库

MySQL是一个关系型数据库管理系统,由瑞典MySQL AB 公司开发,属于 Oracle 旗下产品。MySQL 是最流行的关系型数据库管理系统之一,在 WEB 应用方面,MySQL是最好的 RDBMS 应用软件之一。那么mysql怎么创建数据库呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

6068

2023.07.25

mysql默认事务隔离级别
mysql默认事务隔离级别

MySQL是一种广泛使用的关系型数据库管理系统,它支持事务处理。事务是一组数据库操作,它们作为一个逻辑单元被一起执行。为了保证事务的一致性和隔离性,MySQL提供了不同的事务隔离级别。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

1299

2023.08.08

sqlserver和mysql区别
sqlserver和mysql区别

SQL Server和MySQL是两种广泛使用的关系型数据库管理系统。它们具有相似的功能和用途,但在某些方面存在一些显著的区别。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

6331

2023.08.11

mysql忘记密码
mysql忘记密码

MySQL是一种关系型数据库管理系统,关系数据库将数据保存在不同的表中,而不是将所有数据放在一个大仓库内,这样就增加了速度并提高了灵活性。那么忘记mysql密码我们该怎么解决呢?php中文网给大家带来了相关的教程以及其他关于mysql的文章,欢迎大家前来学习阅读。

5442

2023.08.14

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL vs MySQL
PostgreSQL vs MySQL

共1课时 | 194人学习

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

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