Hibernate Validation使用示例及講解

時間 2019-11-07

標籤 hibernate validation 使用示例講解欄目 Hibernate 简体版

原文原文鏈接

在項目開發過程當中，後臺在不少場景都須要進行校驗操做，好比：前臺表單提交到後臺，系統接口調用，數據傳輸等等。並且不少項目都採用MVC分層式設計，每層還有須要進行相應地校驗，這樣在項目較大，多人協做開發的時候，會形成大量重複校驗代碼，且出錯率高。javascript

針對這個問題，JCP出臺一個JSR 303-Bean Validation規範，而Hibernate Validator 做爲Bean Validation的參考實現，提供了JSR 303規範中全部內置constraint的實現，除此以外還有一些附加的constraint。html

Hibernate Validation的使用很是簡單，只用在相應的實體類中加上註解，再調用對應的校驗API方法便可。java

Hibernate Validation目前最新的穩定版本是：5.1.3。下載地址git

具體使用方法請查看上面的官方使用手冊地址，每一個註解對應的含義在官方手冊2.4章節有詳細介紹，內容太多我就不貼過來了。下面直接上最經常使用狀況（實體類校驗）的示例代碼。web

1、依賴包api

J2SE環境下除了須要引入Hibernate Validation包外，還須要額外引入兩個實現表達式語言的包。J2EE環境若是容器提供不須要再引入。下面是J2SE環境下的依賴包：app

Xml代碼框架

2、校驗工具類ide

工具類提供了校驗實體類、實體字段的方法，返回一個自定義的校驗對象。

Java代碼

/**
* 校驗工具類
* @author wdmcygah
*
*/
public class ValidationUtils {
private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
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;
}
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;
}
}

3、校驗返回對象

Java代碼

4、被校驗實體

Java代碼

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;
//get set方法省略，本身添加
}

有些狀況下，Hibernate Validation自帶的註解不可以知足需求，咱們想定製一個註解進行使用，此時能夠參考下面的示例（自定義密碼註解及校驗規則）。

1、密碼註解

Java代碼

2、密碼校驗類

Java代碼

/**
* 自定義密碼校驗類
* @author wdmcygah
*
*/
public class PasswordValidator implements ConstraintValidator<Password, String> {
//5~10位的數字與字母組合
private static Pattern pattern = Pattern.compile("(?![0-9]+$)(?![a-zA-Z]+$)[0-9A-Za-z]{5,10}");
public void initialize(Password constraintAnnotation) {
//do nothing
}
public boolean isValid(String value, ConstraintValidatorContext context) {
if( value==null ){
return false;
}
Matcher m = pattern.matcher(value);
return m.matches();
}
}