Spring Boot Validation实战详解:从入门到自定义规则

目录

一、Spring Boot Validation简介

1.1 什么是spring-boot-starter-validation?

1.2 核心优势

二、快速集成与配置

2.1 添加依赖

2.2 基础配置

三、核心注解详解

3.1 常用校验注解

3.2 嵌套对象校验

四、实战开发步骤

4.1 DTO类定义校验规则

4.2 Controller层启用校验

4.3 统一异常处理

五、高级功能实现

5.1 自定义校验规则

5.2 分组校验

六、常见问题与解决方案

6.1 校验不生效的常见原因

6.2 国际化配置

七、性能优化建议

八、测试验证

8.1 单元测试示例

8.2 API测试(使用MockMvc)

九、总结与最佳实践


一、Spring Boot Validation简介

1.1 什么是spring-boot-starter-validation?

  spring-boot-starter-validation 是Spring Boot对Bean Validation API(JSR 380)的封装实现,基于Hibernate Validator提供强大的数据校验功能。它能帮助开发者:

  • 声明式校验:通过注解定义校验规则

  • 统一错误处理:自动生成标准错误响应

  • 多层级校验:支持DTO、Controller、Service各层

1.2 核心优势

  • 零配置启动:自动装配Validator

  • 丰富注解库:内置30+常用校验规则

  • 高度可扩展:支持自定义校验规则

  • 国际化支持:轻松实现多语言错误提示


二、快速集成与配置

2.1 添加依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2.2 基础配置

application.yml

spring:messages:basename: i18n/validation # 国际化文件路径encoding: UTF-8server:error:include-message: always # 显示具体错误信息
 

三、核心注解详解

3.1 常用校验注解

注解适用类型说明示例
@NotNull任意类型值不能为null@NotNull(message="ID必填")
@NotEmptyString/Collection非空且长度/大小>0@NotEmpty
@NotBlankString至少包含一个非空格字符@NotBlank
@Size字符串/集合长度/大小范围@Size(min=6, max=20)
@EmailString邮箱格式校验@Email
@PatternString正则表达式匹配@Pattern(regexp="^1[3-9]\\d{9}$")
@Min/@Max数值类型数值范围限制@Min(18)
@Future/@Past时间类型未来/过去时间校验@Future

3.2 嵌套对象校验

public class OrderDTO {@Valid // 启用嵌套校验private UserDTO user;@Validprivate List<@Valid ProductItem> items;
}public class UserDTO {@NotBlankprivate String name;@Emailprivate String email;
}
 

四、实战开发步骤

4.1 DTO类定义校验规则

public class UserCreateRequest {@NotBlank(message = "{user.name.required}")@Size(max = 50, message = "{user.name.length}")private String name;@Email(message = "{user.email.invalid}")private String email;@Pattern(regexp = "^(?=.*[A-Za-z])(?=.*\\d)[A-Za-z\\d]{8,}$", message = "{user.password.policy}")private String password;
}

4.2 Controller层启用校验

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody @Valid UserCreateRequest request) {// 业务逻辑处理return ResponseEntity.ok(userService.create(request));
}

4.3 统一异常处理

@RestControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(MethodArgumentNotValidException.class)public ResponseEntity<ErrorResponse> handleValidationException(MethodArgumentNotValidException ex) {List<String> errors = ex.getBindingResult().getFieldErrors().stream().map(error -> error.getField() + ": " + error.getDefaultMessage()).collect(Collectors.toList());return ResponseEntity.badRequest().body(new ErrorResponse("VALIDATION_FAILED", errors));}
}
 

五、高级功能实现

5.1 自定义校验规则

步骤1:创建注解

@Target({FIELD, PARAMETER})
@Retention(RUNTIME)
@Constraint(validatedBy = PhoneNumberValidator.class)
public @interface PhoneNumber {String message() default "{validation.phone.invalid}";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};
}

步骤2:实现校验逻辑

public class PhoneNumberValidator implements ConstraintValidator<PhoneNumber, String> {private static final Pattern PHONE_PATTERN = Pattern.compile("^1[3-9]\\d{9}$");@Overridepublic boolean isValid(String value, ConstraintValidatorContext context) {if (value == null) return true; // 允许空值,配合@NotNull使用return PHONE_PATTERN.matcher(value).matches();}
}

5.2 分组校验

public interface CreateGroup {}
public interface UpdateGroup {}public class UserDTO {@Null(groups = CreateGroup.class)@NotNull(groups = UpdateGroup.class)private Long id;@NotBlank(groups = {CreateGroup.class, UpdateGroup.class})private String name;
}@PostMapping("/users")
public ResponseEntity<?> createUser(@RequestBody @Validated(CreateGroup.class) UserDTO dto) {// 创建逻辑
}
 

六、常见问题与解决方案

6.1 校验不生效的常见原因

  1. 缺少@Valid注解:Controller方法参数前忘记添加

  2. 错误异常处理:覆盖了默认的异常处理逻辑

  3. 静态嵌套类:DTO使用static内部类导致无法实例化

