HibernateValidator第5篇校验Bean的约束
Validator接口在Bean Validation中是很重要的一个对象。这篇文章将展示如何获得一个Validator实例,之后将介绍如何使用Validator接口中很多不同的方法。
一、获得一个Validator实例
要想验证一个对象,首先要获得一个Validator实例。通过Validation类和ValidatorFactory可以获得。最简单的方法是使用Validation#buildDefaultValidatorFactory():
ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); validator = factory.getValidator();
在默认的配置中,得到一个Validator实例。后续系列的文章会讲到,如何根据指定的配置,获得不同的实例的方法。
二、校验方法
Validator接口包含三个方法,可以用来校验实体或者是实体的属性等。这三个方法都返回一个集合:Set<constraintviolation>。如果校验正常,则这个集合就是空的,否则,一个ConstraintViolation实例,就会被加入到这个集合中。</constraintviolation>
所有的校验变量都有一个“变量-值”的参数,用来指定,当执行校验的时候,哪个组会被使用。如果这个参数不指定的话,就会执行默认的校验组(javax.validation.groups.Default)。
2.1 Validator#validate()
使用Validate()方法来校验bean中的所有的约束。之前的文章中有讲到使用此方法校验Car实例的例子。当校验到错误的时候,这个校验方法返回一个ConstraintViolation对象。
Car car = new Car(null, true); Set<ConstraintViolation<Car>> constraintViolations = validator.validate(car); assertEquals(1, constraintViolations.size()); assertEquals("must not be null", constraintViolations.iterator().next().getMessage());
2.2 Validator#validateProperty()
使用此方法,你可以只校验一个指定对象的指定的属性。这个属性的名字是JavaBeans的属性名字。
Car car = new Car(null, true); Set<ConstraintViolation<Car>> constraintViolations = validator.validateProperty( car, "manufacturer" ); assertEquals(1, constraintViolations.size()); assertEquals("must not be null", constraintViolations.iterator().next().getMessage());
2.3 Validate#validateValue()
使用此方法,你可以检查给定一个类的一个属性,如果这个属性有一个指定的值的话,是否可以被成功校验。
Set<ConstraintViolation<Car>> constraintViolations = validator.validateValue( Car.class, "manufacturer", null ); assertEquals(1, constraintViolations.size()); assertEquals("must not be null", constraintViolations.iterator().next().getMessage());
三、ConstraintViolation
此类中有很多有用的方法,可以获得校验失败的很多有用的信息。下面就简要介绍下,都可以获得哪些信息。
- getMessage():内部的错误信息。
- 例如:不能为空;
- getMessageTemplate() :非内部的错误信息。
- 例如:{非空的错误提示信息...};
- getRootBean() :被校验的根对象:
- 例如:car;
- getRootBeanClass() :被校验的根兑现的类。
- 例如:Car.class;
- getLeafBean() :得到被应用约束的Bean。
- 例如:car;
- getPropertyPath() :得到来自根对象的被校验的属性的路径。
- 例如:包含一个属性节点,且名字为“manufacturer“;
- getInvalidValue() :得到通过这个约束失败的值。
- 例如:null;
- getConstraintDescriptor() :得到校验失败的约束元数据。
- 例如:关于@NotNull的描述。
判断触发了这个约束的元素,可以利用getPropertyPath()方法,利用属性路径。这个方法返回的路径(Path)是一系列节点(Node)的组合,描述元素的路径。