Spring Boot 全局异常处理:用 @RestControllerAdvice 统一接口错误

Spring Boot 使用@RestControllerAdvice实现捕获全局异常统一处理 1GlobalExceptionHandler 捕获全局异常统一处理器。 package com.handler; import org.springframework.web.bind.annotation.*; import javax.servlet.http.HttpServletRequest; import java.util.HashMap; import java.util.Map; /** * 捕获全局异常统一处理器 */ @RestControllerAdvice pu. 阅读详情

用户注册时,如果用户名已经被占用,Service 可以直接抛出 UsernameAlreadyExistsException。问题是,前端怎么才能收到 HTTP 409 和一句「用户名已被占用」?

一种写法是在 Controller 里加 try-catch。注册接口写一遍,修改用户名的接口再写一遍。等到提示文案或错误码需要调整,就要去多个地方找相同的代码。

Spring MVC 提供了更集中的写法:Service 在发现业务问题时抛出异常,全局异常处理器负责把异常转换成 HTTP 状态和 JSON 响应。 本文用一个可以实际发请求验证的注册接口,把这个过程走一遍。

一、先定好接口遇到错误时返回什么

注册接口是 POST /users。客户端提交一个用户名:

{
  "username": "xiaoming"
}

假设这个用户名已经注册过,服务端返回 HTTP 409 Conflict,响应体如下:

{
  "code": "USERNAME_ALREADY_EXISTS",
  "message": "用户名已被占用"
}

前端可以根据 code 把错误提示显示在用户名输入框旁边。以后把文案改成「这个名字已经有人用了」,判断逻辑也能继续使用。

本文约定三种错误:

场景HTTP 状态业务错误码谁发现问题
用户名为空或全是空格400INVALID_ARGUMENTSpring MVC 参数校验
用户名已经被占用409USERNAME_ALREADY_EXISTS注册服务
服务端出现未预期异常500INTERNAL_ERROR全局处理器兜底

二、写一个能触发异常的注册接口

示例使用 Java 17、Spring Boot 3.5 和 Spring MVC。项目需要 spring-boot-starter-web 和 spring-boot-starter-validation 两个依赖。以下类放在启动类所在包或其子包中,每个 public 类型单独一个文件。

先定义注册请求:

import jakarta.validation.constraints.NotBlank;

public record RegisterRequest(
        @NotBlank(message = "用户名不能为空")
        String username
) {}

再定义一个业务异常。异常类名本身就表达了失败原因:

public class UsernameAlreadyExistsException extends RuntimeException {

    public UsernameAlreadyExistsException() {
        super("用户名已被占用");
    }
}

注册服务用一个内存集合保存用户名,启动项目就能测试。`Set.add()` 会告诉我们这次添加是否成功,两个请求同时注册相同用户名时,并发集合也只会接受一次。

import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import org.springframework.stereotype.Service;

@Service
public class RegistrationService {

    private final Set<String> usernames = ConcurrentHashMap.newKeySet();

    public void register(String username) {
        if (!usernames.add(username.strip())) {
            throw new UsernameAlreadyExistsException();
        }
    }
}

最后写 Controller。注册成功返回 201 Created:

import jakarta.validation.Valid;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/users")
public class UserController {

    private final RegistrationService registrationService;

    public UserController(RegistrationService registrationService) {
        this.registrationService = registrationService;
    }

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public void register(@Valid @RequestBody RegisterRequest request) {
        registrationService.register(request.username());
    }
}

这段代码里有两条不同的失败路径。提交空用户名时,`@Valid` 在进入 register() 方法之前触发校验,对这个方法签名,Spring MVC 会抛出 MethodArgumentNotValidException。提交重复用户名时,参数校验通过,异常来自 RegistrationService。两条路径都可以交给同一个处理器。Spring MVC 参数校验文档

三、配置全局异常处理器

首先定义错误响应。这里取名 ApiError,避免和 Spring 自带的 ErrorResponse 类型混淆。

public record ApiError(String code, String message) {}

然后创建 GlobalExceptionHandler。如果项目习惯按职责分包,可以把它放进 exception 包。只要它位于组件扫描范围内,`@RestControllerAdvice` 就能生效,无需再给这个类添加 @Configuration。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.*;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    private static final Logger log =
            LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(
            MethodArgumentNotValidException ex,
            HttpHeaders headers,
            HttpStatusCode status,
            WebRequest request) {

        FieldError error = ex.getBindingResult().getFieldError();
        String message = error == null ? "请求参数有误" : error.getDefaultMessage();

        return new ResponseEntity<>(
                new ApiError("INVALID_ARGUMENT", message), headers, status);
    }

    @ExceptionHandler(UsernameAlreadyExistsException.class)
    public ResponseEntity<ApiError> handleUsernameConflict(
            UsernameAlreadyExistsException ex) {

        return ResponseEntity.status(HttpStatus.CONFLICT)
                .body(new ApiError("USERNAME_ALREADY_EXISTS", ex.getMessage()));
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ApiError> handleUnexpected(Exception ex) {
        log.error("处理请求时发生未预期异常", ex);

        return ResponseEntity.internalServerError()
                .body(new ApiError("INTERNAL_ERROR", "服务暂时不可用,请稍后重试"));
    }
}

