使用场景
通常在遇到大量的参数进行校验时使用;
什么是javax.validation
JSR303是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代),就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本。
<!--jsr 303-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>1.1.0.Final</version>
</dependency>
<!-- hibernate validator-->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.0.Final</version>
</dependency>
实体类中添加验证注解
import lombok.Data;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import java.util.List;
/**
* 入库确认
*/
@Data
public class StoreInToConfirmReqVo {
@NotNull(message = "ID不能为空")
private Integer id ;
@NotNull(message = "库位不能为空")
private Integer locationId;
}
需要验证的方法中调用
ValidatorUtil.validate(reqVo);
验证类
import com.dims.mes.tool.exception.BizException;
import org.hibernate.validator.HibernateValidator;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;
public class ValidatorUtil {
/**
* 对定义了注解的字段进行校验
* @param t
* @param <T>
*/
public static<T> void validate(T t) {
Validator validator = Validation.byProvider(HibernateValidator.class).configure()
.failFast(true).buildValidatorFactory().getValidator();
Set<ConstraintViolation<T>> set = validator.validate(t);
if (set.size() > 0) {
throw new BizException(set.iterator().next().getMessage());
}
}
}
注解说明(Hibernate Validator)
校验注解 | 校验的数据类型 | 说明 |
---|---|---|
@NotNull | 任意类型 | 校验注解的元素值不为null |
@Null | 任意类型 | 校验注解的元素值是null |
@NotBlank | CharSequence子类型 | 验证注解的元素值不为空(不为null、去除首位空格后长度不为0),不同与@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的首位空格。 |
@NotEmpty | CharSequence子类型、Collection、Map、数组 | 验证注解的元素值不为null且不为空(字符串长度不为0,集合大小不为0) |
@Valid | 任何非原子类型,级联验证。比如验证User对象的属性Address对象 | 指定递归验证关联的对象如用户对象中有个地址对象属性,如果想在验证用户对象时一起验证地址对象,在地址对象上加@Valid注解即可级联验证。 |
@AssertFalse | Boolean,boolean | 验证注解的元素值是false |
@AssertTrue | Boolean,boolean | 验证注解的元素值是true |
@Min(value=xxx) | BigDecimal,BigInteger,byte,short,int,long,等任何Number或CharSequence(存储的是数字)子类型,, | 验证注解的元素值大于等于@Min指定的value值 |
@Max(value=xxx) | 和@Min要求一样 | 验证注解的元素值小于等于@Max指定的value值 |
@DecimalMax(value=xxx) | 和@Min要求一样 | 验证注解的元素值小于等于@DecimalMax指定的value值 |
@DecimalMin(value=xxx) | 和@Min要求一样 | 验证注解的元素值大于等于@DecimalMin指定的value值 |
@Digits(integer=整数位数,fraction=小数位数) | 和@Min要求一样 | 验证注解的元素值的整数位数和小数位数的上限 |
@Size(min=下限,max=上限) | 字符串、Collection、Map、数组等 | 验证注解的元素值在min和max(包含)指定区间之内,如字符长度、集合大小 |
@Past | java.util.Date,java.util.Calendar,Joda Time类库的日期类型 | 验证注解的元素值(日期类型)比当前时间早 |
@Future | 与@Past要求一样 | 验证注解的元素值(日期类型)比当前时间晚 |
@Length(min=下限,max=上限) | CharSequence子类型 | 验证注解的元素值长度在min和max区间内 |
@Range(min=最小值,max=最大值) | BigDecimal,BigInteger,CharSequence,byte,short,int,long等原子类型和包装类型 | 验证注解的元素值在最小值和最大值之间 |
@Email(regexp=正则表达式,flag=标志的模式) | CharSequence子类型(如String) | 验证注解的元素值是Email,也可以通过regexp和flag指定自定义的email格式 |
@Pattern(regexp=正则表达式,flag=标志的模式) | String,任何CharSequence的子类型 | 验证注解的元素值与指定的正则表达式匹配 |
Spring数据校验注解
@Validated | 任何非原子类 | @Valid:没有分组的功能; @Valid:可以用在方法、构造函数、方法参数和成员属性(字段)上; @Validated:提供了一个分组功能,可以在入参验证时,根据不同的分组采用不同的验证机制; @Validated:可以用在类型、方法和方法参数上。但是不能用在成员属性(字段)上; 两者是否能用于成员属性(字段)上直接影响能否提供嵌套验证的功能。 |