  4. 字段访问权限:校验字段需要getter方法

6.2 国际化配置

messages.properties

user.name.required=用户名不能为空
user.email.invalid=邮箱格式不正确
validation.phone.invalid=手机号格式错误

validation_zh_CN.properties

javax.validation.constraints.NotNull.message=不能为null
 

七、性能优化建议

  1. 避免过度校验:只在必要层级进行校验

  2. 合理使用校验组:减少不必要的校验逻辑

  3. 缓存Validator:重复使用Validator实例

@Bean
public Validator validator() {return Validation.buildDefaultValidatorFactory().getValidator();
}
 

八、测试验证

8.1 单元测试示例

@SpringBootTest
public class UserValidationTest {@Autowiredprivate Validator validator;@Testvoid whenInvalidEmail_thenValidationFails() {UserCreateRequest request = new UserCreateRequest();request.setEmail("invalid-email");Set<ConstraintViolation<UserCreateRequest>> violations = validator.validate(request);assertThat(violations).hasSize(1);}
}

8.2 API测试(使用MockMvc)

@WebMvcTest(UserController.class)
class UserControllerTest {@Autowiredprivate MockMvc mvc;@Testvoid createUser_withInvalidPassword_returnsBadRequest() throws Exception {String json = """{"name": "test","email": "test@example.com","password": "123"}""";mvc.perform(post("/users").contentType(APPLICATION_JSON).content(json)).andExpect(status().isBadRequest()).andExpect(jsonPath("$.errors[0]").value("password: 密码必须包含字母和数字"));}
}
 

九、总结与最佳实践

  1. 分层校验原则

    • Controller层:校验输入格式

    • Service层:校验业务规则

    • DAO层:校验数据完整性

  2. 错误消息规范

    • 使用明确的错误代码

    • 保持消息内容用户友好

    • 实现多语言支持

  3. 文档化校验规则

    • 在Swagger文档中展示参数约束

