Use Hibernate Validator4.x(JSR303 )
前言
效验这个概念,想必所有的开发者都知道其作用的重要性,那么笔者今天就要给各位讲解笔者在项目中使用到的一种效验框架。
在开始本文的讲解之前,大家首先来思考一个问题。从数据传输到正常使用之间必然存在一个过程,那便是效验。假设A与B2人,分别负责不同的领域层的数据效验工作,这时便出现了一个问题,不知大家有没有发现,A与B2人都在重复的做一件事情,且采用的是不同的方式。是的,二人之间采用不同的效验逻辑效验同一数据,虽然可以达到预期的目的,但大家仔细想想,如果此数据属于金融性数据?那么效验工作就会涉及到整个领域模型,这时问题就大了,效验逻辑与业务逻辑的高度耦合?是你想看见的嘛?如果不想就请你继续往下看。
在企业级的Java项目开发中,大部分数据都需要传输,JavaBean便是数据传输的通用容器,也就是说JavaBean就是一个DTO(Data Transfer Object ,数据传输对象)。那么我们往往需要对JavaBean进行一些常规的数据效验,由于JavaBean可以作用于领域模型的各层,所带来的效验语义不一致便成为了企业开发的一个难题,并且由于没有规范遵循,一些效验代码甚至会和业务逻辑高度耦合,给项目后期扩展及维护带来极大不便,其伸缩性及复用性也大为降低。
当然解决上述问题最好的办法就是将效验逻辑与JavaBean进行绑定,这便是本篇博文需要讲解的重点,笔者所采用的就是JSR303框架来完成这项艰巨的任务。
使用JSR303将会给你带来如下好处:
1、效验逻辑与业务逻辑之间进行了分离,降低了程序耦合度;
2、统一且规范的效验方式,无需你再次编写重复的效验代码;
3、你将更专注于你的业务,将这些繁琐的事情统统丢在一边,让它们滚出你的世界;
当然同样也会有人提出疑问,如果将效验逻辑与JavaBean进行绑定,岂不是又耦合了?没错,你很聪明,但这种耦合,你觉得重要吗?真的重要吗?
先来看看JSR303在领域模型中处在的角度:
上图已经很清晰明确的标注了JSR303的作用,如果还有不明白的朋友,那么笔者也无能为力。当然JSR303只是一种规范,确切的说它是属于J2EE中的一种子规范,那么实现它的是谁呢?你可以选择Hibernate Validator作为它的实现。
一、下载Hibernate Validator
由于笔者的项目是基于Maven3.x的管理,所以就没有必要单独下载所需构件了。当然如果你的项目并不是使用Maven进行管理,那么你可以从此处下载Hibernate Validator所需的构件:http://www.hibernate.org/subprojects/validator.html,笔者本篇博文选择的Hibernate Validator版本为4.x版本。
想搭建基于JSR303的项目环境,你需要如下4个构件:
当一些都准备好了以后,请大家准备好你的IDE,如下为笔者的项目工程结构图:
pom.xml文件所需构件依赖配置内容如下:
不得不提到一点的是,JSR303是效验方式采用的是基于Annotation。方便吧,是的,确实很方便,那么我们首先来看看JSR303原生的一些效验规则:
@Null 被注释的元素必须为 null ;
@NotNull 被注释的元素必须不为 null ;
@AssertTrue 被注释的元素必须为 true ;
@AssertFalse 被注释的元素必须为 false ;
@Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值;
@Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 ;
@DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值;
@DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值;
@Size(max, min) 被注释的元素的大小必须在指定的范围内 ;
@Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内;
@Past 被注释的元素必须是一个过去的日期;
@Future 被注释的元素必须是一个将来的日期;
@Pattern(value) 被注释的元素必须符合指定的正则表达式;
当然,上述效验规则可能并不能满足我们的项目需求,别急,Hibernate Validator另外拥有一些在此基础之上的附加效验规则:
@Email 被注释的元素必须是电子邮箱地址;
@Length 被注释的字符串的大小必须在指定的范围内;
@NotEmpty 被注释的字符串的必须非空 ;
@Range 被注释的元素必须在合适的范围内;
如果上述这些效验规则还是不能满足你项目的需求,那么你只能去官网看看,或许你会有意想不到的收获。
二、使用Hibernate Validator
在上述章节中,笔者详细的对JSR303做了全方位的介绍。那么接下来咱们就要开始编写第一个Hibernate Validator程序。笔者定义了一个简单的POJO,其中采用如下效验规则:
package com.test.request.bean;
import java.util.Date;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import org.hibernate.validator.constraints.Email;
public class InfoBean
{
@NotNull(message = "姓名不能为空!")
@Min(value = 1, message = "Id只能大于等于1,小于等于10")
@Max(value = 10, message = "Id只能大于等于1,小于等于10")
private Integer id;
@NotNull(message = "姓名不能为空!")
@Size(min = 2, max = 4, message = "姓名长度必须在{min}和{max}之间")
@Pattern(regexp = "[\u4e00-\u9fa5]+", message = "名称只能输入是中文字符")
private String userName;
@NotNull(message = "密码不能为空!")
@Size(min = 6, max = 12, message = "密码长度必须在{min}和{max}之间")
private String passWord;
@NotNull(message = "日期不能为空!")
@Past(message = "你只能输入过去的提起")
private Date birthday;
@NotNull(message = "邮件不能为空!")
@Email(message = "邮件格式不正确")
private String email;
此处省略set和get方法
}
既然POJO也定义好了,我们还需要使用到ValidatorFactory来获取效验工厂实例,并帮助我们完成基础的效验步骤工作:
package com.test.request.bean;
import java.util.Date;
import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import org.junit.Test;
public class InfoBeanTest
{
@Test
public void test() throws Exception
{
/* 创建效验工厂 */
ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
Validator validator = validatorFactory.getValidator();
/* 信息封装 */
InfoBean infoBean = new InfoBean();
infoBean.setId(-1);
infoBean.setUserName("张三");
infoBean.setPassWord("123456");
infoBean.setEmail("test@test.com");
infoBean.setBirthday(new Date());
/* 将类型装载效验 */
Set<ConstraintViolation<InfoBean>> set = validator.validate(infoBean);
for (ConstraintViolation<InfoBean> constraintViolation : set)
System.out.println("错误:" + constraintViolation.getMessage());
}
}
代码也写完了,来吧,跑个JUnit试试:
在上述代码中,咱们故意将Id违反了定义的效验规则,看到JSR303提示的错误信息没?这样便完成了咱们的效验工作,够简单吧。
在本文的最后,笔者仍有义务给大家提到一些在使用过程中需要注意的事项:
1、如果验证的是属性(getter 方法),那么必须遵从 Java Bean 的命名习惯(JavaBeans 规范);
2、静态的字段和方法不能进行约束验证;
3、约束适用于接口和基类;
4、约束注解定义的目标元素可以是字段、属性或者类型等;
5、可以在类或者接口上使用约束验证,它将对该类或实现该接口的实例进行状态验证;
6、字段和属性均可以使用约束验证,但是不能将相同的约束重复声明在字段和相关属性(字段的 getter 方法)上;
当然对于JSR303的应用场景更多的是体现在Spring3.x mvc中,如果你想知道怎么让JSR303与Spring3.x mvc做集成开发,那么就请你关注笔者即将推出的系列博文《SSJ(Spring3.x mvc+Spring Core3.x+JPA2.x)J2EE轻量级解决方案》。