0

0

Java里如何自定义业务异常码_Java异常码规范设计说明

P粉602998670

P粉602998670

发布时间:2026-01-14 22:06:02

|

370人浏览过

|

来源于php中文网

原创

Java自定义业务异常码核心是建立可读、可维护、可扩展的错误码体系,需统一管理、分层分类、携带上下文、与异常类强绑定,推荐枚举+自定义异常实现。

java里如何自定义业务异常码_java异常码规范设计说明

Java中自定义业务异常码,核心是建立**可读、可维护、可扩展的错误码体系**,而不是简单用数字或字符串硬编码。关键在于:统一管理、分层分类、携带上下文、与异常类强绑定。

一、异常码设计基本原则

业务异常码不是随意编号,需遵循以下约定:

  • 唯一性:每个业务场景对应唯一错误码(如USER_001表示用户不存在,USER_002表示用户名已存在)
  • 可读性:采用“模块_序号”格式(如ORDER_CREATE_FAILED),避免纯数字(如1001
  • 分层性:按系统模块划分前缀(USER_ORDER_PAY_),便于定位和归类
  • 不变性:上线后错误码语义不可变更,新增用新码,禁用旧码需明确标注废弃
  • 可携带信息:异常码本身不传参,但对应异常类应支持动态填充提示文案(如“订单{0}不存在”)

二、推荐实现方式:枚举 + 自定义异常类

用枚举统一管理错误码,再通过自定义异常封装,是最清晰、类型安全的做法。

1. 定义错误码枚举(含描述与HTTP状态码

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

public enum BizErrorCode {
    USER_NOT_FOUND("USER_001", "用户不存在", HttpStatus.NOT_FOUND),
    USER_NAME_DUPLICATED("USER_002", "用户名已存在", HttpStatus.CONFLICT),
    ORDER_INVALID_STATUS("ORDER_003", "订单状态非法", HttpStatus.BAD_REQUEST);

    private final String code;
    private final String message;
    private final HttpStatus httpStatus;

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

    // getter 省略
}

2. 自定义业务异常类(支持参数化提示)

BlessAI
BlessAI

Bless AI 提供五个独特的功能:每日问候、庆祝问候、祝福、祷告和名言的文本生成和图片生成。

下载
public class BizException extends RuntimeException {
    private final String code;
    private final HttpStatus httpStatus;
    private final Object[] args; // 用于 MessageFormat 填充

    public BizException(BizErrorCode errorCode, Object... args) {
        super(errorCode.getMessage()); // 默认用枚举里的基础文案
        this.code = errorCode.getCode();
        this.httpStatus = errorCode.getHttpStatus();
        this.args = args;
    }

    // 提供带参数的提示文案(如 “订单{0}不存在” → “订单12345不存在”)
    public String getDetailMessage() {
        return args == null || args.length == 0 
            ? getMessage() 
            : MessageFormat.format(getMessage(), args);
    }
}

3. 使用示例

if (user == null) {
    throw new BizException(BizErrorCode.USER_NOT_FOUND, userId);
}
// 抛出时:code=USER_001,message="用户不存在",detailMessage="用户1001不存在"

三、配套建议:统一异常处理器 & 返回结构

前端需要稳定、结构化的错误响应,因此需配合全局异常处理器:

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BizException.class)
    public ResponseEntity> handleBizException(BizException e) {
        return ResponseEntity.status(e.getHttpStatus())
                .body(ApiResponse.fail(e.getCode(), e.getDetailMessage()));
    }
}

// 统一响应体示例
public class ApiResponse {
    private String code;     // 如 USER_001
    private String message;  // 如 “用户1001不存在”
    private T data;
    // ...
}

四、进阶考虑:国际化与配置化

若需多语言支持,可将错误码描述外置到 properties 文件,通过 ResourceBundle 加载;高频变动的码(如营销活动临时规则)也可考虑从配置中心动态加载,但需权衡一致性与复杂度。

不复杂但容易忽略:错误码必须和日志、监控、告警联动——例如在抛出 PAY_TIMEOUT 时,自动打点+上报,才能真正发挥业务异常码的价值。

相关专题

更多
java
java

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

832

2023.06.15

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

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

737

2023.07.05

java自学难吗
java自学难吗

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

734

2023.07.31

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

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

397

2023.08.01

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

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

398

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中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

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

精品课程

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

共23课时 | 2.5万人学习

C# 教程
C# 教程

共94课时 | 6.7万人学习

Java 教程
Java 教程

共578课时 | 45.9万人学习

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

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