Java 中自定义异常类怎么规范命名与设计

轻伟吖_9921

轻伟吖_9921

2026-10-05

650人浏览

原创

java自定义异常需以exception结尾、用“形容词+名词”命名(如usernotfoundexception),按业务域分包(如com.example.app.user.exception),提供四个标准构造器并声明serialversionuid,避免通用基类。

java 中自定义异常类怎么规范命名与设计

Java 中自定义异常类的命名与设计,核心是让异常“一读就懂、一捕就准、一查就明”。不是堆功能,而是靠语义清晰、结构合理、契约明确来支撑长期可维护性。

命名必须以 Exception 结尾,用“形容词+名词”表达业务语义

这是 Java 社区硬性约定,IDE、静态检查工具(如 SonarQube)、Spring 的 @ExceptionHandler 都依赖这个后缀识别异常类型。不加 Exception,哪怕继承了 RuntimeException,也会被当成普通类处理。

  • ✅ 推荐写法:UserNotFoundException、InsufficientBalanceException、InvalidOrderStatusException
  • ❌ 避免写法:MyException(无业务含义)、OrderFail(缺后缀)、ValidateFailedException(动词开头,不符合习惯)、InvldInputExc(缩写难懂)
  • 优先把领域对象前置:用户相关错用 UserLockedException,而不是泛泛的 ResourceLockedException;支付失败用 PaymentTimeoutException,而非 ServiceException

包结构按业务域组织,不塞进通用 exception 包

异常类要和它服务的模块在一起,而不是全扔进 com.example.app.exception 这种大杂烩包里。这样既符合语义归属,也利于模块拆分和 IDE 导入时避免同名冲突。

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 用户模块的异常放在:com.example.app.user.exception
  • 订单模块的异常放在:com.example.app.order.exception
  • 支付模块的异常放在:com.example.app.payment.exception
  • 好处很明显:新人看代码能快速定位异常来源;Maven 拆模块时,异常随业务逻辑天然复用;日志或监控按包路径聚合分析也更精准

构造器必须完整,serialVersionUID 不可省略

框架内部(如 Spring MVC 参数解析、MyBatis SQL 执行)常隐式调用带 message 和 cause 的构造器。少一个,上线后可能因 NoSuchMethodError 崩溃。

  • 必须提供四个标准构造器:
    public XxxException()
    public XxxException(String message)
    public XxxException(Throwable cause)
    public XxxException(String message, Throwable cause)
  • 如需携带业务字段(如 orderId、errorCode),可额外增加构造器,但不能删减上述四个
  • 只要异常可能被序列化(网络传输、日志落盘、跨 JVM 链路追踪),就必须显式声明:
    private static final long serialVersionUID = 1L;
    字段增删或类型变更时,记得同步更新该值(如改为 2L)

慎用通用基类,按错误语义独立建类

别搞一个 MyBusinessException 扛下所有业务错误。这等于放弃 Java 类型系统的编译期检查能力,也让捕获、日志、告警失去分类依据。

  • 调用方无法写 catch (InsufficientBalanceException e) 做针对性处理
  • 方法签名若只写 throws MyBusinessException,等同于 throws Exception,契约失效
  • 同一模块内语义相近的错误(如多种参数校验失败),可用一个异常类,靠 message 或 errorCode 区分;跨模块或本质不同的错误(如库存不足 vs 订单超时),必须分设类名和包路径

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9697

6

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

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

2023.07.05

6842

9

java自学难吗
java自学难吗

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

2023.07.31

6052

8

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

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

2023.08.01

1064

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1276

5

java有什么用
java有什么用

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

2023.08.02

2549

5

java在线网站
java在线网站

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

2023.08.03

19871

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1155

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习