Java中 响应体 Result 怎么统一封装全局异常信息

星磊小哥_4835

星磊小哥_4835

2026-07-17

456人浏览

原创

Java中响应体Result统一封装全局异常信息,核心是让所有异常统一转为结构一致的JSON响应;Result泛型类含code、message、data三字段,推荐增加timestamp和requestId;用枚举管理错误码,自定义BusinessException并配合@ControllerAdvice分层捕获处理,控制器专注业务逻辑。

java中 响应体 result 怎么统一封装全局异常信息

Java中响应体Result统一封装全局异常信息,核心是让所有异常——无论参数校验失败、业务规则不满足,还是系统内部错误——最终都转成结构一致的JSON响应,前端只对接一种格式,后端也不用每个接口手动处理异常。

定义清晰的Result泛型类

Result必须包含三个基础字段:code(int类型错误码)、message(面向用户或调试人员的提示)、data(泛型T,成功时有值,异常时为null)。不建议加success布尔字段,它和code语义重复,还容易引发前端双重判断逻辑错乱。

可选但推荐增加:timestamp(毫秒时间戳)用于排查异步或重放问题;requestId(唯一请求ID)便于日志追踪与监控对齐。

示例关键代码:

public class Result<t> {
    private int code;
    private String message;
    private T data;
    private long timestamp;
    private String requestId;

    public static <t> Result<t> success(T data) {
        Result<t> r = new Result();
        r.code = 200;
        r.message = "success";
        r.data = data;
        r.timestamp = System.currentTimeMillis();
        return r;
    }

    public static <t> Result<t> error(int code, String message) {
        Result<t> r = new Result();
        r.code = code;
        r.message = message;
        r.timestamp = System.currentTimeMillis();
        return r;
    }
    // getter/setter 省略
}
</t></t></t></t></t></t></t>

用枚举统一管理错误码

避免硬编码数字和字符串,把错误码和提示封装进enum,自带描述、可序列化、IDE能补全、后期增删方便。

常见类型覆盖:成功(0)、参数错误(1001)、资源不存在(404)、权限不足(403)、系统繁忙(500)、业务冲突(如重复提交)等。

示例:

sc-java-to-ts-interface
sc-java-to-ts-interface

将后端 Java 接口文档转换为前端 TypeScript 类型定义(interface / type)。输入:飞书文档、Spring Boot 接口文档、Swagger/OpenAPI、手写 API 文档等。输出:包含请求参数与响应结果的 .md 文件,含完整 JSDoc 注释。触发关键词:Java 转 TS、接口转换、生成前端类型、接口文档转 TypeScript、DTO/VO/BO 转 interface、后端文档转前端类型、生成接口类型、类型定义生成。

下载
public enum ErrorCode {
    SUCCESS(0, "操作成功"),
    PARAM_ERROR(1001, "请求参数格式错误"),
    NOT_FOUND(404, "请求资源不存在"),
    FORBIDDEN(403, "无访问权限"),
    SYSTEM_ERROR(500, "系统繁忙,请稍后再试");

    private final int code;
    private final String message;

    ErrorCode(int code, String message) {
        this.code = code;
        this.message = message;
    }
    // getter 省略
}

自定义业务异常并分层捕获

定义BusinessException继承RuntimeException,构造时传入ErrorCode,保证抛出即携带标准错误信息。

在@ControllerAdvice中,用@ExceptionHandler按异常类型分层处理:

  • BindException / MethodArgumentNotValidException → 转为PARAM_ERROR
  • BusinessException → 直接取其ErrorCode里的code和message
  • Exception(兜底)→ 记录完整堆栈到日志,返回SYSTEM_ERROR,绝不暴露敏感细节

关键点:不要只捕获Exception一个大类,否则底层IOException、SQLException等可能被忽略;也不要手动new Result对象,统一调用Result.error(…),保持构造逻辑集中。

控制器里专注业务,异常交给框架

Controller方法无需try-catch,直接写业务逻辑。遇到校验失败就throw new BusinessException(ErrorCode.PARAM_ERROR);查不到数据就throw new BusinessException(ErrorCode.NOT_FOUND)。

Spring Boot自动将这些异常交由@ControllerAdvice处理,并返回Result格式的HTTP响应,HTTP状态码(如400、404、500)仍按语义设置,与Result.code职责分离——前者给网关/负载均衡看,后者给前端业务逻辑用。

这样,哪怕新增100个接口,只要抛出规范异常,响应结构就天然统一,文档好写,前端好接,线上问题也好定位。

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

11437

6

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

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

2023.07.05

8542

9

java自学难吗
java自学难吗

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

2023.07.31

7352

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

1456

5

java有什么用
java有什么用

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

2023.08.02

3009

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人学习