Spring Boot 参数校验怎么处理校验失败信息

风磊君_5586

风磊君_5586

2026-11-16

428人浏览

原创

spring boot 处理校验失败信息的核心做法是结合 @validated 或 @valid 注解触发校验,并通过全局异常处理器捕获 methodargumentnotvalidexception 或 bindexception。具体实现时,需要在 controller 方法参数前添加校验注解,并在配置类中注册一个返回统一格式的 @restcontrolleradvice。当校验失败时,框架会自动将错误详情封装进异常对象,开发者只需在处理器中提取这些字段级或对象级的错误消息,组装成前端友好的 json 结构返回即可。

Spring Boot 参数校验怎么处理校验失败信息

如何定义带校验规则的 DTO 并触发校验

要触发校验,首先需要定义一个数据传输对象(DTO),并在其字段上添加 JSR-303/JSR-380 标准提供的约束注解,如 @NotNull、@Size 或 @Email。接着,在 Spring MVC 的 Controller 中,使用 @Valid 或 @Validated 注解标记该 DTO 参数。当请求进入时,Spring 会拦截参数绑定过程,若发现数据不符合约束条件,便会抛出 MethodArgumentNotValidException。这种机制确保了业务逻辑层接收到的数据始终是合法的,无需手动编写大量的 if-else 判断语句。

Spring Boot 参数校验怎么处理校验失败信息

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;

public class UserDTO {
    @NotBlank(message = "用户名不能为空")
    private String username;

    @Size(min = 6, max = 20, message = "密码长度需在6到20位之间")
    private String password;

    // getter and setter
}
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;

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

    @PostMapping
    public String createUser(@Valid @RequestBody UserDTO user) {
        return "User created successfully";
    }
}

上述代码定义了包含用户名和密码字段的 UserDTO,其中用户名必须非空,密码长度受限。Controller 中的 createUser 方法接收该 DTO 并标注了 @Valid。如果请求体中缺少用户名或密码过短,Spring 将自动拒绝请求并抛出异常,从而阻止无效数据进入业务层。

如何全局捕获校验异常并格式化返回结果

为了向客户端提供清晰的错误提示,需要创建一个全局异常处理器,继承自 ResponseEntityExceptionHandler 或使用 @RestControllerAdvice。重点重写 handleMethodArgumentNotValid 方法,该方法专门处理 @RequestBody 校验失败的情况。在处理逻辑中,遍历 BindingResult 中的 FieldError 对象,提取每个字段的默认错误或自定义消息,并将其收集到一个列表中。最终,将这些错误信息封装在一个统一的响应结构中,例如包含状态码、错误消息列表和请求路径的对象,以便前端进行逐项展示。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

Spring Boot 参数校验怎么处理校验失败信息

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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.bind.annotation.ResponseStatus;

import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class GlobalValidationExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<map object>> handleValidationExceptions(
            MethodArgumentNotValidException ex) {
        Map<string object> body = new HashMap();
        body.put("status", HttpStatus.BAD_REQUEST.value());
        body.put("error", "Validation Failed");

        Map<string string> errors = new HashMap();
        for (FieldError error : ex.getBindingResult().getFieldErrors()) {
            errors.put(error.getField(), error.getDefaultMessage());
        }
        body.put("errors", errors);

        return new ResponseEntity(body, HttpStatus.BAD_REQUEST);
    }
}</string></string></map>

这段代码定义了一个全局异常处理器,专门捕获 MethodArgumentNotValidException。它遍历所有字段错误,将字段名映射到对应的错误消息,并存入一个名为 errors 的 Map 中。最终返回的 JSON 结构清晰地区分了 HTTP 状态、通用错误描述和具体的字段级错误详情,便于前端解析并高亮显示输入框中的错误提示。

当校验失败时返回的具体 JSON 结构是什么

当使用上述全局处理器且传入非法数据时,返回的 JSON 结构是一个包含三个顶层键的对象:status、error 和 errors。其中 status 为整数 400,表示客户端错误;error 为字符串 "Validation Failed";errors 是一个子对象,其键为发生校验失败的字段名(如 username),值为对应的错误提示信息(如 "用户名不能为空")。这种结构化的输出方式使得前端可以轻松地根据字段名定位错误位置,并展示具体的文本提示,而无需解析复杂的堆栈跟踪信息。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

12697

6

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

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

2023.07.05

9802

9

java自学难吗
java自学难吗

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

2023.07.31

8332

8

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

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

2023.08.01

1344

3

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

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

2023.08.02

1068

3

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

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

2023.08.02

1596

5

java有什么用
java有什么用

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

2023.08.02

3329

5

java在线网站
java在线网站

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

2023.08.03

20551

3

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

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

2023.08.03

1435

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习