这三个方法里,各有一个值得留意的细节。

参数校验失败时,从字段错误中取提示。 getDefaultMessage() 可以拿到 @NotBlank 上写的「用户名不能为空」。直接返回 ex.getMessage(),用户看到的可能是一大段包含参数和校验规则的技术描述。这里的表单只有一个字段,因此取第一条字段错误就够了。

业务失败时,同时设置 HTTP 状态和响应体。 ResponseEntity.status(HttpStatus.CONFLICT) 设置真正的 HTTP 409,`body(...)` 则负责 JSON 内容。如果处理方法只返回一个普通 ApiError 对象,响应体里的错误码本身不会设置 HTTP 状态。

意外异常要保留服务端堆栈。 log.error("...", ex) 把完整异常交给日志系统,客户端收到稳定的 INTERNAL_ERROR。示例继承了 ResponseEntityExceptionHandler,Spring MVC 已识别的常见请求错误仍由对应的具体处理逻辑接手,例如请求体 JSON 损坏时保留 HTTP 400。本文自定义了表格中的三类响应,其他框架异常仍使用基类的默认响应体。Spring MVC 异常处理文档

四、发三次请求,看看异常在哪一层发生

启动项目后,在 Postman 中选择 POST http://localhost:8080/users,Body 选择 raw → JSON。按顺序发送下面三次请求:

次数请求体预期结果
第一次{"username":" "}HTTP 400,提示「用户名不能为空」
第二次{"username":"xiaoming"}HTTP 201,注册成功,响应体为空
第三次{"username":"xiaoming"}HTTP 409,提示「用户名已被占用」

想看清楚执行顺序,可以在 registrationService.register(...) 和 handleUsernameConflict(...) 各打一个断点。第一次请求会在参数校验阶段结束。第二次请求进入 Service 并添加用户名。第三次请求中,`Set.add()` 返回 false,Service 抛出业务异常,随后程序会进入 handleUsernameConflict()。

如果要验证 500 兜底分支,可以在 Controller 测试里用 mock 让 registrationService.register(...) 抛出 IllegalStateException,断言 HTTP 状态为 500、响应中的 code 为 INTERNAL_ERROR。这样正常注册接口里也无需保留专门触发故障的代码。

五、两个实际开发中经常遇到的问题

为什么写了全局异常处理,前端还是收到了 HTTP 200?

先看处理方法的返回值。如果只是 return new ApiError(...),Spring 会把对象写进响应体。希望前端收到 400 或 409,可以像上例一样返回 ResponseEntity,或者在对应的处理方法上标记 @ResponseStatus。

为什么注册成功一次,重启项目后同名又能注册?

示例里的用户名保存在内存中,重启后集合会清空。换成数据库时,应给用户名建立唯一约束,并在保存时把用户名唯一约束冲突转换成 UsernameAlreadyExistsException。此时持久化方式发生了变化,客户端仍然收到相同的 HTTP 409 和业务错误码。

这也是全局异常处理在项目里的实际价值:以后新增「修改用户名」接口,只要它遇到占用情况时抛出同一个业务异常,现有处理器就能返回前端已经认识的那份 JSON。

同济土木非0基础三个月跨考复旦计算机攻略 跨考cs攻略前言我cs专业课如何复习How to start from zero简历其他复试 前言 建议多去工地/化工厂涡轮增压一下 我 同济土木gpa 3.2/5 挂科 * n 辣鸡项目 * n (padding 简历) 21考复旦计算机专硕 10月-12月 学习+复习 总分392 政治 68;背肖4即可 英语二 78 裸考,(高考英语140+);做点真题,建议据自己情况准备 数学二 142 ;(高考数学接近满分);做真题+模拟题,每天写一张试卷 专业课 104 ,考试生病了,下文展开。 cs专业课 阅读详情

相关推荐

Synares病毒实战:如何从U盘感染中恢复你的Excel和EXE文件(附专杀工具推荐)

