讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中怎么在自定义异常中封装错误码和错误信息规范微服务接口返回

陌瑶大大_7671

陌瑶大大_7671

发布时间:2026-08-16 13:49:59

|

1002人浏览过

|

来源于php中文网

原创

微服务中通过自定义BusinessException异常类、ErrorCode枚举和@ControllerAdvice全局处理器实现错误码与信息的统一封装,业务层仅抛异常,框架自动转换为标准响应体。

java 中怎么在自定义异常中封装错误码和错误信息规范微服务接口返回

在微服务中,自定义异常统一封装错误码和错误信息,核心是让异常本身携带结构化错误数据,并通过全局异常处理器(@ControllerAdvice)转换为标准响应体(如 { "code": 40001, "message": "用户名已存在", "data": null }),避免业务代码到处写重复的返回逻辑。

定义统一异常基类:含错误码、消息、可选上下文

建议继承 RuntimeException(非检查异常,调用方无需强制 try-catch),并提供多构造函数支持灵活传参:

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

    // 最简构造:只传错误码(从枚举获取默认消息)
    public BusinessException(ErrorCode errorCode) {
        super(errorCode.getMessage());
        this.code = errorCode.getCode();
        this.message = errorCode.getMessage();
    }

    // 支持动态填充消息占位符(如"用户 {0} 不存在" → "用户 admin 不存在")
    public BusinessException(ErrorCode errorCode, Object... args) {
        super(MessageFormat.format(errorCode.getMessage(), args));
        this.code = errorCode.getCode();
        this.message = MessageFormat.format(errorCode.getMessage(), args);
    }

    // 支持手动指定消息(慎用,破坏一致性)
    public BusinessException(int code, String message) {
        super(message);
        this.code = code;
        this.message = message;
    }

    // getter 省略...
}

定义错误码枚举:集中管理,语义清晰,支持国际化扩展

把所有错误码收拢到一个枚举里,每个枚举项包含唯一码值、默认提示、HTTP 状态建议(可选)。例如:

public enum ErrorCode {
    SUCCESS(200, "操作成功"),
    USER_NOT_FOUND(40401, "用户不存在"),
    USERNAME_DUPLICATED(40001, "用户名已存在"),
    INVALID_PARAM(40000, "参数不合法:{0}"),
    SYSTEM_ERROR(50000, "系统繁忙,请稍后重试");

    private final int code;
    private final String message;

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

    // getter 省略...
}

这样抛异常就非常干净:throw new BusinessException(ErrorCode.USERNAME_DUPLICATED, "test_user");

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

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载

全局异常处理器:统一封装成标准响应格式

用 @ControllerAdvice 拦截所有控制器异常,区分不同异常类型,返回统一 JSON 结构:

@ControllerAdvice
public class GlobalExceptionHandler {

    @ResponseBody
    @ExceptionHandler(BusinessException.class)
    public Result<?> handleBusinessException(BusinessException e) {
        return Result.fail(e.getCode(), e.getMessage());
    }

    @ResponseBody
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result<?> handleValidationException(MethodArgumentNotValidException e) {
        String defaultMessage = e.getBindingResult().getFieldError().getDefaultMessage();
        return Result.fail(40000, "参数校验失败:" + defaultMessage);
    }

    @ResponseBody
    @ExceptionHandler(Exception.class)
    public Result<?> handleUnexpectedException(Exception e) {
        log.error("未预期异常", e);
        return Result.fail(50000, "系统异常,请联系管理员");
    }
}

其中 Result<T> 是你项目约定的通用响应体,含 code、message、data 字段。

业务层直接抛异常,不手动构造 Response

Controller 层保持纯粹,只关注业务流程,异常由框架自动捕获处理:

  • ✅ 正确写法:if (userRepo.existsByUsername(username)) { throw new BusinessException(ErrorCode.USERNAME_DUPLICATED, username); }
  • ❌ 错误写法:return Result.fail(40001, "用户名已存在"); —— 打破异常语义,且无法被全局处理器统一日志/监控

这种设计让错误处理与业务逻辑解耦,也便于后续接入熔断、告警、链路追踪等能力。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

更多
java
java

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

9897

2023.06.15

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

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

7022

2023.07.05

java自学难吗
java自学难吗

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

6192

2023.07.31

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

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

1064

2023.08.01

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

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

888

2023.08.02

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

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

1296

2023.08.02

java有什么用
java有什么用

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

2589

2023.08.02

java在线网站
java在线网站

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

19931

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn