Java 中怎么为自定义异常定义统一的错误码枚举-java教程-PHP中文网

java中统一错误码管理采用「错误码枚举+自定义异常类」组合方式，通过errorcode枚举集中定义code、message等元数据，bizexception支持动态占位符，配合全局异常处理器返回标准响应，提升可维护性与契约一致性。

java 中怎么为自定义异常定义统一的错误码枚举

在 Java 中为自定义异常定义统一的错误码枚举，核心是将错误码、错误信息、HTTP 状态码（如适用）等元数据集中管理，避免硬编码和重复定义。推荐采用「错误码枚举 + 自定义异常类」的组合方式，既清晰又易维护。

定义统一错误码枚举（ErrorCode）

创建一个枚举类，每个枚举项代表一种业务错误场景，包含错误码（int 或 String）、提示消息、HTTP 状态码（可选）等字段：

public enum ErrorCode {
    // 系统级错误
    SYSTEM_ERROR(500, "系统繁忙，请稍后再试"),
    ILLEGAL_ARGUMENT(400, "参数不合法"),

    // 用户相关错误
    USER_NOT_FOUND(404, "用户不存在"),
    USER_ALREADY_EXISTS(409, "用户已存在"),
    USER_DISABLED(403, "账号已被禁用"),

    // 订单相关错误
    ORDER_NOT_FOUND(404, "订单不存在"),
    ORDER_STATUS_INVALID(400, "订单状态不支持当前操作");

    private final int code;
    private final String message;

    ErrorCode(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() { return code; }
    public String getMessage() { return message; }
}

编写通用自定义异常类（BizException）

该异常继承 RuntimeException，构造时接收 ErrorCode 枚举，并可扩展支持动态占位符（如用户名、ID）：

public class BizException extends RuntimeException {
    private final int code;
    private final String message;

    public BizException(ErrorCode errorCode) {
        this(errorCode, Collections.emptyMap());
    }

    public BizException(ErrorCode errorCode, Map<string object> params) {
        super(errorCode.getMessage());
        this.code = errorCode.getCode();
        this.message = formatMessage(errorCode.getMessage(), params);
    }

    private String formatMessage(String template, Map<string object> params) {
        if (params.isEmpty()) return template;
        return params.entrySet().stream()
                .reduce(template,
                        (acc, entry) -> acc.replace("{" + entry.getKey() + "}", String.valueOf(entry.getValue())),
                        (a, b) -> b);
    }

    public int getCode() { return code; }
    public String getMessage() { return message; }
}
</string></string>

使用示例：

Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

throw new BizException(ErrorCode.USER_NOT_FOUND);
throw new BizException(ErrorCode.USER_ALREADY_EXISTS, Map.of("username", "zhangsan")); → 提示“用户 zhangsan 已存在”

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

Spring Boot 项目中，用 @ControllerAdvice 拦截 BizException，返回标准 JSON 响应：

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BizException.class)
    public ResponseEntity<apiresponse> handleBizException(BizException e) {
        return ResponseEntity.status(HttpStatus.valueOf(e.getCode()))
                .body(ApiResponse.fail(e.getCode(), e.getMessage()));
    }
}
</apiresponse>

其中 ApiResponse 是你定义的统一响应体（含 code、message、data 字段），确保前后端契约一致。

进阶建议：增强可维护性

按模块分包：如 errorcode.user.UserErrorCode、errorcode.order.OrderErrorCode，再通过接口统一继承（如 interface ErrorCode）便于扫描
支持国际化：message 字段改为从 MessageSource 动态获取，配合 Locale 实现多语言提示
校验唯一性：可在枚举静态块中检查 code 是否重复，启动时报错提醒
生成文档：结合 Swagger 或自定义注解，将枚举自动注入 API 错误码说明