Spring中@NotNull、@NotEmpty、@NotBlank和@PositiveOrZero等注解的使用

本文介绍了在Web项目中常用的前端参数校验注解,包括@NotNull、@NotEmpty、@NotBlank和@PositiveOrZero,详细解释了它们的功能及适用场景,帮助开发者确保参数的有效性和安全性。

我们在做web项目的时候经常会遇到前端传参的情况,这会需要对参数做校验,比如参数不能为空,集合不能为空等校验,javax.validation.constraints为我们提供了很多注解来帮忙我们做参数校验。

1、 @NotNull

The annotated element must not be {@code null}.

校验参数一定不能为null,但是可以为" "。

2、 @NotEmpty

The annotated element must not be {@code null} nor empty. Supported types are:
1、{@code CharSequence} (length of character sequence is evaluated);
2、{@code Collection} (collection size is evaluated);
3、{@code Map} (map size is evaluated);
4、Array (array length is evaluated);

校验集合类参数(如String类、Collection、Map、数据Array)不能为null或empty。其中String的length、Collection和Map的size不能为0。

3、@NotBlank

The annotated element must not be {@code null} and must contain at least one non-whitespace character. Accepts {@code CharSequence}.

校验String字符串不能为null,且不能是空字符串(" "),即调用trim()之后字符串的长度不能为0。

4、@PositiveOrZero

The annotated element must be a positive number or 0.

校验参数必须是正整数或0。

更多链接

### @NotEmpty@NotBlank@NotNull、@Valid 与 @Validated 的区别使用场景 #### **@NotNull** - 用于验证对象是否为 null。 - 适用于任何类型(包括字符串、数字、集合等)。 - 不会检查空字符串或空集合,仅验证是否为 null。 - 示例: ```java @NotNull(message = "Name cannot be null") private String name; ``` [^1] #### **@NotEmpty** - 用于验证字符串、集合、数组等是否为空。 - 对字符串而言,验证长度是否大于0。 - 对集合或数组而言,验证元素数量是否大于0。 - 不允许 null 值(null 会被认为是无效)。 - 示例: ```java @NotEmpty(message = "List cannot be empty") private List<String> items; ``` [^1] #### **@NotBlank** - 专门用于验证字符串是否为空白。 - 检查字符串是否包含非空白字符(即去除前后空格后是否为空)。 - 只适用于字符串类型。 - 示例: ```java @NotBlank(message = "Username cannot be blank") private String username; ``` #### **@Valid** - 是 JSR-303 标准规范的一部分,由 `javax` 提供。 - 用于在方法参数上进行参数校验。 - 支持嵌套验证,但不支持分组验证。 - 示例: ```java @PostMapping("/users") public ResponseEntity<?> createUser(@Valid @RequestBody User user, BindingResult result) { if (result.hasErrors()) { // handle errors } // save user } ``` #### **@Validated** - 是 Spring 提供的验证注解,对 `@Valid` 进行了二次封装。 - 支持分组验证,适用于复杂的验证逻辑。 - 可以标注在类级别上,也可以用于方法级别。 - 示例: ```java @Validated @RestController public class UserController { @PutMapping("/student") public ApiResult updateStudent(@RequestBody @Validated({Student.Update.class}) Student student, BindingResult result) { if (result.hasErrors()) { for (ObjectError error : result.getAllErrors()) { // do stuff } return ApiResult.error(); } studentService.update(student); return ApiResult.success(); } } ``` [^4] #### **分组验证的使用场景** - 分组验证用于在不同业务场景下应用不同的验证规则。 - 使用 `@Validated` 注解并传入分组接口,可以实现对特定场景的验证逻辑。 - 示例: ```java public interface IGroupA {} public interface IGroupB {} @PutMapping("/student") public ApiResult updateStudent(@RequestBody @Validated({IGroupA.class}) Student student, BindingResult result) { // 验证逻辑 } ``` [^5] #### **总结** - `@NotNull`、`@NotEmpty` `@NotBlank` 用于基本的字段非空验证,分别适用于不同的数据类型场景。 - `@Valid` 是标准的 JSR-303 验证注解,适用于简单的参数验证,不支持分组。 - `@Validated` 是 Spring 提供的增强版验证注解,支持分组验证类级别的验证。 - 在需要分组验证或复杂的业务场景时,推荐使用 `@Validated`。 ---
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值