展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > SpringBoot全局异常处理与参数校验功能实现

SpringBoot全局异常处理与参数校验功能实现

通过@ControllerAdvice和@ExceptionHandler构建全局异常处理器,统一返回含错误码和信息的JSON,确保接口错误响应一致。定义BaseExceptionInterface接口和BizException异常类,使用枚举集中管理错误码,方便维护。参数校验依赖@Valid及校验注解,需引入spring-boot-starter-vali

本文目录

    后端接口报错,要是直接让异常往外抛,前端收到的要么是一大段 Tomcat 默认的 HTML 错误页,要么是乱七八糟的堆栈信息。前端同学一看就懵了——这到底是啥错?该提示用户什么?

    SpringBoot全局异常处理与参数校验功能实现

    所以得有一层兜底:不管哪层出了什么岔子,返回给前端的东西始终是统一格式的 JSON——有错误码、有错误信息,前端拿到手就能稳稳地做判断和处理。

    参数校验也得一起安排上。Controller 里别写一堆 if (xxx == null),用注解声明规则,校验不通过直接抛异常,再由全局处理器统一拦截、统一返回。代码干净,逻辑也清晰。

    引入依赖

    @ControllerAdvice 和 @ExceptionHandler 这些都在 spring-boot-starter-web 里,如果你项目已经用了 Web 模块,这部分就不用重复加了。

    但参数校验的依赖需要单独拎出来:

    
        org.springframework.boot
        spring-boot-starter-validation
    

    注意一下版本差异:Spring Boot 2.x 时代,validation 是内嵌在 spring-boot-starter-web 里的,到了 3.x 就被拆出来了。如果不加这个依赖,@NotBlank、@Valid 这些注解不会报编译错误,但运行时校验根本不生效——加了个寂寞,所有参数直接放行。

    第一步:搭异常体系

    common

    先搭两个基础的东西:异常接口 + 异常类。这两个放在 common 模块,全项目都能复用。

    BaseExceptionInterface

    public interface BaseExceptionInterface {
        String getErrorCode();
        String getErrorMessage();
    }
    

    一个很简单的接口,它就规定一件事:异常必须包含错误码和错误信息。后面我们的枚举实现它,BizException 也依赖它,所有东西都围绕这个约定来走。

    BizException

    BizException 代表业务异常,每个模块都可能出现,所以定义在 common 里最合适。

    @Getter
    @Setter
    public class BizException extends RuntimeException {
        private String errorCode;
        private String errorMessage;
        public BizException(BaseExceptionInterface baseExceptionInterface) {
            this.errorCode = baseExceptionInterface.getErrorCode();
            this.errorMessage = baseExceptionInterface.getErrorMessage();
        }
    }

    继承 RuntimeException,有两个好处:抛的时候不用在方法签名上加 throws,Spring 对运行时异常默认也会做事务回滚。构造参数只接收 BaseExceptionInterface,不让你随便写 new BizException("随便写的错")——所有异常必须提前在枚举里定义好,方便统一管理。

    具体业务模块

    接下来定义你这个模块可能有哪些异常。

    ResponseCodeEnum

    @Getter
    @AllArgsConstructor
    public enum ResponseCodeEnum implements BaseExceptionInterface {
        // 通用异常
        SYSTEM_ERROR("AUTH-10000", "出错啦,后台小哥正在努力修复中..."),
        PARAM_NOT_VALID("AUTH-10001", "参数错误"),
        // 业务异常往后加
        ;
        private final String errorCode;
        private final String errorMessage;
    }

    这里有个小巧妙:BaseExceptionInterface 定义的 getErrorCode 和 getErrorMessage 两个方法,枚举里定义了两个变量,加上 @Getter,刚好就把接口方法给实现了。巧不巧?

    要点说明
    实现 BaseExceptionInterface枚举实例可以直接丢进 BizException 的构造参数
    错误码前缀AUTH 代表这个模块,不同模块用不同前缀,比如订单模块用 ORDER-20000,一眼就能看出问题出在哪
    后面加什么登录失败、用户不存在、权限不足……随着业务迭代,直接在枚举里加新的即可

    抛一个业务异常就一句话:

    throw new BizException(ResponseCodeEnum.SYSTEM_ERROR);
    

    三者关系

    BizException 的构造参数是 BaseExceptionInterface(接口),不是 ResponseCodeEnum(具体枚举)。所以层级关系是这样的:

    BizException 构造参数
            ↓ 依赖
    BaseExceptionInterface(接口:规定必须有 errorCode + errorMessage)
            ↑ 实现
    ResponseCodeEnum(枚举:集中管理所有错误码)
    • 接口 起约定作用:不管哪个模块、哪个枚举,只要你实现了这两个 getter,就能丢进 BizException
    • 枚举 起集中管理作用:所有错误码一处定义,不散落
    • BizException 只认接口不认枚举,auth 模块的 AuthResponseCodeEnum、order 模块的 OrderResponseCodeEnum,只要实现了接口,都能用

    如果直接用 new BizException(String, String),错误码就会散落在项目各个角落,改一个提示语得全项目搜索,想看看系统里有哪些错误码更是无从下手。

    第二步:全局异常处理器

    @ControllerAdvice
    @Slf4j
    public class GlobalExceptionHandler {
        /** 业务异常 */
        @ExceptionHandler({ BizException.class })
        @ResponseBody
        public Response handleBizException(HttpServletRequest request, BizException e) {
            log.warn("{} request fail, errorCode: {}, errorMessage: {}",
                    request.getRequestURI(), e.getErrorCode(), e.getErrorMessage());
            return Response.fail(e);
        }
        /** 参数校验失败 */
        @ExceptionHandler({ MethodArgumentNotValidException.class })
        @ResponseBody
        public Response handleMethodArgumentNotValidException(
                HttpServletRequest request, MethodArgumentNotValidException e) {
            String errorCode = ResponseCodeEnum.PARAM_NOT_VALID.getErrorCode();
            BindingResult bindingResult = e.getBindingResult();
            StringBuilder sb = new StringBuilder();
            Optional.ofNullable(bindingResult.getFieldErrors()).ifPresent(errors -> {
                errors.forEach(error ->
                    sb.append(error.getField())
                      .append(" ")
                      .append(error.getDefaultMessage())
                      .append(", 当前值: '")
                      .append(error.getRejectedValue())
                      .append("'; ")
                );
            });
            log.warn("{} request error, errorCode: {}, errorMessage: {}",
                    request.getRequestURI(), errorCode, sb.toString());
            return Response.fail(errorCode, sb.toString());
        }
        /** 其他未捕获的异常——兜底 */
        @ExceptionHandler({ Exception.class })
        @ResponseBody
        public Response handleOtherException(HttpServletRequest request, Exception e) {
            log.error("{} request error", request.getRequestURI(), e);
            return Response.fail(ResponseCodeEnum.SYSTEM_ERROR);
        }
    }
    
    

    三个关键注解

    注解干什么的
    @ControllerAdvice全局增强,所有 Controller 的异常都会被这里的 @ExceptionHandler 拦截
    @ExceptionHandler声明这个方法专门处理哪种类型的异常
    @ResponseBody返回的内容直接序列化为 JSON,不走视图模板

    三层兜底结构

    Exception(其他所有异常)         ← 第三层:保底,全拦住了
      └─ MethodArgumentNotValidException  ← 第二层:参数校验
      └─ BizException                      ← 第一层:业务异常

    Spring 的匹配规则是找最精确的。如果抛的是 BizException,只走第一个 handler;抛的是 MethodArgumentNotValidException,走第二个;其他任何没被前两个匹配到的异常,都掉进第三个兜底。三层覆盖,不会有漏网之鱼。

    注意看日志级别:BizException 用的 log.warn,因为它是业务"可预期"的错,不需要大惊小怪。最后那个 Exception 用 log.error 并打印了堆栈,因为这是真正该修 bug 的异常。

    第三步:参数校验

    上面那个 MethodArgumentNotValidException 是什么时候抛的?当加了 @Valid 的入参校验不通过时。

    在实体类属性上加校验注解

    @Data
    public class User {
        @NotBlank(message = "昵称不能为空")
        private String nickName;
        private LocalDateTime createTime;
    }

    在 Controller 方法参数里加 @Valid

    @PostMapping("/test2")
    @ApiOperationLog(description = "测试接口2")
    public Response test2(@Valid @RequestBody User user) {
        return Response.success(user);
    }

    注意 @Valid 是加在方法参数上的,不是加在类上。两个动作缺一不可:

    • 类上没有 @NotBlank → 不会校验,什么都能通过
    • 方法参数没有 @Valid → 不会触发校验,注解成了摆设

    校验错误信息是怎么拼出来的?

    GlobalExceptionHandler 里的 handleMethodArgumentNotValidException 遍历了 bindingResult.getFieldErrors(),把每条错误的字段名、校验描述、实际收到的值拼接在一起:

    sb: "nickName 昵称不能为空, 当前值: ''; "

    这样前端一看到就知道是哪个字段出问题、为什么不通过、实际传了什么值,排查效率高不少。

    常用校验注解

    注解校验规则
    @NotBlank不能为 null 且不能是空字符串(""不行," "也不行)
    @NotNull不能为 null(但 "" 可以通过)
    @NotEmpty不能为 null 且不能是空集合或空字符串
    @Email必须是邮箱格式
    @Size(min, max)字符串或集合的长度范围
    @Min / @Max数字的最小值/最大值
    @Pattern(regexp)自定义正则校验

    选哪个要看业务场景。比如昵称不允许空字符串,用 @NotBlank 而不是 @NotNull,因为 @NotNull 允许 "" 通过,这个差别很关键。

    完整流程串联

    以一个参数校验失败的请求为例,整个调用链路是这样的:

    1. 前端 POST /test2,body 为 { "nickName": "" }
    2. Spring 将 JSON 序列化为 User 对象
    3. @Valid 触发校验 → @NotBlank 校验失败
    4. Spring 抛出 MethodArgumentNotValidException
    5. @ControllerAdvice 中的 handleMethodArgumentNotValidException 将其拦截
    6. 遍历错误字段,拼出 "nickName 昵称不能为空, 当前值: ''; "
    7. 返回 Response.fail("AUTH-10001", "...") → 最终输出为 JSON

    前端从头到尾拿到的都是统一结构,一个 if (response.success) 就能判断是否正常,处理起来非常清爽。

    如何使用业务异常

    想手动中断一个请求、返回错误信息给前端,直接这样写:

    // 不满足条件,直接抛
    if (user == null) {
        throw new BizException(ResponseCodeEnum.SYSTEM_ERROR);
    }
    

    在 ResponseCodeEnum 里加新的异常码:

    // 通用异常
    SYSTEM_ERROR("AUTH-10000", "出错啦,后台小哥正在努力修复中..."),
    PARAM_NOT_VALID("AUTH-10001", "参数错误"),
    // 业务异常
    LOGIN_FAILED("AUTH-20001", "用户名或密码错误"),
    USER_NOT_FOUND("AUTH-20002", "用户不存在"),
    UNAUTHORIZED("AUTH-20003", "没有访问权限"),
    ;

    然后在代码里直接抛:

    throw new BizException(ResponseCodeEnum.LOGIN_FAILED);

    所有异常码统一管理、统一抛出、统一处理,整个异常体系就非常规整了。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。

    Cubase Windows版
    Cubase Windows版

    Cubase 是 Steinberg 推出的数字音频工作站,提供 MIDI 编曲、多轨录音、音频编辑、虚拟乐器、效果处理、自动化、混音和母带输出工具。其 Pro、Artist 与 Elements 版本面向不同预算和制作规模,

    网站备案号:苏ICP备2026018738号-1 联系邮箱:bd@zhengruan.com

    Copyright ©2018-2026