框架HibernateValidator简介

用Annotations 给类或者类的属性加上约束(constraint),在运行期检查属性值是很优雅的.Hibernate Validator就是这样的一个框架.该框架是十分容易的(就像参考文档中宣称的那样),几乎没有什么学习曲线,Validator 是一个验证框架不需要和Hibernate的其他部分绑定就可以使用,只要在你的项目中添加Hibernate-annotations.jar库就可以了.那么下面就让我们看看怎么使用吧.

Person.java 类

* Created on 2006-1-12 Person.java

* @author

package test.annotation.validator;

import org.hibernate.validator.Length;

import org.hibernate.validator.Min;

import org.hibernate.validator.Valid;

//@Serializability//测试自定义约束

public class Person {

private String name;

private int age;

private Address address;

public Person() {}

@Valid //注意此处

public Address getAddress() {

return address;

}

public void setAddress(Address address) {

this.address = address;

}

@Min(value = 1)

public int getAge() {

return age;

}

public void setAge(int age) {

this.age = age;

}

@Length(min = 4)

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

Address.java 类

* Created on 2006-1-12 Address.java

* @author

package test.annotation.validator;

import org.hibernate.validator.Length;

import org.hibernate.validator.Max;

import org.hibernate.validator.Min;

public class Address {

private String street;

private int num;

public Address() {}

@Min(value = 1)

@Max(value = 100)

public int getNum() {

return num;

}

public void setNum(int num) {

this.num = num;

}

@Length(min = 3,max = 8)

public String getStreet() {

return street;

}

public void setStreet(String street) {

this.street = street;

}

上面是两个用 Validator Annotations 注释的类. 每个属性都用约束限制了.下面看看测试的类吧:

TestValidator.java 类

* Created on 2006-1-12

* @author icerain

package test.annotation.validator;

import org.hibernate.validator.ClassValidator;

import org.hibernate.validator.InvalidValue;

public class TestValidator {

public void test() {

Address add = new Address();

add.setNum(0);

add.setStreet("1");

Person p = new Person();

p.setAddress(add);

p.setAge(0);

p.setName("ice");

/******************Test validator ********/

// 注意该处只验证了Person 为了说明 @Valid 注释的使用

ClassValidator<Person> classValidator = new ClassValidator<Person> (Person.class);

InvalidValue[] validMessages = classValidator.getInvalidValues(p);

for (InvalidValue value : validMessages) {

System.out.println("InvalidValue 的长度是:" + validMessages.length

+" . 验证消息是: " + value.getMessage()

+ " . PropertyPath 是:" + value.getPropertyPath()

+" .\n\t PropertyName 是: " +value.getPropertyName()

+ "Value 是: " + value.getValue()

+" Bean 是: "+ value.getBean()

+"\n\t BeanClass 是:" + value.getBeanClass());

}

public static void main(String[] args) {

new TestValidator().test();

}

程序的输出如下

InvalidValue 的长度是:4 . 验证消息是: 必须大于等于 1 . PropertyPath 是:age .

PropertyName 是: age. Value 是: 0 Bean 是: test.annotation.validator.Person@dd87b2

BeanClass 是:class test.annotation.validator.Person

InvalidValue 的长度是:4 . 验证消息是: 长度必须介于 4 与 2147483647 之间 . PropertyPath 是:name .

PropertyName 是: name. Value 是: ice Bean 是: test.annotation.validator.Person@dd87b2

BeanClass 是:class test.annotation.validator.Person

InvalidValue 的长度是:4 . 验证消息是: 必须大于等于 1 . PropertyPath 是:address.num .

PropertyName 是: num. Value 是: 0 Bean 是: test.annotation.validator.Address@197d257

BeanClass 是:class test.annotation.validator.Address

InvalidValue 的长度是:4 . 验证消息是: 长度必须介于 3 与 8 之间 . PropertyPath 是:address.street .

PropertyName 是: street. Value 是: 1 Bean 是: test.annotation.validator.Address@197d257

BeanClass 是:class test.annotation.validator.Address

可以看出不满足约束的值都被指出了.

同时该句: ClassValidator<Person> classValidator = new ClassValidator<Person> (Person.class);

我们只验证了 Person. 在Person里面的Address的属性由于有@Valid Annotations 所以 Address的相关属性也被机联验证了 .

如果把@Valid Annotations 去掉,结果如下:

InvalidValue 的长度是:2 . 验证消息是: 必须大于等于 1 . PropertyPath 是:age .

PropertyName 是: age. Value 是: 0 Bean 是: test.annotation.validator.Person@18fef3d

BeanClass 是:class test.annotation.validator.Person

InvalidValue 的长度是:2 . 验证消息是: 长度必须介于 4 与 2147483647 之间 . PropertyPath 是:name .

PropertyName 是: name. Value 是: ice Bean 是: test.annotation.validator.Person@18fef3d

BeanClass 是:class test.annotation.validator.Person

可以看出没有验证 Address.

当然了 ,你还可以只验证一个属性 , 没有必要验证整个类.只需要在调用classValidator.getInvalidValues(p,"age")方法时加上你要验证的属性就可以了.如我们只想验证age 属性把代码改为如下所示:

InvalidValue[] validMessages = classValidator.getInvalidValues(p,"age"); //只验证age 属性

运行结果如下:

InvalidValue 的长度是:1 . 验证消息是: 必须大于等于 1 . PropertyPath 是:age .

PropertyName 是: age. Value 是: 0 Bean 是: test.annotation.validator.Person@1457cb

BeanClass 是:class test.annotation.validator.Person

只是验证了 age 属性.

怎么样 ,很简单吧. 关于 Hibernate Validator 内建的验证Annotations 大家可以看看 API 或者参考文档(中文版我正在翻译中请访问我的 Blog 获得最新信息).

如果你要写自己的约束呢 , 你不用担心 ,这也是很容易的. 任何约束有两部分组成: [约束描述符即注释]the constraint descriptor (the annotation) 和[约束validator 即实现类] the constraint validator (the implementation class).下面我们扩展Hibernate Test suit 中的一个Test 来讲解一下.

首先: 要声明一个constraint descriptor .如下:

package test.annotation.validator;

import java.lang.annotation.Documented;

import static java.lang.annotation.ElementType.TYPE;

import static java.lang.annotation.ElementType.FIELD;

import static java.lang.annotation.ElementType.METHOD;

import java.lang.annotation.Retention;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Target;

import org.hibernate.validator.ValidatorClass;

/**

* Dummy sample of a bean-level validation annotation

* @author Emmanuel Bernard

@ValidatorClass(SerializabilityValidator.class)

@Target({METHOD,FIELD,TYPE})

@Retention(RUNTIME)

@Documented

public @interface Serializability {

int num() default 11;

String message() default "bean must be serialiable";

}

@ValidatorClass(SerializabilityValidator.class) 指出了 constraint validator 类.

@Target({METHOD,FIELD,TYPE})

@Retention(RUNTIME)

@Documented

这几个我就不用解释了吧.

Serializability 里面声明了一个 message 显示约束的提示信息. num 只是为了说明一个方面在这里面没有实际用途用 .

然后就是实现一个constraint validator 类该类要实现Validator<ConstraintAnnotation>.这里是SerializabilityValidator.java 如下:

//$Id: SerializabilityValidator.java,v 1.3 2005/11/17 18:12:11 epbernard Exp $

package test.annotation.validator;

import java.io.Serializable;

import org.hibernate.validator.Validator;

/**

* Sample of a bean-level validator

* @author Emmanuel Bernard

public class SerializabilityValidator implements Validator<Serializability>, Serializable {

public boolean isValid(Object value) {

//这里只是Validator 里面的实现验证规则的方法. value 是要验证的值.

System.out.println("IN SerializabilityValidator isValid:"+value.getClass()+": " +value.toString());

return value instanceof Serializable;

}

public void initialize(Serializability parameters) {

// 在这里可以取得 constraint descriptor 里面的属性如上面我们声明的 num

System.out.println("IN SerializabilityValidator: parameters:"+ parameters.num() );

}

然后在你的类中应用@Serializability就可以约束一个类实现Serializable 接口了. 如下:

在我们的Person.java类添加@SerializabilityAnnotations ,把Person.java 中的 //@Serializability //测试自定义约束注释去掉就ok了.

运行结果如下:

InvalidValue 的长度是:3 . 验证消息是: bean must be serialiable . PropertyPath 是:null .

PropertyName 是: null. Value 是: test.annotation.validator.Person@1a73d3c Bean 是: test.annotation.validator.Person@1a73d3c

BeanClass 是:class test.annotation.validator.Person

现在把Person类实现 java.io.Serializable 接口则没有出现验证错误消息.

消息的国际化也是很简单的,把Serializability中的message 改为以{}扩住的属性文件的Key就可以了

public @interface Serializability {

int num() default 11;

String message() default "{Serializable}"; //"bean must be serialiable"; //消息的国际化

}

然后编辑资料文件. 注意该资源文件中要包括 Hibernate Validator 内建的资源. 可以在该org\hibernate\validator\resources 包里面的资源文件基础上修改 ,在打包里面这样就可以了. 自己打包可能不太方便.你可以把该包里面的文件复制出来.然后放到你自己的项目包下在自己编辑, 该测试中我是放在 test\resources 包下的.

然后在资源文件中添加 Serializable = '''''' 这么一行, 样例如下:

#DefaultValidatorMessages.properties (DefaultValidatorMessages_zh.properties 不再列出^_^)

#下面是 Hibernate Validator 内建的国际化消息

validator.assertFalse=assertion failed

validator.assertTrue=assertion failed

validator.future=must be a future date

validator.length=length must be between {min} and {max}

validator.max=must be less than or equal to {value}

validator.min=must be greater than or equal to {value}

validator.notNull=may not be null

validator.past=must be a past date

validator.pattern=must match "{regex}"

validator.range=must be between {min} and {max}

validator.size=size must be between {min} and {max}

#下面是自定义的消息

Serializable=Bean not Serializable//加上自己定义的国际化消息.

在构造ClassValidator 时要添上资源文件如下:(在测试类中)

ClassValidator<Person> classValidator = new ClassValidator<Person> (Person.class,ResourceBundle.getBundle("test.resources.DefaultValidatorMessages"));//加载资源

这样就可以了 .当然你还可以更改 Hibernate Validator 的消息(不是在上面的资源文件中直接修改validator.length = ... 等等 ) , 还记得 Validator 注释中有个 message 元素吗? 你以前用的都是默认值,现在你可以该为你自己定义的了.如:validator.length 我把他改为 "该字符串的长度不符合规定范围范围". 在资源文件中添加一行键值属性对(key定义为 "myMsg")如下:

myMsg=该字符串的长度不符合规定范围范围

并且还要在@Length 注释中提供message的引用的key 如下@Length(min = 4,message = "{myMsg}")

再一次运行测试 ,我们就可以看到上面两条自定义绑定的消息了 .如下:

InvalidValue 的长度是:3 . 验证消息是: Bean 不是可 Serializable . PropertyPath 是:null .

PropertyName 是: null. Value 是: test.annotation.validator.Person@1bd4722 Bean 是: test.annotation.validator.Person@1bd4722

BeanClass 是:class test.annotation.validator.Person

InvalidValue 的长度是:3 . 验证消息是: 该字符串的长度不符合规定范围范围 . PropertyPath 是:name .

PropertyName 是: name. Value 是: ice Bean 是: test.annotation.validator.Person@1bd4722

BeanClass 是:class test.annotation.validator.Person

怎么样,比你想象的简单吧.

上面我们讨论了 Hibernate Validator 的主要用法: 但是该框架有什么用呢?

看到这里其实不用我在多说了大家都知道怎么用,什么时候用. 作为一篇介绍性文章我还是在此给出一个最常用的例子吧,更好的使用方式大家慢慢挖掘吧.

比如 : 你现在在开发一个人力资源(HR)系统 (其实是我们ERP课程的一个作业 ^_^), 里面要处理大量的数据,尤其是在输入各种资料时如登记员工信息. 如果你公司的员工的年龄要求是18 -- 60 那么你所输入的年龄就不能超出这个范围. 你可能会说这很容易啊 , 不用Validator就可以解决啊.这保持数据前验证就可以啦如if ( e.getAge() > 60 || e.getAge() < 18 ) ........ 给出错误信息然后提示重新输入不就OK啦用得着兴师动众的来个第三方框架吗?

是啊当就验证这一个属性时, 没有必要啊 ! 但是一个真正的HR 系统,会只有一个属性要验证吗? 恐怕要有N多吧

你要是每一个都那样写一段验证代码是不是很烦啊 ,况且也不方便代码重用. 现在考虑一些 Validator 是不是更高效啊,拦截到约束违例的属性就可以直接得到国际化的消息可以把该消息显示到一个弹出对话框上提示更正!