Java 中怎么编写带有错误码的自定义业务异常

小枫小哥_1996

小枫小哥_1996

2026-10-30

992人浏览

原创

Java中自定义带错误码的业务异常需定义枚举统一管理错误码(如INVENTORY_SHORTAGE),再继承RuntimeException封装枚举实例,支持格式化参数和HTTP状态码,实现语义清晰、可统一处理的结构化异常。

java 中怎么编写带有错误码的自定义业务异常

在 Java 中编写带有错误码的自定义业务异常,核心是让异常既能携带可读的业务语义(如“库存不足”),又能被系统统一识别和处理(如返回 HTTP 400 + 错误码 INVENTORY_SHORTAGE)。关键不在于“抛出异常”,而在于“结构化地表达业务失败原因”。

定义统一的错误码枚举

错误码不应散落在字符串常量或异常构造中,而应集中管理。推荐用枚举,天然支持类型安全、可遍历、易扩展:

public enum BizErrorCode {
    // 格式:CODE("中文描述", HTTP状态码)
    INVENTORY_SHORTAGE("库存不足", HttpStatus.BAD_REQUEST.value()),
    USER_NOT_FOUND("用户不存在", HttpStatus.NOT_FOUND.value()),
    ORDER_EXPIRED("订单已过期", HttpStatus.GONE.value()),
    PARAM_INVALID("参数校验失败", HttpStatus.BAD_REQUEST.value());
<pre class="brush:php;toolbar:false;">private final String message;
private final int httpStatus;

BizErrorCode(String message, int httpStatus) {
    this.message = message;
    this.httpStatus = httpStatus;
}

public String getMessage() { return message; }
public int getHttpStatus() { return httpStatus; }

}

这样做的好处:调用方无需硬编码字符串;前端/日志可通过 code.name() 获取机器可读码,code.getMessage() 获取用户提示;后续加监控、国际化也更方便。

编写带错误码的自定义异常类

继承 RuntimeException(非检查异常,符合 Spring 等主流框架习惯),并持有错误码枚举实例:

public class BizException extends RuntimeException {
    private final BizErrorCode errorCode;
<pre class="brush:php;toolbar:false;">// 构造:只传错误码(最常用)
public BizException(BizErrorCode errorCode) {
    super(errorCode.getMessage());
    this.errorCode = errorCode;
}

// 构造:错误码 + 额外上下文信息(如订单号)
public BizException(BizErrorCode errorCode, Object... args) {
    super(String.format(errorCode.getMessage(), args));
    this.errorCode = errorCode;
}

// 提供获取错误码的方法
public BizErrorCode getErrorCode() {
    return errorCode;
}

// 可选:返回 HTTP 状态码,便于全局异常处理器直接使用
public int getHttpStatus() {
    return errorCode.getHttpStatus();
}

}

注意:
- 不重写 getMessage(),避免干扰日志和调试;
- 支持格式化参数(如 new BizException(USER_NOT_FOUND, "U12345") → “用户不存在” → 实际提示“用户 U12345 不存在”);
- 异常本身不负责日志打印,由统一异常处理器决定是否记录。

在业务代码中使用

直接抛出,语义清晰,无需 if-else 套 try-catch:

Java Api Extractor
Java Api Extractor

从 Java 项目中提取 Controller 层接口定义为 JSON 数据。

下载
  • 库存校验失败时:if (stock
  • 查不到用户时:if (user == null) throw new BizException(USER_NOT_FOUND, userId);
  • 参数不合法时:if (!isValid(phone)) throw new BizException(PARAM_INVALID, "手机号");

这种写法把“错误是什么”和“怎么处理它”解耦了——业务方法只关注“该不该失败”,不关心“失败后返回什么 JSON”。

配合全局异常处理器统一响应

用 @ControllerAdvice 捕获 BizException,输出标准格式:

@RestControllerAdvice
public class GlobalExceptionHandler {
<pre class="brush:php;toolbar:false;">@ExceptionHandler(BizException.class)
public ResponseEntity<apiresponse> handleBizException(BizException e) {
    ApiResponse response = ApiResponse.fail(
        e.getErrorCode().name(),      // 错误码(如 "INVENTORY_SHORTAGE")
        e.getMessage(),               // 用户提示(如 "库存不足")
        null                          // 可选:附加数据,如 {"itemId": 1001}
    );
    return ResponseEntity.status(e.getHttpStatus()).body(response);
}</apiresponse>

}

其中 ApiResponse 是你定义的统一响应体(含 code、message、data 字段)。这样所有业务异常都走同一出口,前端无需判断多种 error 字段,后端新增错误码也不用改控制器。

不复杂但容易忽略:错误码要命名规范(大写+下划线)、枚举值不可变、异常类保持轻量、全局处理器别吞掉原始堆栈(调试时需要)。做好这几点,业务异常就真正成了系统间沟通的“标准协议”。

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

11497

6

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

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

2023.07.05

8622

9

java自学难吗
java自学难吗

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

2023.07.31

7412

8

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

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

2023.08.01

1224

3

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

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

2023.08.02

988

3

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

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

2023.08.02

1476

5

java有什么用
java有什么用

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

2023.08.02

3029

5

java在线网站
java在线网站

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

2023.08.03

20271

3

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

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

2023.08.03

1315

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习