    • 维护校验规则变更日志

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/web/78746.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

理清缓存穿透、缓存击穿、缓存雪崩、缓存不一致的本质与解决方案

在构建高性能系统中&#xff0c;缓存&#xff08;如Redis&#xff09; 是不可或缺的关键组件&#xff0c;它大幅减轻了数据库压力、加快了响应速度。然而&#xff0c;在高并发环境下&#xff0c;缓存也可能带来一系列棘手的问题&#xff0c;如&#xff1a;缓存穿透、缓存击穿、…

PyTorch_构建线性回归

使用 PyTorch 的 API 来手动构建一个线性回归的假设函数&#xff0c;数据加载器&#xff0c;损失函数&#xff0c;优化方法&#xff0c;绘制训练过程中的损失变化。 数据构建 import torch from sklearn.datasets import make_regression import matplotlib.pyplot as plt i…

005-nlohmann/json 基础方法-C++开源库108杰

《二、基础方法》&#xff1a;节点访问、值获取、显式 vs 隐式、异常处理、迭代器、类型检测、异常处理……一节课搞定C处理JSON数据85%的需求…… JSON 字段的简单类型包括&#xff1a;number、boolean、string 和 null&#xff08;即空值&#xff09;&#xff1b;复杂类型则有…

HarmonyOS 5.0 分布式数据协同与跨设备同步​​

大家好&#xff0c;我是 V 哥。 使用 Mate 70有一段时间了&#xff0c;系统的丝滑使用起来那是爽得不要不要的&#xff0c;随着越来越多的应用适配&#xff0c;目前使用起来已经和4.3的兼容版本功能差异无碍了&#xff0c;还有些纯血鸿蒙独特的能力很是好用&#xff0c;比如&am…

Linux云计算训练营笔记day02(Linux、计算机网络、进制)

Linux 是一个操作系统 Linux版本 RedHat Rocky Linux CentOS7 Linux Ubuntu Linux Debian Linux Deepin Linux 登录用户 管理员 root a 普通用户 nsd a 打开终端 放大: ctrl shift 缩小: ctrl - 命令行提示符 [rootlocalhost ~]# ~ 家目录 /root 当前登录的用户…

macOS 安装了Docker Desktop版终端docker 命令没办法使用

macOS 安装了Docker Desktop版终端docker 命令没办法使用 1、检查Docker Desktop能否正常运行。 确保Docker Desktop能正常运行。 2、检查环境变量是否添加 1、添加环境变量 如果环境变量中没有包含Docker的路径&#xff0c;你可以手动添加。首先&#xff0c;找到Docker的…

Gradio全解20——Streaming:流式传输的多媒体应用(5)——基于WebRTC的摄像头实时目标检测

Gradio全解20——Streaming&#xff1a;流式传输的多媒体应用&#xff08;5&#xff09;——基于WebRTC的摄像头实时目标检测 本篇摘要20. Streaming&#xff1a;流式传输的多媒体应用20.5 基于WebRTC的摄像头实时目标检测20.5.1 环境配置及说明1. WebRTC2. TURN服务器 20.5.2 …

OSCP - Proving Grounds - NoName

主要知识点 linux命令注入SUID find提权 具体步骤 从nmap开始搜集信息&#xff0c;只开放了一个80端口 Nmap scan report for 192.168.171.15 Host is up (0.40s latency). Not shown: 65534 closed tcp ports (reset) PORT STATE SERVICE VERSION 80/tcp open http …

c++_csp-j算法 (6)_高精度算法(加减乘除)

高精度算法 C++高精度算法是指在C++编程语言中实现高精度计算的算法。在C++中,通常整数的范围是有限的,超出这个范围的整数计算会导致溢出。高精度算法的出现,使得C++程序能够处理超出常规整数范围的大整数计算,包括高精度加法、减法、乘法、除法等运算。 在C++中实现高精…

从OpenMP中的不兼容,窥探AI应用开发中的并行编程

在AI相关的项目开发中,偶然遇到下面这个问题: OMP: Error #15: Initializing libomp.dylib, but found libiomp5.dylib already initialized. OMP: Hint This means that multiple copies of the OpenMP runtime have been linked into the progr am. That is dangerous, sin…

vue2+element实现Table表格嵌套输入框、选择器、日期选择器、表单弹出窗组件的行内编辑功能

vue2element实现Table表格嵌套输入框、选择器、日期选择器、表单弹出窗组件的行内编辑功能 文章目录 vue2element实现Table表格嵌套输入框、选择器、日期选择器、表单弹出窗组件的行内编辑功能前言一、准备工作二、行内编辑1.嵌入Input文本输入框1.1遇到问题1.文本框内容修改失…

c#OdbcDataReader的数据读取

先有如下c#示例代码&#xff1a; string strconnect "DSNcustom;UIDsa;PWD123456;" OdbcConnection odbc new OdbcConnection(strconnect); odbc.Open(); if (odbc.State ! System.Data.ConnectionState.Open) { return; } string strSql "select ID from my…

【HTML5】老式放映机原理-实现图片无缝滚动

老式放映机原理-实现图片无缝滚动 实现思路&#xff1a; 页面设计部分——先将视口div设置为相对定位&#xff0c;再视口div里面嵌套一个类似“胶卷”的div,把该div设置为绝对定位&#xff0c;此时“胶卷"会挂靠在视口上面&#xff0c;再将“胶卷”的left属性设置为负值…

LeetCode 1781. 所有子字符串美丽值之和 题解

示例 输入&#xff1a;s "aabcb" 输出&#xff1a;5 解释&#xff1a;美丽值不为零的字符串包括 ["aab","aabc","aabcb","abcb","bcb"] &#xff0c;每一个字符串的美丽值都为 1这题光用文字解说还是无法达到讲…

2025ACTF Web部分题解

文章目录 ACTF uploadnot so web 1not so web 2 ACTF upload 前面登录随便输入可以进入文件上传页面, 随便上传一张图片, 发现路由存在file_path参数, 尝试路径穿越读取文件 发现可以成功读取 读取源码 /upload?file_path../app.pyimport uuid import os import hashlib im…

双目标清单——AI与思维模型【96】

一、定义 双目标清单思维模型是一种将决策或任务分解为两个主要目标&#xff0c;并分别列出相关要素和行动步骤的思维方式。这两个目标通常具有相互关联又有所侧重的特点&#xff0c;通过明确并列出与每个目标相关的具体事项&#xff0c;有助于更清晰地分析问题、制定计划和分…

深度学习系统学习系列【6】之深度学习技巧

文章目录 数据集准备数据集扩展数据预处理1. 0均值&#xff08;Zero Centralization&#xff09;代码实现 2. 归一化&#xff08;Normalization&#xff09;代码实现 3. 主成分分析&#xff08;Principal Component Analysis, PCA&#xff09;实现步骤代码实现 4. 白化&#xf…

rfsoc petalinux适配调试记录

1。安装虚拟机 2.设置共享文件夹 https://xinzhi.wenda.so.com/a/1668239544201149先设置文件夹路径 vmware 12 下安装 ubuntu 16.04 后&#xff0c;按往常的惯例安装 vmware-tools&#xff0c;安装时提示建议使用 open-vm-tools&#xff0c;于是放弃 vmware-tools 的安装&am…

# YOLOv1:开启实时目标检测的新时代

YOLOv1&#xff1a;开启实时目标检测的新时代 在计算机视觉领域&#xff0c;目标检测一直是研究的热点和难点问题。它不仅需要准确地识别出图像中的物体&#xff0c;还需要确定这些物体的位置。YOLO&#xff08;You Only Look Once&#xff09;系列算法以其高效的实时目标检测…

uni-app vue3 实现72小时倒计时功能

功能介绍 &#xff0c;数组项有一个下单时间 &#xff0c;比如今天下单在72小时内可以继续支付&#xff0c;超过则默认取消订单 页面按钮处 加上倒计时 <!-- 倒计时 --> <text v-if"item.timeLeft > 0">{{ formatTime(item.remaining) }}</text&g…