Hibernate Validator校验器入门

一、声明和验证Bean约束

1. 声明Bean约束

1.1 字段级约束

package org.hibernate.validator.referenceguide.chapter02.fieldlevel;

public class Car {

@NotNull

private String manufacturer;

@AssertTrue

private boolean isRegistered;

public Car(String manufacturer, boolean isRegistered) {

this.manufacturer = manufacturer;

this.isRegistered = isRegistered;

}

//getters and setters...

}

1.2 属性级约束

package org.hibernate.validator.referenceguide.chapter02.propertylevel;

public class Car {

private String manufacturer;

private boolean isRegistered;

public Car(String manufacturer, boolean isRegistered) {

this.manufacturer = manufacturer;

this.isRegistered = isRegistered;

}

@NotNull(message = "制造商不能为空")

public String getManufacturer() {

return manufacturer;

}

public void setManufacturer(String manufacturer) {

this.manufacturer = manufacturer;

}

@AssertTrue

public boolean isRegistered() {

return isRegistered;

}

public void setRegistered(boolean isRegistered) {

this.isRegistered = isRegistered;

}

1.3 类及约束

package org.hibernate.validator.referenceguide.chapter02.classlevel;

@ValidPassengerCount

public class Car {

private int seatCount;

private List<Person> passengers;

//...

}

1.4 约束继承

当一个类实现一个接口或扩展另一个类时，所有在超类型上声明的约束注释都

将应用到扩展类上

如果方法被覆盖，约束注释将被聚合（叠加）

1.5 对象图

Bean验证API不仅允许验证单个类实例，还允许验证完整的对象图(级联验证)。为此，只需用@Valid注释表示对另一个对象引用的字段或属性，如级联验证中所示

package org.hibernate.validator.referenceguide.chapter02.objectgraph;

public class Car {

@NotNull

@Valid

private Person driver;

//...

}

package org.hibernate.validator.referenceguide.chapter02.objectgraph;

public class Person {

@NotNull

private String name;

//...

}

如果验证了Car的一个实例，那么引用的Person对象也将被验证，因为驱动程

序字段被标注为@Valid。因此，如果引用的Person实例的name字段为null，则Car

的验证将失败

对象图的验证是递归的，也就是说，如果为级联验证标记的引用指向本身具有

@Valid注释的属性的对象，那么验证引擎也将跟踪这些引用。验证引擎将确保级联

验证期间不会出现无限循环，例如，如果两个对象彼此持有引用

对象图验证也适用于集合类型的字段

arrays

implement java.lang.Iterable (especially Collection, List and Set)

implement java.util.Map

可使用@Valid进行注释，这将导致在验证父对象时对每个包含的元素进行验证

2. 验证Bean约束

2.1 获取验证器实例

验证实体实例的第一步是获取验证器实例。通过Validation类和ValidatorFactory。

最简单的方法是使用静态方法Validation#buildDefaultValidatorFactory(),eg:

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();

Validator validator = factory.getValidator();

2.2 验证器方法(Validator方法)

Validator接口包含三个方法，可用于验证整个实体或实体的单个属性

这三个方法都返回一个Set< ConstraintViolation>。如果验证成功，则该集合为

空。否则，将为每个被违反的约束添加一个ConstraintViolation实例

所有验证方法都有一个var-args参数，可用于指定执行验证时应考虑哪些验证组。

如果没有指定该参数，则使用默认验证组(javax.validation.groups.Default)

Validator#validate()：检验Bean

//获取验证器实例

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();

final Validator validator = factory.getValidator();

Car car = new Car( null, true );//Car类参见1.2 属性级约束

Set<ConstraintViolation<Car>> constraintViolations =

validator.validate( car );

System.out.println(constraintViolations.size());//1

//制造商不能为空

System.out.println(constraintViolations.iterator().next().getMessage());

Validator#validateProperty()

在validateProperty()的帮助下，您可以验证给定对象的单个命名属性。属

性名是javabean属性名

final Validator validator = getValidator();

Car car = new Car( null, true );

Set<ConstraintViolation<Car>> constraintViolations =

validator.validateProperty(

car,

"manufacturer"

);

System.out.println(constraintViolations.size());//1

//制造商不能为空

System.out.println(constraintViolations.iterator().next().getMessage());

Validator#validateValue()

通过使用validateValue()方法，您可以检查给定类的单个属性是否可以成

功验证(如果该属性具有指定的值)

final Validator validator = getValidator();

Set<ConstraintViolation<Car>> constraintViolations =

validator.validateValue(

Car.class,

"manufacturer",

null

);

System.out.println(constraintViolations.size());//1

//制造商不能为空

System.out.println(constraintViolations.iterator().next().getMessage());

2.3 约束违反方法（ConstraintViolation methods）

getMessage()：获取内置的错误信息
getMessageTemplate()：获取非内置的错误信息
getRootBean()：获取正在接受验证的对象
getRootBeanClass()：获取正在接受验证的对象的类
getLeafBean()：如果一个类级约束，则返回该约束应用于bean实例;如果是属

性级约束，则返回承载该约束的属性的bean实例

getPropertyPath()：获取验证失败的属性名称
getInvalidValue()：获取未通过验证的属性值
getConstraintDescriptor()：获取约束元数据描述符

2.4 内置约束

Bean验证约束都适用于字段/属性级别，Bean验证规范中没有定义类级别约束

@AssertFalse：验证被注解元素是false
@AssertTrue：验证被注解元素是true
@DecimalMax(value=, inclusive=)：验证小于或等于（取决于inclusive）

value，支持BigDecimal, BigInteger, CharSequence, byte, short, int, long以

及它们的包装类

@DecimalMin(value=, inclusive=)
@Digits(integer=, fraction=)：验证被注解元素具有最多的整数位数和小数位数
@Future：Checks whether the annotated date is in the future
@Past
@Max(value=)：验证被注解元素是否小于或等于value
@Min(value=)
@NotNull：Checks that the annotated value is not null，Supported data

types：Any type

@Null
@Pattern(regex=, flags=)：检查带注释的字符串是否与正则表达式匹配(考虑

给定的标志匹配)

@Size(min=, max=)：检查带注释的元素的大小是否在min和max之间(包括)，

支持类型：CharSequence, Collection, Map and arrays

@Valid：递归地对关联对象执行验证。如果对象是集合或数组，则递归地验证

元素。如果对象是Map，则递归地验证值元素

2.5 附加约束

@Email
@Length(min=, max=)：验证字符序列在min和max之间（含）
@NotBlank：验证字符串是否为“ ”或null或""
@NotEmpty：验证CharSequence, Collection, Map and arrays是否为null或empty
@Range(min=, max=)：Checks whether the annotated value lies between (inclusive) the specified minimum and maximum；Supported data types：

BigDecimal, BigInteger, CharSequence, byte, short, int, long and the respective

wrappers of the primitive types

@ScriptAssert(lang=, script=, alias=, reportOn=)：检查给定脚本是否可以根据带注释的元素成功计算。为了使用这个约束，JSR 223定义的Java脚本API的实现(“针对JavaTM平台的脚本”)必须是类路径的一部分。要计算的表达式可以用任何脚本或表达式语言编写，在类路径中可以找到JSR 223兼容的引擎。即使这是一个类级约束，也可以使用reportOn属性报告对特定属性而不是整个对象的约束违反

@ScriptAssert.List({