0

0

在Java里异常命名有什么规范_Java异常命名约定说明

P粉602998670

P粉602998670

发布时间:2026-01-21 16:55:07

|

892人浏览过

|

来源于php中文网

原创

Java自定义异常必须以Exception结尾并用大驼峰命名,因JDK、IDE、框架和工具均依赖该后缀识别异常类型;命名需体现具体业务场景,如InsufficientBalanceException;多数业务异常应继承RuntimeException,不加Runtime前缀;包路径要体现领域层级,并封装errorCode字段。

在java里异常命名有什么规范_java异常命名约定说明

Java自定义异常必须以 Exception 结尾,且用大驼峰命名(PascalCase),否则就不是合格的异常类——这是JVM生态里最基础、最不容妥协的约定。

为什么必须以 Exception 结尾?

这不是风格偏好,而是类型识别契约。JDK标准库所有异常(NullPointerExceptionIOExceptionIllegalArgumentException)都严格遵循该后缀;IDE、日志框架、Spring异常处理器、甚至静态分析工具(如SpotBugs)都依赖这个命名特征做自动识别和分类。

  • 不加 Exception:IDE不会高亮为异常类型,catch 块无法匹配,throws 声明报错
  • 写成 InvalidUserErrorUserException:前者被当成 Error 子类(严重不可恢复),后者语义模糊,团队协作时没人敢确定它是业务异常还是技术异常
  • 小写或下划线(如 invalid_user_exception):违反Java类名规范,编译器虽不拦,但会被SonarQube等工具标为“命名违规”

怎么起一个真正有用的异常名?

名字要像错误日志一样能直接回答“谁在什么场景下因何失败”。避免泛化词(如 BusinessExceptionSystemException),优先绑定具体业务动词+名词。

  • ✅ 推荐:InsufficientBalanceExceptionOrderAlreadyPaidExceptionProductOutOfStockException
  • ❌ 避免:BalanceException(缺动词,不知是“不足”还是“超限”)、PayException(太宽泛,支付失败?支付超时?支付签名错?)
  • ⚠️ 注意:若涉及分层(如DAO/Service),可在包路径中体现,类名本身不强行加 DaoService 前缀——com.example.order.exception.OrderNotFoundExceptionOrderServiceException 更清晰

继承 RuntimeException 还是 Exception?命名要不要体现这点?

绝大多数业务异常应继承 RuntimeException(即“非检查异常”),让调用方按需捕获,而非强制 try-catchthrows。命名上不建议RuntimeChecked 前缀(如 RuntimeValidationException)——这会增加认知负担,且无实际约束力。

燕雀Logo
燕雀Logo

为用户提供LOGO免费设计在线生成服务

下载

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

  • ✅ 正确做法:统一用 XXXException 命名,通过继承关系区分语义,例如:
    public class PaymentFailedException extends RuntimeException { ... }
  • ❌ 不推荐:CheckedPaymentException —— 既没解决检查逻辑,又让名字变长,还可能误导人以为它必须被声明
  • ? 关键判断点:如果这个异常代表“业务规则被违反”(如余额不足、库存不够),就用 RuntimeException 子类;如果代表“外部系统暂时不可用”(如数据库连不上、HTTP调用超时),才考虑继承 Exception 并强制上层处理

容易被忽略的细节:包结构与错误码耦合

光有好名字不够,异常类必须放在合理包路径下,并配合错误码设计,否则名字再准也白搭。

  • 包路径应反映领域层级:com.example.payment.exception 而非 com.example.common.exception——后者会让所有模块异常混在一起,失去业务上下文
  • 异常类内部最好封装 errorCode 字段(如 private final int errorCode = 4001;),前端或监控系统靠它做精准响应,而不是解析 getMessage() 字符串
  • 别把“命名规范”当孤立任务:一个 OrderNotFoundException 如果抛出时没带订单ID、没记录traceId、没关联错误码,那名字再标准也没法快速定位问题

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

841

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

742

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

738

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

399

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

7

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.7万人学习

C# 教程
C# 教程

共94课时 | 7.2万人学习

Java 教程
Java 教程

共578课时 | 48.8万人学习

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

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