Hibernate Validator校验框架
简介
Hibernate Validator是一个校验框架,用来校验实体类是否满足需求。在实际的开发过程中,经常会遇到需要校验字段的情况,在controller层,service层都可能有,最常用的就是接口调用时的必输字段校验,如果全部自行编写,会导致代码冗余而且很不优雅,字段很多时,写起来十分繁琐又没有技术含量,所以可以站在巨人的肩膀上,使用已有的成熟框架。
导入maven依赖
ps: 如果是 spring boot 的项目不用导入这些依赖。
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>${hibernate.validator.version}</version>
</dependency>
<dependency>
<groupId>javax.el</groupId>
<artifactId>javax.el-api</artifactId>
<version>${elapi.version}</version>
</dependency>
<dependency>
<groupId>org.glassfish.web</groupId>
<artifactId>javax.el</artifactId>
<version>${el.version}</version>
</dependency>
简单使用
(一)实体类添加注解
import lombok.Data;
import org.hibernate.validator.constraints.Email;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotBlank;
import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import java.util.Date;
/**
* @author : Aslan
* @version : v1.0
* @time : 2018-09-10 14:27
* @desc : 被校验的实体类
* 参考:http://wdmcygah.iteye.com/blog/2174680
*/
@Data
public class SimpleEntity {
@NotBlank(message="名字不能为空或者空串")
@Length(min=2,max=10,message="名字必须由2~10个字组成")
private String name;
@Past(message="时间不能晚于当前时间")
private Date date;
@Email(message="邮箱格式不正确")
private String email;
@Pattern(regexp="(?![0-9]+$)(?![a-zA-Z]+$)[0-9A-Za-z]{5,10}",message="密码必须是5~10位数字和字母的组合")
private String password;
@AssertTrue(message="字段必须为真")
private boolean valid;
}
(二) 编写自定义返回对象
/**
* @author : Aslan
* @version : v1.0
* @time : 2018-09-10 14:29
* @desc : 封装校验返回的对象
*/
@Data
public class ValidationResult {
private boolean hasErrors;
private Map<String,String> errorMsg;
public boolean isHasErrors() {
return hasErrors;
}
}
(三)编写Util类,封装处理方法
import org.apache.commons.collections.CollectionUtils;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.groups.Default;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
/**
* @author : Aslan
* @version : v1.0
* @time : 2018-09-10 14:32
* @desc : 校验的工具类,传入任意类型实体类,返回自定义的校验对象
*/
public class ValidationUtils {
private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
/**
* 校验实体类
* @param obj
* @param <T>
* @return
*/
public static <T> ValidationResult validateEntity(T obj){
ValidationResult result = new ValidationResult();
Set<ConstraintViolation<T>> set = validator.validate(obj, Default.class);
if( CollectionUtils.isNotEmpty(set) ){
result.setHasErrors(true);
Map<String,String> errorMsg = new HashMap<String,String>();
for(ConstraintViolation<T> cv : set){
errorMsg.put(cv.getPropertyPath().toString(), cv.getMessage());
}
result.setErrorMsg(errorMsg);
}
return result;
}
/**
* 仅校验具体某个字段
* @param obj
* @param propertyName
* @param <T>
* @return
*/
public static <T> ValidationResult validateProperty(T obj,String propertyName){
ValidationResult result = new ValidationResult();
Set<ConstraintViolation<T>> set = validator.validateProperty(obj,propertyName,Default.class);
if( CollectionUtils.isNotEmpty(set) ){
result.setHasErrors(true);
Map<String,String> errorMsg = new HashMap<String,String>();
for(ConstraintViolation<T> cv : set){
errorMsg.put(propertyName, cv.getMessage());
}
result.setErrorMsg(errorMsg);
}
return result;
}
}
(三)测试使用
/**
* @author : Aslan
* @version : v1.0
* @time : 2018-09-10 14:40
* @desc : 输入描述
*/
public class ValidationUtilsTest {
@Test
public void validateSimpleEntity() {
SimpleEntity se = new SimpleEntity();
se.setDate(new Date());
se.setEmail("123");
se.setName("123");
se.setPassword("123");
se.setValid(false);
ValidationResult result = ValidationUtils.validateEntity(se);
System.out.println(result);
Assert.assertTrue(result.isHasErrors());
}
@Test
public void validateSimpleProperty() {
SimpleEntity se = new SimpleEntity();
ValidationResult result = ValidationUtils.validateProperty(se,"name");
System.out.println(result);
Assert.assertTrue(result.isHasErrors());
}
}
(四)官网资料
中文文档
英文官方文档