本文详细介绍了Synares感染型病毒的典型特征与传播机制,特别是其通过U盘感染Excel和EXE文件的行为。文章提供了一套从应急隔离、诊断到使用专杀工具进行深度清除与文件恢复的完整实战流程,并推荐了有效的安全软件和修复方法,旨在帮助用户最大程度救回重要数据并构建长效安全防护习惯。

weixin_29230649的博客 1856

Spring Boot 3.x @RestControllerAdvice全局异常处理优先级问题详解

本文详细分析了Spring Boot 3.x中@RestControllerAdvice全局异常处理的优先级问题。主要内容包括: 问题背景:多个异常处理器间存在优先级冲突,导致异常被错误处理或执行顺序混乱。 问题现象:常见场景如处理器覆盖、异常匹配冲突、顺序混乱等,通过代码示例展示了优先级冲突情况。 原因分析:解析了Spring MVC异常处理机制、@RestControllerAdvice优先级规则以及Spring Boot 3.x的新变化。 解决方案:提出明确的@Order注解配置方案,包括基础优先级配

深山技术宅的博客 1458

【交易系统系列27】带你看懂订单的“奇幻漂流”

作为一个在交易所后台“厨房”里摸爬滚打了十多年的老兵,我将用一杯手冲咖啡的时间,带你亲历一次完整的订单“奇幻漂流”。本文将用一个“奶爸”的生活视角,硬核拆解**撮合(Matching)**、**清算(Clearing)**、**结算(Settlement)**和**出入金**这四大核心环节。这不仅是一次对**交易系统优化**和**撮合引擎架构**的深度剖析,更是一场关于传统金融与数字金融两种不同“上菜”哲学的真实故事。

weixin_43988453的博客 407

Spring Boot全局异常处理

/ 常用业务异常public static BusinessException PARAM_ERROR = new BusinessException("40001", "参数错误");public static BusinessException DATA_NOT_FOUND = new BusinessException("40401", "数据不存在");这套方案虽然简单,但涵盖了 Spring Boot 异常处理的核心要点。通过。

hmyyzdys的博客 1693

并行计算:从概念起源到多层次架构设计及其发展历程的全面解析

20世纪70年代,第一台并行计算机于1972年产生(ILLIAC IV,伊利诺依大学),由64个处理器组成,可扩展性好,但可编程性差。如有21亩地需要除草,一个人一天只能除一亩地的草,那么需要21天才能除完草,这在现实中是不太可能的,因庄稼是有时间段的。其二是机群系统是高性能计算机的一种,它的技术基础和工业基础都是商品化和标准化。之所以称为“专用”,并不是说它们只能运行某种应用,是指它们的组成部件是专门设计的,它们的CPU板、内存板和I/O板,甚至操作系统,都是不能在其它系统中使用的。

1658

FLACS-CFD 气云爆炸模拟全流程工况构建指南:从泄漏到爆炸

