用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类 添加@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 不再列出^_^)

　

#下面是 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 是不是更高效啊,拦截到 约束违例的 属性 就可以直接得到 国际化的消息 可以把该消息显示到一个弹出对话框上 提示更正  !