Java 中自定义异常怎么结合 Swagger 描述接口错误

雨明同学_6295

雨明同学_6295

2026-10-21

790人浏览

原创

java中自定义异常要被swagger识别,需三步协同:定义带@schema的errorresponse类、在接口用@apiresponse声明各状态码响应、配@controlleradvice全局统一返回格式。

java 中自定义异常怎么结合 swagger 描述接口错误

Java 中自定义异常要真正“被 Swagger 看见”,关键不是只抛出异常,而是让 Springdoc(或 springfox)能把异常映射为 OpenAPI 文档里的 responses。这需要三步协同:定义可描述的异常模型、在接口上显式声明错误响应、并通过全局异常处理器确保运行时返回格式统一。

用 @Schema 定义 ErrorResponse 类

Swagger 不会自动把 RuntimeException 子类转成文档结构,必须提供一个带语义的错误响应体类,并用 @Schema 明确标注:

  • 类加 @Schema(description = "通用错误响应")
  • 每个字段加 @Schema(description = "...", example = "..."),比如 code、message、timestamp
  • 如果用了 Lombok,确保 @Data 或手动提供 getter/setter,否则字段可能不被扫描到
  • 避免字段名与 OpenAPI 关键字冲突(如不要叫 schema 或 responses)

在接口方法上用 @ApiResponse 声明具体错误码

@Operation 描述整体行为,而每个可能的 HTTP 错误码需单独用 @ApiResponse 绑定到你的 ErrorResponse:

JavaStoryDevelop
JavaStoryDevelop

你接手一个需求时,是不是经常这样:"改一个小字段 → 结果把不相关的代码也改了"、"需求说得很模糊 → 做着做着发现跑偏了"、"数据库加个字段 → 上线才发现漏了数据兼容"、"做了个新功能 → 一个月后自己都忘了当时怎么设计的"、"写到一半被中断 → 再回来不知道从哪继续";这个 Skill 就是专门解决这些问题的。 它会自动探测你的项目环境(JDK、Spring Boot、ORM、数据库、前端框架),记在

下载
  • responseCode 必须是字符串,如 "400",不能写 400
  • content = @Content(schema = @Schema(implementation = ErrorResponse.class)) 是核心,告诉 Swagger 这个状态码返回什么结构
  • 建议覆盖常见错误:400(参数校验失败)、401/403(认证鉴权)、404(资源不存在)、500(服务异常)
  • 多个 @ApiResponse 可并列写在同一个方法上,无需 @ApiResponses 包裹(Springdoc 1.6+ 支持直接重复注解)

配合同步的 @RestControllerAdvice 全局处理

文档里写了 400,但运行时抛 MethodArgumentNotValidException 却返回了默认白页或堆栈,说明没接住。全局异常处理器要干两件事:

  • 捕获具体异常类型(如 MethodArgumentNotValidException、自定义的 BusinessException),转换为标准 ErrorResponse 实例
  • 设置对应 HTTP 状态码:@ResponseStatus(HttpStatus.BAD_REQUEST) 或在 ResponseEntity 中显式指定
  • 确保该处理器类被 Spring 扫描到(加 @Component 或 @RestControllerAdvice)
  • 如果自定义异常本身带状态码字段(如 private int code = 500),可在处理器中读取并动态设状态码

验证是否生效的小技巧

启动项目后访问 /v3/api-docs(Springdoc 默认路径),搜索你的接口路径,看 responses 字段下是否有你声明的 "400"、"404" 等对象;再打开 Swagger UI 页面,点开对应接口的 “Try it out”,展开 “Responses” 区域,确认错误响应结构已渲染出来且字段可读。

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

相关专题

更多
java
java

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

2023.06.15

10957

6

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

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

2023.07.05

8082

9

java自学难吗
java自学难吗

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

2023.07.31

6992

8

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

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

2023.08.01

1184

3

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

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

2023.08.02

968

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2889

5

java在线网站
java在线网站

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

2023.08.03

20171

3

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

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

2023.08.03

1275

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习