Hibernate Validation使用示例及讲解

在项目开发过程中，后台在很多场景都需要进行校验操作，比如：前台表单提交到后台，系统接口调用，数据传输等等。而且很多项目都采用MVC分层式设计，每层还有需要进行相应地校验，这样在项目较大，多人协作开发的时候，会造成大量重复校验代码，且出错率高。

针对这个问题，JCP出台一个JSR 303-Bean Validation规范，而Hibernate Validator 作为Bean Validation的参考实现，提供了JSR 303规范中所有内置constraint的实现，除此之外还有一些附加的constraint。

Hibernate Validation的使用非常简单，只用在相应的实体类中加上注解，再调用对应的校验API方法即可。

Hibernate Validation目前最新的稳定版本是：5.1.3。下载地址

官网地址 
官方英文使用手册 
官方中文使用手册地址(中文版目前最新的是4.3版本)

具体使用方法请查看上面的官方使用手册地址，每个注解对应的含义在官方手册2.4章节有详细介绍，内容太多我就不贴过来了。下面直接上最常用情况（实体类校验）的示例代码。

一、依赖包

J2SE环境下除了需要引入Hibernate Validation包外，还需要额外引入两个实现表达式语言的包。J2EE环境如果容器提供不需要再引入。下面是J2SE环境下的依赖包：

Xml代码 

 

1. <dependency>  
2.             <groupId>org.hibernate</groupId>  
3.             <artifactId>hibernate-validator</artifactId>  
4.             <version>5.1.3.Final</version>  
5.         </dependency>  
6.         <dependency>  
7.             <groupId>javax.el</groupId>  
8.             <artifactId>javax.el-api</artifactId>  
9.             <version>2.2.4</version>  
10.         </dependency>  
11.         <dependency>  
12.             <groupId>org.glassfish.web</groupId>  
13.             <artifactId>javax.el</artifactId>  
14.             <version>2.2.4</version>  
15.         </dependency>  

 

二、校验工具类

工具类提供了校验实体类、实体字段的方法，返回一个自定义的校验对象。

Java代码 

 

1. /** 
2.  * 校验工具类 
3.  * @author wdmcygah 
4.  * 
5.  */  
6. public class ValidationUtils {  
7.   
8.     private static Validator validator =  Validation.buildDefaultValidatorFactory().getValidator();  
9.       
10.     public static <T> ValidationResult validateEntity(T obj){  
11.         ValidationResult result = new ValidationResult();  
12.          Set<ConstraintViolation<T>> set = validator.validate(obj,Default.class);  
13.          if( CollectionUtils.isNotEmpty(set) ){  
14.              result.setHasErrors(true);  
15.              Map<String,String> errorMsg = new HashMap<String,String>();  
16.              for(ConstraintViolation<T> cv : set){  
17.                  errorMsg.put(cv.getPropertyPath().toString(), cv.getMessage());  
18.              }  
19.              result.setErrorMsg(errorMsg);  
20.          }  
21.          return result;  
22.     }  
23.       
24.     public static <T> ValidationResult validateProperty(T obj,String propertyName){  
25.         ValidationResult result = new ValidationResult();  
26.          Set<ConstraintViolation<T>> set = validator.validateProperty(obj,propertyName,Default.class);  
27.          if( CollectionUtils.isNotEmpty(set) ){  
28.              result.setHasErrors(true);  
29.              Map<String,String> errorMsg = new HashMap<String,String>();  
30.              for(ConstraintViolation<T> cv : set){  
31.                  errorMsg.put(propertyName, cv.getMessage());  
32.              }  
33.              result.setErrorMsg(errorMsg);  
34.          }  
35.          return result;  
36.     }  
37. }  

 

三、校验返回对象

Java代码 

 

1. <span style="line-height: 22.3999996185303px;">/** 
2.  * 校验结果 
3.  * @author wdmcygah 
4.  * 
5.  */  
6. public class ValidationResult {  
7.   
8.     //校验结果是否有错  
9.     private boolean hasErrors;  
10.       
11.     //校验错误信息  
12.     private Map<String,String> errorMsg;  
13.   
14.     public boolean isHasErrors() {  
15.         return hasErrors;  
16.     }  
17.   
18.     public void setHasErrors(boolean hasErrors) {  
19.         this.hasErrors = hasErrors;  
20.     }  
21.   
22.     public Map<String, String> getErrorMsg() {  
23.         return errorMsg;  
24.     }  
25.   
26.     public void setErrorMsg(Map<String, String> errorMsg) {  
27.         this.errorMsg = errorMsg;  
28.     }  
29.   
30.     @Override  
31.     public String toString() {  
32.         return "ValidationResult [hasErrors=" + hasErrors + ", errorMsg="  
33.                 + errorMsg + "]";  
34.     }  
35.   
36. }</span>  

四、被校验实体

Java代码 

 

