优雅的参数校验(@Validated)

在 Spring Boot 项目里,@Validated注解主要用于实现方法参数的校验。它既可以用在类级别,开启方法参数校验功能,也能应用于方法参数上,对传入的参数进行校验。

首先,要在项目中添加校验依赖。如果你使用的是spring-boot-starter-web,就无需额外添加依赖,因为它已经包含了hibernate-validator

对于需要校验的对象添加注解:

1. 空值检查

注解 功能描述
@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null,但可以是空字符串或空集合。
@NotEmpty 被注释的字符串、集合、数组或 Map 必须不为 null 且长度 / 大小大于 0。
@NotBlank 被注释的字符串必须不为 null,且至少包含一个非空白字符。

2. 数值检查

注解 功能描述
@Min(value) 被注释的数值必须大于或等于指定的最小值(适用于数字类型)。
@Max(value) 被注释的数值必须小于或等于指定的最大值(适用于数字类型)。
@DecimalMin(value) 被注释的数值必须大于或等于指定的小数值(字符串表示,避免精度问题)。
@DecimalMax(value) 被注释的数值必须小于或等于指定的小数值(字符串表示,避免精度问题)。
@Digits(integer, fraction) 被注释的数值必须是数字,且整数部分位数不超过 integer,小数部分不超过 fraction
@Positive 被注释的数值必须是正数(不包括 0)。
@PositiveOrZero 被注释的数值必须是正数或 0。
@Negative 被注释的数值必须是负数(不包括 0)。
@NegativeOrZero 被注释的数值必须是负数或 0。

3. 字符串检查

注解 功能描述
@Size(min, max) 被注释的字符串、集合、数组或 Map 的大小必须在指定范围内。
@Pattern(regexp) 被注释的字符串必须符合指定的正则表达式。
@Email 被注释的字符串必须是合法的电子邮件地址。

4. 布尔检查

注解 功能描述
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false

5. 日期 / 时间检查

注解 功能描述
@Future 被注释的日期 / 时间必须是将来的时间(如 java.util.DateLocalDate 等)。
@FutureOrPresent 被注释的日期 / 时间必须是现在或将来的时间。
@Past 被注释的日期 / 时间必须是过去的时间。
@PastOrPresent 被注释的日期 / 时间必须是过去或现在的时间。

6. 其他常用注解

注解 功能描述
@Valid 递归验证对象的所有字段(用于嵌套校验,如集合中的对象或对象的属性)。
@CreditCardNumber 被注释的字符串必须通过 Luhn 算法校验(信用卡号格式)。
@URL 被注释的字符串必须是合法的 URL。
@Length(min, max) 被注释的字符串长度必须在指定范围内(等效于 @Size,但仅用于字符串)。
@Range(min, max) 被注释的数值必须在指定范围内(适用于数字类型)。

Jakarta Bean Validation 3.0(JSR 380)新增注解

注解 功能描述
@NotEmpty 替代 JSR-303 中的 @NotNull@Size(min=1) 的组合(Jakarta EE 9+)。
@NotBlank 校验字符串非空且至少有一个非空白字符(Jakarta EE 9+)。
@Positive/@PositiveOrZero 校验正数或非负数(Jakarta EE 9+)。
@Negative/@NegativeOrZero 校验负数或非正数(Jakarta EE 9+)。

将需要用到的注解加入到对应字段即可。

相关推荐
新法国菜39 分钟前
MySql知识梳理之DML语句
数据库·mysql
老华带你飞1 小时前
校园交友|基于SprinBoot+vue的校园交友网站(源码+数据库+文档)
java·数据库·vue.js·spring boot·论文·毕设·校园交友网站
许泽宇的技术分享1 小时前
Text2API与Text2SQL深度对比:自然语言驱动的数据交互革命
数据库·windows·microsoft
两张不够花4 小时前
Shell脚本源码安装Redis、MySQL、Mongodb、PostgreSQL(无报错版)
linux·数据库·redis·mysql·mongodb·postgresql·云计算
Java 码农4 小时前
nodejs 集成mongodb实现增删改查
数据库·mongodb
少陵野小Tommy5 小时前
Python能用古诗词数据库做什么7:根据标题、诗句查找诗歌
开发语言·数据库·python
花花无缺6 小时前
MySQL--B+树
后端·mysql
khystal6 小时前
HUMS 2023齿轮箱数据分析
数据库·数据分析·信号处理
Warren986 小时前
Spring Boot 整合网易163邮箱发送邮件实现找回密码功能
数据库·vue.js·spring boot·redis·后端·python·spring