Java 中怎么在全局异常处理中返回统一的 JSON 错误结构

老婷大大_6096

老婷大大_6096

2026-10-10

521人浏览

原创

推荐使用@controlleradvice+@exceptionhandler实现全局异常处理,统一返回含code、message、timestamp的result json结构,并可通过@responsebodyadvice自动包装正常响应为result。

java 中怎么在全局异常处理中返回统一的 json 错误结构

在 Spring Boot 项目中,推荐使用 @ControllerAdvice + @ExceptionHandler 实现全局异常处理,并统一返回标准 JSON 错误结构(如包含 code、message、timestamp 等字段),避免每个 Controller 重复写错误响应逻辑。

定义统一错误响应体

先创建一个通用的 JSON 响应封装类,用于所有接口(包括成功和失败):

public class Result<t> {
    private int code;
    private String message;
    private T data;
    private long timestamp = System.currentTimeMillis();

    // 构造方法、getter/setter 略
    public static <t> Result<t> fail(int code, String message) {
        Result<t> r = new Result();
        r.code = code;
        r.message = message;
        return r;
    }
    public static <t> Result<t> success(T data) {
        Result<t> r = new Result();
        r.code = 200;
        r.message = "success";
        r.data = data;
        return r;
    }
}
</t></t></t></t></t></t></t>

编写全局异常处理器

用 @ControllerAdvice 拦截所有控制器抛出的异常,按异常类型返回对应 Result:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
@ControllerAdvice
public class GlobalExceptionHandler {

    // 处理业务异常(如自定义的 BusinessException)
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    public Result<void> handleBusinessException(BusinessException e) {
        return Result.fail(e.getCode(), e.getMessage());
    }

    // 处理参数校验异常(@Valid)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public Result<void> handleValidationException(MethodArgumentNotValidException e) {
        String msg = e.getBindingResult()
                      .getFieldErrors()
                      .stream()
                      .map(error -> error.getField() + ": " + error.getDefaultMessage())
                      .collect(Collectors.joining("; "));
        return Result.fail(400, "参数校验失败: " + msg);
    }

    // 处理空指针、运行时异常等未预期错误(生产环境建议记录日志并返回通用错误码)
    @ExceptionHandler(RuntimeException.class)
    @ResponseBody
    public Result<void> handleRuntimeException(RuntimeException e) {
        // 生产中建议打 ERROR 日志,不暴露堆栈给前端
        log.error("系统运行时异常", e);
        return Result.fail(500, "服务内部错误");
    }
}
</void></void></void>

确保返回 JSON 且状态码正确

Spring Boot 默认会将 @ResponseBody 方法的返回对象序列化为 JSON。还需注意两点:

  • 在 @ExceptionHandler 方法上加 @ResponseStatus(HttpStatus.XXX) 可设置 HTTP 状态码(如 @ResponseStatus(HttpStatus.BAD_REQUEST))
  • 若希望所有错误响应都带状态码,也可在 Result.fail() 中统一设 status,再配合 ResponseEntity<result></result> 返回(更灵活)
  • 确认项目已引入 spring-boot-starter-web(含 Jackson 自动配置)

可选:统一拦截所有接口,避免手动返回 Result

如果希望所有正常接口也自动包装成 Result,可用 @ResponseBodyAdvice 做响应增强:

@ControllerAdvice
public class ResponseWrapper implements ResponseBodyAdvice<object> {

    @Override
    public boolean supports(MethodParameter returnType, Class extends HttpMessageConverter>> converterType) {
        return true; // 对所有 @ResponseBody 方法生效
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                  MediaType selectedContentType, Class extends HttpMessageConverter>> selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof Result) {
            return body; // 已是 Result,不再包装
        }
        return Result.success(body);
    }
}
</object>

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10117

6

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

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

2023.07.05

7262

9

java自学难吗
java自学难吗

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

2023.07.31

6372

8

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

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

2023.08.01

1104

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1336

5

java有什么用
java有什么用

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

2023.08.02

2669

5

java在线网站
java在线网站

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

2023.08.03

19991

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1175

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习