@NotNull、@NotEmpty和@NotBlank的区别

飞熊 • 2023年5月29日下午6:19 • 技术随笔 • 阅读 283

√先写结论：

关于注解位置：

@NotNull 常用在基本类型上
@NotEmpty 常用在集合类上面
@NotBlank 常用在String上面

关于三者的不同：

@NotNull 即不能是null，可以是空（size = 0)
@NotEmpty 既不能是null，也不能size = 0（size > 0)
@NotBlank 不能是null，且去除两端空白字符后size > 0（trimmed size > 0）

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 = "code-9527";
@NotNull: true
@NotEmpty: true
@NotBlank: true

注意：String name = " ";，只有@NotBlank的时候才false，所以它常和String搭配

1、@NotNull

/**
* The annotated element must not be {@code null}.
* Accepts any type.
*/

不能为 null，但可以为 empty，一般用在 Integer 类型的基本数据类型的非空校验上，而且被其标注的字段可以使用 @size、@Max、@Min 对字段数值进行大小的控制

BigDecimal 的字段使用字段校验标签应该为 @NotNull

2、@NotEmpty

/**
* Asserts that the annotated string, collection, 
* map or array is not {@code null} or empty.
*/

不能为 null，且长度必须大于 0，一般用在集合类上或者数组上

3、@NotBlank

/**
* Validate that the annotated string is not {@code null} or empty.
* The difference to {@code NotEmpty} is that trailing whitespaces are getting ignored.
*/

只能作用在接收的 String 类型上，注意是只能，不能为 null，而且调用 trim() 后，长度必须大于 0即：必须有实际字符。其实blank（空白、空格）这一词已经说明了

4、注意点

要校验的是从前端接收到的值是否合规，因此是在dto对象的属性中加校验
别忘了在controller层的方法形参前加@Validated注解，告诉它开启校验
校验出错时Spring会抛出MethodArgumentNotValidException…或其他异常（具体看文末链接），在全局控制器类中进行捕捉拦截处理

@ResponseBody
@ExceptionHandler(MethodArgumentNotValidException.class)
public Object methodArgumentNotValidException(MethodArgumentNotValidException e) {
	...
	/进行异常的包装和抛出
	log.error("【传参异常】{}",e.getMessage());
	return xxException;
}