摘要: 本文详细介绍了使用FLACS-CFD模拟气云爆炸的全流程构建方法,重点解决泄漏模拟到爆炸模拟的气云文件传递问题。核心步骤包括: 项目规划:明确泄漏源(甲烷管道腐蚀泄漏)和爆炸场景,建立标准目录结构; 网格设计:泄漏与爆炸模拟需采用兼容的网格,爆炸域应为泄漏域的子区域且网格划分一致; 泄漏模拟配置:通过.inp文件定义几何、网格、风场、燃料及泄漏源参数,确保输出爆炸所需的气云文件(*.uni/*.fla); 关键设置:统一燃料名称、时间点匹配、路径正确性,避免版本兼容性问题。

huanghm88的专栏 772

Spring Boot 全局异常处理

说到异常处理,我们都知道使用 try-catch 可以捕捉异常,可以 throws 抛出异常。那么在 Spring Boot 中我们如何处理异常,如何是的处理更加优雅,如何全局处理异常。是本章讨论解决的问题。 首先让我们简单了解或重新学习下 Java 的异常机制。 本项目源码下载 1 Java 异常机制概述 Spring Boot 的所有异常处理都基于 java 的。 1.1 Java 异常类图 ...

fishpro的博客 1424

基于MATLAB的井筒多相流模拟

井筒多相流的模拟可以基于不同的数学模型和计算方法。其中,最常用的模型之一是多相流模型,它基于质量守恒、动量守恒和能量守恒等原理,描述了流体在井筒中的流动行为。对于井筒多相流的模拟和分析可以帮助我们理解和优化油气田开发过程中的流体行为,从而提高产量和效率。在本文中,我们将介绍如何使用MATLAB进行井筒多相流的模拟,并提供相应的源代码。需要注意的是,以上示例是一个简化的模拟,仅用于演示如何使用MATLAB进行井筒多相流模拟。实际应用中,我们需要考虑更多的物理过程和参数,并使用更复杂的数值方法和模型进行模拟。

AtdiHtml的博客 709

SpringBoot 全局异常统一处理(AOP):@RestControllerAdvice + @ExceptionHandler + @ResponseStatus

利用Spring框架提供的 **面向切面编程**(AOP)机制以及`@RestControllerAdvice`、`@ExceptionHandler`等注解,我们可以集中定义全局异常处理器类,统一捕获和处理所有Controller中可能抛出的异常。

宋冠巡的博客 5231

LPDDR4 JEDEC标准测试实例解析--写操作

LPDDR4的JEDEC标准一致性测试项详解以及实例分享,满满干货!感兴趣的小伙伴可以持续关注!!

一只豌豆象的博客 7788

JavaFX Stage

JavaFXStagejavafx.stage.Stage表示 JavaFX 桌面应用程序中的窗口。在 JavaFX 内部,Stage您可以插入一个 JavaFX Scene,它表示在窗口内显示的内容 - 在Stage.当 JavaFX 应用程序启动时,它会创建一个根Stage对象,该对象将传递给 start(Stage primaryStage)JavaFX 应用程序的根类的方法。此Stage 对象代表 JavaFX 应用程序的主窗口。

2012年开始工作,全栈开发老兵,目前已是一个老师,分享这么多年的心得体会 509

Spring Boot 中的 @RestControllerAdvice 全局异常处理器

Spring Boot 中的 @RestControllerAdvice 全局异常处理器

小李同学的博客 5092

【笔记篇】Davinci Configurator OS模块(下)

AUTOSAR OS的配置项和Vevtor MICROSAR OS的特性

weixin_47571898的博客 1160

利用快马AI平台快速实现Spring Boot全局异常处理:@RestControllerAdvice实战

定义一个。

BlackironLynx23的博客 836

SAP B1中文培訓教材_SDK

公司内部培训资料,对开发工具 ,DIAPI, UIAPI,Add-ON有详细解说

IDEA的使用指南

IDEA基于java的使用手册,可以最快速的上手,在使用中不断的丰富自己的使用技巧.

【Spring Boot + MyBatis|第6篇】全局异常处理 @RestControllerAdvice 详解

在项目中,接口运行时可能会出现各种异常。比如参数为空、数据不存在、数据库操作失败等。如果每个 Controller 方法都写 try-catch,代码会变得很乱。所以 Spring Boot 提供了全局异常处理机制,可以统一处理项目中的异常。这一篇我们来学习和的使用。全局异常处理可以让项目的错误返回更加统一,也能让 Controller 代码更加干净。负责声明全局异常处理类,负责指定处理哪一种异常。普通异常可以统一返回通用错误提示,业务异常可以返回更明确的提示信息。下一篇可以继续写。

2401_88139521的博客 680

老版QQ原生表情gif动态

这是老版的QQ表情,不过全是动态的的,Windows照片查看器是不会动的,可以右击用浏览器打开查看,再说一遍是老版的,只是分享给宁愿用老版也要动态的人。

Spring Boot全局异常处理最佳实践:@RestControllerAdvice深度解析

通过实现全局异常处理可以:提高代码可维护性增强系统健壮性改善用户体验便于监控报警。

2301_79437276的博客 1518

vb 6.0并口开发操作实例

vb6并口开发,简体中文,试例内有inpout32.dll动态链接库

Spring Boot全局异常处理:一网打尽Controller层异常,@RestControllerAdvice解析

全局处理控制器异常响应体自动序列化(JSON/XML)2、异常处理优先级Controller局部处理器 > 全局处理器具体异常 > 通用异常3.最佳实践// 返回明确HTTP状态码// 使用ResponseEntity精确控制响应// 自定义响应头等复杂操作4、生产环境建议禁用敏感错误信息(spring.mvc.include-error-details)自定义错误码体系异常国际化支持So, 当再次处理错误时,应该能独挡一面了。

nextera的博客 639

Spring Boot 入门:全局异常处理 + 统一返回格式

在实际开发中,我们会遇到很多 “业务异常”(比如 “余额不足”“手机号已存在”),这些异常不是系统错误,而是业务逻辑不允许的情况。我们可以自定义一个,专门处理这类异常。比如我们想在 “新增用户时,如果手机号已存在,就抛异常”,修改的addUser// @Service:标记这是Service层实现类,Spring自动管理@Service// 注入UserMapper(Spring自动创建实例)@Autowired@Override// 调用Mapper方法@Override。

weixin_42847133的博客 1407

Spring boot全局异常统一处理@RestControllerAdvice

@RestControllerAdvice注解定义全局处理异常类,可以返回JSON格式提示信息 1、使用方法 import com.zytech.mobile.common.ServerResponse; import org.springframework.web.HttpRequestMethodNotSupportedException; import org.springframework...

chenyi406的博客 498

如何用AI自动生成Spring Boot的@RestControllerAdvice代码

对于常见的NullPointerException和IllegalArgumentException等特定异常,AI会生成专门的处理方法。AI生成的代码会自动创建这个基础结构,包含处理所有未捕获异常的通用方法。生成的代码会返回统一的JSON格式响应,包含错误码、错误信息和时间戳三个标准字段。它会提取校验失败的字段和原因,整理成结构化的错误信息返回,避免了手动解析BindingResult的繁琐工作。生成的代码会在每个异常处理方法中加入日志记录逻辑,使用SLF4J记录错误级别日志。

BlackStone33的博客 885

利用快马AI一键生成Spring Boot全局异常处理:@RestControllerAdvice实战

只需输入简单的需求描述,平台就能快速生成包含全局异常处理功能的Spring Boot项目代码,大大节省了开发时间。平台的代码生成功能非常智能,能够根据需求自动配置异常处理、统一响应格式等常见功能,让开发者更专注于业务逻辑的实现。同时,参数校验失败时,前端会收到格式统一的错误响应,而不是Spring默认的冗长错误信息。:结合Spring AOP,可以在异常处理前后添加额外的逻辑,比如发送告警邮件或短信。,统一处理参数校验失败的情况,避免在每个Controller中重复编写校验逻辑。

CyanWave34的博客 447

Spring Boot小白必学:@RestControllerAdvice从零到精通

可以快速创建Spring Boot项目体验这些功能,它的在线编辑器直接内置了运行环境,写完代码一键就能看到效果,特别适合新手练习。我实际使用时发现,不用配置本地Java环境这点真的省心,遇到问题还能随时查看官方示例,学习曲线平缓多了。经过反复实践和总结,终于搞清楚了它的核心用法。今天就以最通俗的方式,分享一下我的学习心得,希望能帮助到同样在入门路上的小伙伴。的组合体,专门为RESTful API设计,省去了我们手动添加@ResponseBody的麻烦。时,都会自动跳转到这个方法处理,返回我们定义好的响应。

SapphireOwl29的博客 682

解决SpringBoot项目中@RestControllerAdvice全局异常失效问题

解决SpringBoot项目中@RestControllerAdvice全局异常失效问题

weixin_47316183的博客 1万+

Spring Boot 面试题——全局异常处理

(1)在 Spring Boot 中, 注解和 注解都可以用于定义全局异常处理器类,它们在实现上没有实质性的区别,只是对返回值类型有略微的不同要求:(2)两者的区别在于,@ControllerAdvice 需要返回视图或 HTML 页面,所以处理器方法必须返回 ModelAndView 对象或者 String 类型的视图名称;而 @RestControllerAdvice 只需要返回纯数据(JSON 或 XML 格式的数据),所以处理器方法可以直接返回对象、字符串等数据类型。具体实现上只要在类上标注相应的

代码星辰的博客 1754

Spring Boot 统一返回格式 + 全局异常处理(实战版)

先定义一个枚举类,管理所有接口的状态码和对应提示信息,避免硬编码错误码,便于后续维护(可根据项目需求扩展)。/*** 统一返回状态码枚举* 规范:200=成功,4xx=客户端错误,5xx=服务端错误,自定义错误码从1000开始*/// 成功状态SUCCESS(200, "操作成功"),// 客户端错误(4xx)PARAM_ERROR(400, "参数错误"),NOT_FOUND(404, "资源不存在"),METHOD_NOT_ALLOWED(405, "请求方法不允许"),

码客日记的博客 1255

【Spring Boot】全局异常处理器与日志追踪

一套完善的异常日志捕获往往能给我们的日常工作带来许许多多的便利。不仅要能方便还原出错信息,也要能快速定位到出错日志位置。 下面我将结合@RestControllerAdvice和@ExceptionHandler实现一个全局异常处理器,并且通过请求OncePerRequestFilter过滤器来获取请求头ID来定位异常日志位置。最后基于Logback来将日志保存到本地。

Arabys的博客 1097
上一篇: Java 项目实战:用 Spring Boot 实现文件上传,从 MultipartFile 到统一 JSON 响应
下一篇: Spring Boot 拦截器实战:用 HandlerInterceptor 实现登录校验
爱方舟的爪子
博客等级 码龄2年 0粉丝 12原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值
⌂ 换网址