0

0

Java中如何设计统一的异常响应结构

P粉602998670

P粉602998670

发布时间:2025-10-24 13:16:02

|

713人浏览过

|

来源于php中文网

原创

统一异常响应结构通过定义Result类、枚举错误码、自定义异常和@ControllerAdvice全局处理,实现API返回一致性。1. 创建Result封装返回数据;2. 定义ErrorCode枚举管理错误码;3. 设计BusinessException携带错误信息;4. 使用@ControllerAdvice统一拦截异常并转换为Result格式;5. 控制器中抛出异常自动返回标准化错误。该方案提升前后端协作效率,隐藏敏感信息,增强可维护性。

java中如何设计统一的异常响应结构

在Java开发中,特别是基于Spring Boot的Web项目里,设计统一的异常响应结构能提升API的可读性和前后端协作效率。当系统发生异常时,返回结构清晰、字段一致的错误信息,有助于前端快速定位问题。

定义统一的响应体格式

首先创建一个通用的响应类,用于封装所有接口的返回数据,包括正常结果和异常情况。

示例:Result

public class Result {
    private int code;
    private String message;
    private T data;

    public static  Result success(T data) {
        Result result = new Result<>();
        result.code = 200;
        result.message = "success";
        result.data = data;
        return result;
    }

    public static  Result error(int code, String message) {
        Result result = new Result<>();
        result.code = code;
        result.message = message;
        return result;
    }

    // getter 和 setter 省略
}

定义业务异常与错误码

通过枚举管理常见错误码,避免硬编码,增强可维护性。

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

赣极购物商城网店建站软件系统
赣极购物商城网店建站软件系统

大小仅1兆左右 ,足够轻便的商城系统; 易部署,上传空间即可用,安全,稳定; 容易操作,登陆后台就可设置装饰网站; 并且使用异步技术处理网站数据,表现更具美感。 前台呈现页面,兼容主流浏览器,DIV+CSS页面设计; 如果您有一定的网页设计基础,还可以进行简易的样式修改,二次开发, 发布新样式,调整网站结构,只需修改css目录中的css.css文件即可。 商城网站完全独立,网站源码随时可供您下载

下载
public enum ErrorCode {
    SYSTEM_ERROR(500, "系统内部错误"),
    RESOURCE_NOT_FOUND(404, "资源未找到"),
    INVALID_PARAM(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; }
}

同时可以设计一个自定义异常类,携带错误码和动态消息:

public class BusinessException extends RuntimeException {
    private final int code;

    public BusinessException(ErrorCode errorCode, String message) {
        super(message);
        this.code = errorCode.getCode();
    }

    public int getCode() { return code; }
}

使用@ControllerAdvice全局处理异常

通过 @ControllerAdvice 拦截所有控制器抛出的异常,统一转换为Result格式返回。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    public Result handleBusinessException(BusinessException e) {
        return Result.error(e.getCode(), e.getMessage());
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public Result handleValidationException(MethodArgumentNotValidException e) {
        List errors = e.getBindingResult()
                .getFieldErrors()
                .stream()
                .map(FieldError::getDefaultMessage)
                .collect(Collectors.toList());
        return Result.error(400, errors.toString());
    }

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result handleUnexpectedException(Exception e) {
        // 生产环境建议不暴露堆栈信息
        return Result.error(500, "服务器繁忙,请稍后再试");
    }
}



在控制器中使用示例

正常返回和异常抛出都保持一致性:

@RestController
public class UserController {

    @GetMapping("/user/{id}")
    public Result getUser(@PathVariable Long id) {
        if (id <= 0) {
            throw new BusinessException(ErrorCode.INVALID_PARAM, "ID必须大于0");
        }
        User user = userService.findById(id);
        if (user == null) {
            throw new BusinessException(ErrorCode.RESOURCE_NOT_FOUND, "用户不存在");
        }
        return Result.success(user);
    }
}

基本上就这些。统一异常响应的核心在于:规范返回结构、集中异常处理、区分异常类型、对外隐藏敏感信息。这样既能保证接口一致性,也便于后期扩展和维护。

相关专题

更多
java
java

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

825

2023.06.15

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

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

724

2023.07.05

java自学难吗
java自学难吗

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

728

2023.07.31

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

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

395

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基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

445

2023.08.02

java有什么用
java有什么用

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

428

2023.08.02

java在线网站
java在线网站

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

16861

2023.08.03

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

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

共23课时 | 2.1万人学习

C# 教程
C# 教程

共94课时 | 5.7万人学习

Java 教程
Java 教程

共578课时 | 40万人学习

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

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