在開發JAVA服務器端代碼時,我們會遇到對外部傳來的參數合法性進行驗證,而hibernate-validator提供了一些常用的參數校驗注解,我們可以拿來使用。
1.maven中引入hibernate-validator對應的jar:
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>4.3.1.Final</version>
</dependency>
2.在Model中定義要校驗的字段(即該字段不能為空,並且最大長度為14):**
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import org.hibernate.validator.constraints.NotEmpty;
public class PayRequestDto {
/**
* 支付完成時間
**/
@NotEmpty(message="支付完成時間不能空")
@Size(max=14,message="支付完成時間長度不能超過{max}位")
private String payTime;
/**
* 狀態
**/
@Pattern(regexp = "0[0123]", message = "狀態只能為00或01或02或03")
private String status;
public String getPayTime() {
return payTime;
}
public void setPayTime(String payTime) {
this.payTime = payTime;
}
public String getStatus() {
return status;
}
public void setStatus(String status) {
this.status = status;
}
}
3.定義Validation工具類:
import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import org.hibernate.validator.HibernateValidator;
public class ValidationUtils {
/**
* 使用hibernate的注解來進行驗證
*
*/
private static Validator validator = Validation
.byProvider(HibernateValidator.class).configure().failFast(true).buildValidatorFactory().getValidator();
/**
* 功能描述: <br>
* 〈注解驗證參數〉
*
* @param obj
* @see [相關類/方法](可選)
* @since [產品/模塊版本](可選)
*/
public static <T> void validate(T obj) {
Set<ConstraintViolation<T>> constraintViolations = validator.validate(obj);
// 拋出檢驗異常
if (constraintViolations.size() > 0) {
throw new RuntimeException(String.format("參數校驗失敗:%s", constraintViolations.iterator().next().getMessage()));
}
}
}
4.在代碼中調用工具類進行參數校驗:
ValidationUtils.validate(requestDto);
以下是對hibernate-validator中部分注解進行描述: