展开菜单
首页 精品内容 本月促销 装机必备 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软件 更多
    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirServer Windows版
    AirServer Windows版

    AirServer Windows版可把电脑变成AirPlay、Google Cast和Miracast无线投屏接收端,适合会议演示、课堂教学及家庭大屏分享。发送设备通常无需另装客户端,并可同时接收和智能排列多个镜像会话。

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

    Copyright ©2018-2026