Java 中自定义异常怎么规范命名错误编码规则

夏浩吖_6368

夏浩吖_6368

2026-10-25

690人浏览

原创

java自定义异常必须以exception结尾并用大驼峰命名,错误码需枚举强绑定,消息要含动态上下文;如ordernotfoundexception、user_not_found、"订单号tx20261016001库存不足"。

java 中自定义异常怎么规范命名错误编码规则

Java 自定义异常的命名和错误编码规则不是风格选择,而是工程契约——它直接影响 IDE 识别、框架匹配、日志归类、团队协作和线上问题定位效率。

异常类名必须以 Exception 结尾,且用大驼峰命名

这是 JVM 生态的硬性约定,不是建议:

  • 所有标准异常(NullPointerException、IllegalArgumentException)都严格遵循该后缀;
  • Spring 的 @ExceptionHandler、IDE 的 Ctrl+Click 跳转、SonarQube 静态检查、Mockito 异常模拟等,全部依赖这个后缀做类型识别;
  • 写成 UserError 或 InvalidOrder,哪怕继承了 RuntimeException,也会被当成普通类处理,导致捕获失败或编译警告。

正确示例:OrderNotFoundException、InsufficientBalanceException、ExpiredTokenException;
错误示例:UserException(语义模糊)、InvalidUserInput(缺后缀)、invld_input_exc(小写+下划线,违反 Java 类名规范)。

名称要直白体现业务语义,优先形容词+名词结构

命名目标不是“分类”,而是让调用方一眼看懂问题本质:

Java注释规范Skills
Java注释规范Skills

当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。

下载
  • 用户余额不足时,用 InsufficientBalanceException 比 PaymentException 更精准;
  • 订单状态非法时,用 InvalidOrderStatusException 比 OrderException 更明确;
  • 推荐结构:形容词 + 名词(如 MissingRequiredFieldException、ExpiredTokenException);
  • 避免动词开头(如 ValidateFailedException)、缩写(如 InvldInputExc)、笼统命名(如 MyException、BusinessRuntimeException)。

错误码需统一管理,推荐用枚举 + 异常类强绑定

错误码不能是散落在各处的字符串或数字,必须可读、可查、可维护:

  • 格式采用 模块_动作/状态,如 USER_NOT_FOUND、ORDER_CREATE_FAILED、PAYMENT_TIMEOUT;
  • 避免纯数字(如 1001),不便于搜索、理解和协作;
  • 每个码对应唯一语义,上线后不可变更含义,废弃需显式标注;
  • 通过枚举集中定义,含错误码、提示文案、HTTP 状态码等字段,并在自定义异常构造时传入,实现强绑定。

示例枚举:

public enum BizErrorCode {
    USER_NOT_FOUND("USER_001", "用户不存在", HttpStatus.NOT_FOUND),
    ORDER_INVALID_STATUS("ORDER_003", "订单状态非法", HttpStatus.BAD_REQUEST);
    private final String code;
    private final String message;
    private final HttpStatus httpStatus;
    // 构造与 getter 省略
}

异常类需携带上下文,消息内容要含关键变量

错误信息不是口号,而是排查依据:

  • 抛出时不要只写 "操作非法",而应包含动态上下文,如 "用户ID=12345的状态不支持此操作" 或 "订单号TX20261016001库存不足";
  • 若需传递业务 ID、时间戳、请求号等,可在异常类中添加字段(如 private String orderId;),并在构造器中接收;
  • 消息拼接应在抛出点完成,不在构造器里做远程调用或日志输出,保持轻量。

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

相关专题

更多
java
java

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

2023.06.15

11197

6

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

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

2023.07.05

8302

9

java自学难吗
java自学难吗

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

2023.07.31

7172

8

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

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

2023.08.01

1204

3

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

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

2023.08.02

968

3

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

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

2023.08.02

1436

5

java有什么用
java有什么用

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

2023.08.02

2949

5

java在线网站
java在线网站

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

2023.08.03

20211

3

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

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

2023.08.03

1295

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习