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

Spring Boot 中 REST 接口统一异常怎么设计

落浩同学_5821

落浩同学_5821

发布时间:2026-11-06 12:26:28

|

172人浏览过

|

来源于php中文网

原创

应定义统一响应结构并配合全局异常处理与自动包装机制。使用泛型Result类(含code、message、data),状态码用枚举管理;通过@RestControllerAdvice分类捕获异常并返回对应Result;借助ResponseBodyAdvice自动将成功响应包装为Result.success(),确保所有接口响应格式一致。

spring boot 中 rest 接口统一异常怎么设计

定义清晰的统一响应结构

所有接口返回必须遵循固定格式,避免前端反复适配不同结构。推荐使用泛型 Result 类,包含三个核心字段:code(状态码)、message(提示信息)、data(业务数据)。状态码建议用枚举管理,比如 SUCCESS(200)、PARAM_ERROR(400)、NOT_FOUND(404)、INTERNAL_ERROR(500),既语义明确又便于全局替换。

用 @RestControllerAdvice 拦截所有异常

创建一个被 @RestControllerAdvice 注解的类,它会自动作用于所有 @RestController 方法。在这个类里,用多个 @ExceptionHandler 方法分别捕获不同异常:

Java调试
Java调试

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

下载
  • 捕获自定义业务异常(如 BizException),按其携带的 code 和 message 返回 Result.fail(code, msg)
  • 捕获参数校验异常(MethodArgumentNotValidException),提取 BindingResult 中的错误字段,组装成“参数 xxx 不合法”类提示
  • 捕获系统级异常(Exception 或 RuntimeException),统一返回 INTERNAL_ERROR(500),并记录完整堆栈日志
  • 可选:单独处理 HttpRequestMethodNotSupportedException、HttpMediaTypeNotAcceptableException 等 HTTP 协议层异常,提升 API 健壮性

区分异常类型,做分级响应

不建议所有异常都返回 500。应根据错误性质分类处理:

  • 客户端错误(4xx):如参数缺失、格式错误、权限不足,返回对应 code(400/401/403/404),message 明确友好,不暴露内部细节
  • 服务端错误(5xx):如数据库连接失败、远程调用超时,返回 500 并记录详细日志,但 message 只显示“系统繁忙,请稍后重试”
  • 业务规则错误:如“余额不足”“订单已取消”,用自定义异常抛出,code 为业务码(如 20001),message 面向用户,前端可直接展示

配合 ResponseBodyAdvice 自动包装成功响应

避免每个 Controller 方法手动套 Result.success()。实现 ResponseBodyAdvice,在响应写入前自动判断:若返回值不是 Result 类型,则包装成 Result.success(原返回值)。这样接口可以干净地写 @GetMapping("/user") public User getUser(),框架自动转为 {"code":200,"message":"success","data":{...}},异常路径和成功路径响应结构完全对齐。

热门AI工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

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

WorkBuddy

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

DeepSeek

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

相关专题

更多
spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

691

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

1455

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

5526

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

436

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

680

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

405

2026.02.11

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

391

2026.02.12

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

366

2026.04.17

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

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