Spring 中@NotNull, @NotEmpty和@NotBlank之间的区别是什么?

本文详细解析了JSR303中@NotNull、@NotEmpty和@NotBlank三个注解的区别,阐述了它们在验证对象是否为空、集合是否为空以及字符串是否非空的具体用法。

转载自: https://www.cnblogs.com/Terry-Wu/p/8134732.html

简述三者区别

@NotNull://CharSequence, Collection, Map 和 Array 对象不能是 null, 但可以是空集(size = 0)。  
@NotEmpty://CharSequence, Collection, Map 和 Array 对象不能是 null 并且相关对象的 size 大于 0。  
@NotBlank://String 不是 null 且去除两端空白字符后的长度(trimmed length)大于 0。 

注解的定义(在version 4.1中):

1、@NotNull:

定义如下:

@Constraint(validatedBy = {NotNullValidator.class})

这个类中有一个isValid方法是这么定义的:

public boolean isValid(Object object, ConstraintValidatorContext constraintValidatorContext) {  
 return object != null;    
} 

对象不是null就行,其他的不保证。

2、@NotEmpty:

定义如下:

@NotNull    
@Size(min = 1)  

也就是说,@NotEmpty除了@NotNull之外还需要保证@Size(min=1),这也是一个注解,这里规定最小长度等于1,也就是类似于集合非空。

3、@NotBlank:

@NotNull    
@Constraint(validatedBy = {NotBlankValidator.class})  

类似地,除了@NotNull之外,还有一个类的限定,这个类也有isValid方法:

if ( charSequence == null ) {  //curious   
  return true;     
}     
return charSequence.toString().trim().length() > 0; 

有意思的是,当一个string对象是null时方法返回true,但是当且仅当它的trimmed length等于零时返回false。即使当string是null时该方法返回true,但是由于@NotBlank还包含了@NotNull,所以@NotBlank要求string不为null。

示例:

String name = null;
@NotNull: false
@NotEmpty: false
@NotBlank: false

String name = "";
@NotNull: true
@NotEmpty: false
@NotBlank: false

String name = " ";
@NotNull: true
@NotEmpty: true
@NotBlank: false

String name = "Great answer!";
@NotNull: true
@NotEmpty: true
@NotBlank: true

彩蛋

一、常用的校验注解
(1)常用标签
@Null  被注释的元素必须为null
@NotNull  被注释的元素不能为null
@AssertTrue  被注释的元素必须为true
@AssertFalse  被注释的元素必须为false
@Min(value)  被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value)  被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value)  被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value)  被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Size(max,min)  被注释的元素的大小必须在指定的范围内。
@Digits(integer,fraction)  被注释的元素必须是一个数字,其值必须在可接受的范围内
@Past  被注释的元素必须是一个过去的日期
@Future  被注释的元素必须是一个将来的日期
@Pattern(value) 被注释的元素必须符合指定的正则表达式。
@Email 被注释的元素必须是电子邮件地址
@Length 被注释的字符串的大小必须在指定的范围内
@NotEmpty  被注释的字符串必须非空
@Range  被注释的元素必须在合适的范围内
### @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`。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值