Hibernate Validator
摘自：http://www.blogjava.net/faithwind/articles/29574.html
Person.java 类
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 类
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 类
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 属性.
如果你要写自己的约束呢 , 你不用担心 ,这也是很容易的. 任何约束有两部分组成:
[约束描述符 即注释]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类 添加@Serializability Annotations ,把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 不再列出^_^)