1. public class SimpleEntity {  
2.   
3.     @NotBlank(message="名字不能为空或者空串")  
4.     @Length(min=2,max=10,message="名字必须由2~10个字组成")  
5.     private String name;  
6.       
7.     @Past(message="时间不能晚于当前时间")  
8.     private Date date;  
9.       
10.     @Email(message="邮箱格式不正确")  
11.     private String email;  
12.       
13.     @Pattern(regexp="(?![0-9]+$)(?![a-zA-Z]+$)[0-9A-Za-z]{5,10}",message="密码必须是5~10位数字和字母的组合")  
14.     private String password;  
15.       
16.     @AssertTrue(message="字段必须为真")  
17.     private boolean valid;  
18.     
19.        //get set方法省略，自己添加  
20. }  

 

有些情况下，Hibernate Validation自带的注解不能够满足需求，我们想定制一个注解进行使用，此时可以参考下面的示例（自定义密码注解及校验规则）。

一、密码注解

Java代码 

 

1. package research.hibernate.validation.extend;  
2.   
3. import static java.lang.annotation.ElementType.ANNOTATION_TYPE;  
4. import static java.lang.annotation.ElementType.FIELD;  
5. import static java.lang.annotation.ElementType.METHOD;  
6. import static java.lang.annotation.RetentionPolicy.RUNTIME;  
7.   
8. import java.lang.annotation.Documented;  
9. import java.lang.annotation.Retention;  
10. import java.lang.annotation.Target;  
11.   
12. import javax.validation.Constraint;  
13. import javax.validation.Payload;  
14.   
15. @Target( { METHOD, FIELD, ANNOTATION_TYPE })  
16. @Retention(RUNTIME)  
17. @Constraint(validatedBy = PasswordValidator.class)  
18. @Documented  
19. public @interface Password {  
20.   
21.     String message() default "{密码必须是5~10位数字和字母组合}";  
22.   
23.     Class<?>[] groups() default {};  
24.   
25.     Class<? extends Payload>[] payload() default {};  
26. }  

 

二、密码校验类

Java代码 

 

1. /** 
2.  * 自定义密码校验类 
3.  * @author wdmcygah 
4.  * 
5.  */  
6. public class PasswordValidator implements ConstraintValidator<Password, String> {  
7.   
8.     //5~10位的数字与字母组合  
9.     private static Pattern pattern = Pattern.compile("(?![0-9]+$)(?![a-zA-Z]+$)[0-9A-Za-z]{5,10}");  
10.       
11.     public void initialize(Password constraintAnnotation) {  
12.         //do nothing  
13.     }  
14.   
15.     public boolean isValid(String value, ConstraintValidatorContext context) {  
16.         if( value==null ){  
17.             return false;  
18.         }  
19.         Matcher m = pattern.matcher(value);  
20.         return m.matches();  
21.     }     
22. }  

 

三、被校验实体

Java代码 

 

1. public class ExtendEntity {  
2.   
3.     @Password  
4.     private String password;  
5.       
6.     public String getPassword() {  
7.         return password;  
8.     }  
9.   
10.     public void setPassword(String password) {  
11.         this.password = password;  
12.     }  
13.   
14. }  

 

对应的测试类如下：

Java代码 

 

1. public class ValidationUtilsTest extends TestCase{  
2.   
3.   public void validateSimpleEntity() {  
4.       SimpleEntity se = new SimpleEntity();  
5.       se.setDate(new Date());  
6.       se.setEmail("123");  
7.       se.setName("123");  
8.       se.setPassword("123");  
9.       se.setValid(false);  
10.       ValidationResult result = ValidationUtils.validateEntity(se);  
11.       System.out.println("--------------------------");  
12.       System.out.println(result);  
13.       Assert.assertTrue(result.isHasErrors());  
14.   }  
15.     
16.   public void validateSimpleProperty() {  
17.       SimpleEntity se = new SimpleEntity();  
18.       ValidationResult result = ValidationUtils.validateProperty(se,"name");  
19.       System.out.println("--------------------------");  
20.       System.out.println(result);  
21.       Assert.assertTrue(result.isHasErrors());  
22.   }  
23.     
24.   public void validateExtendEntity() {  
25.       ExtendEntity ee = new ExtendEntity();  
26.       ee.setPassword("212");  
27.       ValidationResult result = ValidationUtils.validateEntity(ee);  
28.       System.out.println("--------------------------");  
29.       System.out.println(result);  
30.       Assert.assertTrue(result.isHasErrors());  
31.   }  
32. }  

 

代码在JDK1.8下测试通过。完整代码可查看我的Github仓库：https://github.com/wdmcygah/research-J2SE

 

备注：
（1）上述示例只是展示了Hibernate Validation比较常用的示例，框架其实还支持方法返回值、方法参数校验，另外也可以通过XML进行配置，校验还可以分组、合并等等。这些内容请查阅官方使用手册。
（2）另外还有一个也还不错的校验框架：OVAL。OVAL源码地址

来源：oschina

链接：https://my.oschina.net/u/2246951/blog/809523