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

Java 异常拦截怎么统一输出标准的 JSON 格式

陌明酱_8759

陌明酱_8759

发布时间:2026-09-25 14:33:00

|

287人浏览过

|

来源于php中文网

原创

统一异常处理需用@RestControllerAdvice拦截+自定义BusinessException+泛型Result<T>响应体,code/message/data字段清晰,业务异常返回HTTP 200,日志记录requestId,Filter/Interceptor异常需单独处理。

java 异常拦截怎么统一输出标准的 json 格式

Java 异常拦截统一输出标准 JSON 格式,关键不是“把异常转成 JSON”,而是建立一套分层明确、可扩展、不暴露内部细节的响应契约。核心在于用 @RestControllerAdvice 拦截 + 自定义异常类 + 统一响应体三者配合,让所有接口(无论成功或失败)返回结构一致的 JSON。

定义统一响应体 Result

所有接口返回类型应统一为泛型 Result<T>,字段精简且语义清晰:

  • code:整型业务错误码(如 200 表示成功,40001 表示参数校验失败)
  • message:面向前端/用户的提示文案,不带堆栈、不暴露敏感路径
  • data:泛型数据体,成功时填充,失败时为 null
  • timestamp(可选):便于排查时序问题

用 @JsonInclude(JsonInclude.Include.NON_NULL) 注解避免返回空 data 字段;搭配 Lombok 的 @Data 减少模板代码。

封装业务异常 BusinessException

禁止直接 throw new RuntimeException("xxx")。所有业务异常必须继承自自定义运行时异常:

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

Comprehensive Three.js 3D graphics reference
Comprehensive Three.js 3D graphics reference

详细的 Three.js 3D 图形参考,涵盖场景设置、相机、几何体、材质、光照、动画、控制器、加载器、数学工具和调试。

下载
  • 含 code 和 message 字段,构造时强制传入枚举类(如 ErrorCode.PARAM_INVALID)
  • 可额外携带 requestId,用于日志链路追踪
  • 只在 Service 或 Controller 层抛出,DTO 层不做校验逻辑

例如:throw new BusinessException(ErrorCode.USER_NOT_FOUND);

用 @RestControllerAdvice 集中拦截并格式化

写一个独立配置类,标注 @RestControllerAdvice(比 @ControllerAdvice + @ResponseBody 更简洁),按异常类型分层处理:

  • 捕获 BusinessException:返回 HTTP 200 + Result.error(),保证前端始终能解析 JSON
  • 捕获 MethodArgumentNotValidException:提取 @Valid 校验失败信息,转为统一错误码(如 40001)和提示
  • 捕获 Exception(兜底):记录 warn 日志(含 requestId)、返回通用错误码(如 50000),生产环境禁用堆栈输出

每个 @ExceptionHandler 方法返回 Result<?>,Spring Boot 会自动序列化为 JSON。

补充细节提升健壮性

光有 JSON 结构还不够,几个易忽略但关键的点:

  • 日志必须打 warn 级别,且包含 requestId 和异常简要信息,方便关联请求与错误
  • HTTP 状态码不依赖业务错误码:业务异常统一用 200,系统级异常(如 NPE)可用 500,避免前端用状态码做业务判断
  • Filter / Interceptor 中抛出的异常不会被 @RestControllerAdvice 拦截,需单独处理或提前转为 Controller 可见异常
  • 事务方法内若 catch 了异常又没 re-throw,会导致事务不回滚,务必确保异常上抛到 Web 层

热门AI工具

更多
WorkBuddy

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

二狗PPT
二狗PPT Hot

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

更多
java
java

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

9077

2023.06.15

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

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

6242

2023.07.05

java自学难吗
java自学难吗

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

5592

2023.07.31

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

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

1004

2023.08.01

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

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

828

2023.08.02

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

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

1176

2023.08.02

java有什么用
java有什么用

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

2389

2023.08.02

java在线网站
java在线网站

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

19731

2023.08.03

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

60

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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