怎么自定义业务异常类以携带具体的错误码和提示信息

陌磊君_7334

陌磊君_7334

2026-04-06

727人浏览

原创

业务异常应使用自定义businessexception而非runtimeexception,以支持错误码枚举、国际化提示、统一json响应及全链路治理。

怎么自定义业务异常类以携带具体的错误码和提示信息

为什么不能直接 throw new RuntimeException("xxx")

业务异常不是系统故障,而是流程中明确预知的失败分支,比如「用户余额不足」「订单已取消」「手机号已被注册」。用 RuntimeException 丢出这类信息,会导致错误码缺失、提示硬编码、上游无法区分处理——调用方只能靠 getMessage() 字符串匹配,一改文案就崩。

  • 错误码(如 USER_BALANCE_INSUFFICIENT)必须可枚举、可查文档、可被监控系统采集
  • 提示信息需支持国际化,不能写死在异常构造里
  • HTTP 接口返回时,需自动映射为标准 JSON 结构(如 {"code": "USER_BALANCE_INSUFFICIENT", "message": "余额不足,请先充值"})

定义业务异常类的关键字段和构造方式

核心是把 code 和 args(占位符参数)作为必传项,消息体延迟到获取时才渲染,避免日志或序列化时提前绑定上下文。

public class BusinessException extends RuntimeException {
    private final String code;
    private final Object[] args;

    public BusinessException(String code, Object... args) {
        super(code); // 父类 message 仅存 code,便于日志追踪
        this.code = code;
        this.args = args != null ? args : new Object[0];
    }

    public String getCode() {
        return code;
    }

    public String getMessageTemplate() {
        return code; // 实际项目中可从 ResourceBundle 或配置中心读取模板
    }

    public String getLocalizedMessage() {
        String template = getMessageTemplate();
        return template != null ? String.format(template, args) : code;
    }
}
  • 不重写 getMessage(),保留父类行为(返回 code),方便 ELK 日志按字段提取
  • getLocalizedMessage() 负责拼装最终面向用户的提示,由统一的 i18n 工具接管更稳妥
  • 禁止在构造函数里调用 String.format,否则丢失原始参数,无法做动态翻译或审计

Spring Boot 中如何让 @ControllerAdvice 捕获并标准化返回

关键不是“捕获异常”,而是确保所有控制器抛出的 BusinessException 都走同一套响应封装逻辑,且不干扰其他异常(如 IllegalArgumentException)。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<apiresponse> handleBusinessException(BusinessException e) {
        String message = e.getLocalizedMessage(); // 此处可接入 i18n
        return ResponseEntity.badRequest()
                .body(ApiResponse.error(e.getCode(), message));
    }
}</apiresponse>
  • 必须显式声明 @ExceptionHandler(BusinessException.class),不能笼统捕获 RuntimeException,否则会吞掉本该 500 的真实错误
  • ApiResponse 是你自己的 DTO 类,字段应固定为 code、message、timestamp,不要加 data 或 success 字段混淆语义
  • HTTP 状态码别硬写 200,业务失败统一用 400 BAD_REQUEST,除非你明确需要 409 或 422

容易被忽略的三个细节

很多人写了异常类、配了全局处理器,上线后还是出问题,往往卡在这几个地方:

  • Feign 客户端默认不反序列化错误响应体,远程调用抛 BusinessException 后,本地只收到 FeignException,需自定义 ErrorDecoder 解析 body 中的 code 字段再重新 throw
  • MyBatis 的 @Select 方法若返回 null 表示“未查到”,但业务上可能是“用户不存在”,这时不能直接 throw 异常,要由 service 层判断后主动 throw,否则 DAO 层污染了业务语义
  • 单元测试里用 assertThrows 验证异常时,别只断言 getMessage(),必须验证 getCode() 字段,否则重构提示文案时测试会失效

错误码不是字符串常量,是业务契约的一部分;它得能被前端 switch,能被运维告警,能被客服系统识别。写一个 BusinessException 很快,让它真正活在整条链路里,才是难点。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10417

6

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

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

2023.07.05

7542

9

java自学难吗
java自学难吗

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

2023.07.31

6612

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1376

5

java有什么用
java有什么用

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

2023.08.02

2749

5

java在线网站
java在线网站

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

2023.08.03

20051

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习