Spring Boot 中全局异常规范怎么在团队制定

大浩姑娘_1927

大浩姑娘_1927

2026-11-02

126人浏览

原创

全局异常规范落地关键在共识与流程:明确分层异常归属,强制统一响应结构,通过模板工程、CI检查、IDEA模板等机制嵌入开发流程,并配套Code Review、日志规范及异常码看板。

spring boot 中全局异常规范怎么在团队制定

团队落地全局异常规范,关键不在技术实现,而在共识建立和流程嵌入。技术方案(如 @RestControllerAdvice)本身很成熟,难的是让所有人写业务时“下意识”按规范来,而不是上线后靠 Review 补救。

明确分层与异常归属

先统一什么是“该谁管的异常”,避免推诿或重复处理:

  • 接口层(Controller)只负责 HTTP 相关异常:400 参数校验失败、401 Token 过期、404 接口不存在——这些由 Spring 自带的 ResponseEntityExceptionHandler 或自定义拦截器捕获
  • 业务层(Service)必须抛出业务异常:用 BusinessException 及其子类(如 OrderNotFoundException),禁止直接 throw new RuntimeException("订单没找到")
  • 数据层(DAO)异常不向上透传:MyBatis 抛出的 SQLSyntaxErrorException 等应被封装为带明确业务语义的异常,比如“库存扣减失败”,而不是暴露数据库细节
  • 系统级异常(NPE、OOM)全部由全局处理器兜底,日志必须记录完整堆栈 + 请求 ID + 关键参数,但响应体里只返回“500 服务器内部错误”

强制使用统一响应结构

所有接口返回类型必须是 Result(或你团队命名的等效类),不允许直接返回 POJO 或 String:

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载
  • 成功时:固定 code=200,message="操作成功",data 为实际内容
  • 失败时:code 对应预定义枚举(如 ResultCode.ORDER_NOT_FOUND),message 是用户可读提示(如“订单不存在,请检查订单号”),绝不拼接运行时变量(如 "订单" + id + "不存在")
  • 新增错误码必须走评审:在共享文档中登记 code、message、触发场景、是否需告警,避免同义不同码(如“余额不足”出现 4001 和 4027 两个码)

把规范变成开发环境的一部分

靠自觉不如靠机制:

  • 模板工程内置 GlobalExceptionHandler、BusinessException、Result 和 ResultCode 枚举,新项目直接继承,不许自行重写
  • CI 流水线加入静态检查:扫描所有 @PostMapping/@GetMapping 方法,若返回类型不是 Result 或其泛型子类,构建失败
  • IDEA Live Template 配置快捷代码段:输入 exb 回车,自动补全 throw new BusinessException(ResultCode.XXX);
  • Swagger 文档中每个接口的 200/400/500 响应体,必须引用 Result 的 OpenAPI Schema,前端可据此自动生成错误处理逻辑

配套协作机制

技术规范需要协同规则支撑:

  • Code Review 必查项:是否用了自定义业务异常?错误码是否已在枚举中定义?message 是否含敏感信息或动态拼接?
  • 日志规范同步落地:每个 BusinessException 构造时自动携带 traceId,全局处理器记录 ERROR 日志时必须包含请求路径、method、参数摘要(脱敏后)、异常码
  • 建立异常码看板:实时展示各错误码近 24 小时调用量、Top3 触发接口、平均响应耗时,让高频异常自动浮出水面

相关文章

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

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

下载

相关标签:

java spring boot

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

相关专题

更多
java
java

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

2023.06.15

11777

6

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

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

2023.07.05

8882

9

java自学难吗
java自学难吗

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

2023.07.31

7612

8

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

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

2023.08.01

1244

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1496

5

java有什么用
java有什么用

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

2023.08.02

3089

5

java在线网站
java在线网站

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

2023.08.03

20351

3

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

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

2023.08.03

1355

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习