@NotBlank 注解用于约束字段的值不能为空,该注解可用于字符串类型。注解源码如下:
@Documented
@Constraint(validatedBy = { })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@ReportAsSingleViolation
@NotNull
public @interface NotBlank {
String message() default "{org.hibernate.validator.constraints.NotBlank.message}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
// 在同一元素上定义多个 @NotBlank 注释
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
public @interface List {
NotBlank[] value();
}
}注意:message、groups、payload 属性用法参考 @NotNull 注解,并且下面示例使用的 hibernate 中的 @NotNull 注解,而不是 javax.validation 中的 @NotNull 注解。
示例:
package com.hxstrive.validation;
import lombok.Builder;
import lombok.Data;
import org.hibernate.validator.HibernateValidator;
import org.hibernate.validator.constraints.NotBlank;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;
/**
* 注解元素为字符串,并且被 trim() 以后 length 要大于 0
* @author HuangXin
* @since 1.0.0 2024/1/10 9:13
*/
@Data
@Builder
public class NotBlankDemo {
@NotBlank(message = "名称不能为空")
private String name;
public static void main(String[] args) {
NotBlankDemo.builder().name("Tom").build().validator("case1"); // OK
NotBlankDemo.builder().name("").build().validator("case2"); // Fail
NotBlankDemo.builder().name(" ").build().validator("case3"); // Fail
NotBlankDemo.builder().name(null).build().validator("case4"); // Fail
}
private void validator(String caseName) {
validator(caseName, this);
}
private <T> void validator(String caseName, T obj) {
// 手动调用 API 对定义了注解的字段进行校验
Validator validator = Validation.byProvider(HibernateValidator.class).configure()
.failFast(true).buildValidatorFactory().getValidator();
Set<ConstraintViolation<T>> set = validator.validate(obj);
if (set.size() > 0) {
// 校验失败
System.out.println(caseName + " :: Fail :: " + set.iterator().next().getMessage());
} else {
// 校验通过
System.out.println(caseName + " :: Succeed");
}
}
}运行示例,输出如下:
case1 :: Succeed case2 :: Fail :: 名称不能为空 case3 :: Fail :: 名称不能为空 case4 :: Fail :: 名称不能为空