在開發(fā)JAVA服務(wù)器端代碼時，我們會遇到對外部傳來的參數(shù)合法性進行驗證，而hibernate-validator提供了一些常用的參數(shù)校驗注解，我們可以拿來使用。
1.maven中引入hibernate-validator對應(yīng)的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;
/**
* 狀態(tài)
**/
@Pattern(regexp = "0[0123]", message = "狀態(tài)只能為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;
import com.atai.framework.lang.AppException;
public class ValidationUtils {
/**
* 使用hibernate的注解來進行驗證
*
*/
private static Validator validator = Validation
.byProvider(HibernateValidator.class).configure().failFast(true).buildValidatorFactory().getValidator();
public static <T> void validate(T obj) {
Set<ConstraintViolation<T>> constraintViolations = validator.validate(obj);
// 拋出檢驗異常
if (constraintViolations.size() > 0) {
throw new AppException("0001", String.format("參數(shù)校驗失敗:%s", constraintViolations.iterator().next().getMessage()));
}
}
}
4.在代碼中調(diào)用工具類進行參數(shù)校驗：
ValidationUtils.validate(requestDto);
以下是對hibernate-validator中部分注解進行描述：
| 注解 | 描述 |
|---|---|
| @AssertTrue | 用于boolean字段，該字段只能為true |
| @AssertFalse | 該字段的值只能為false |
| @CreditCardNumber | 對信用卡號進行一個大致的驗證 |
| @DecimalMax | 只能小于或等于該值 |
| @DecimalMin | 只能大于或等于該值 |
| @Digits(integer=,fraction=) | 檢查是否是一種數(shù)字的整數(shù)、分數(shù),小數(shù)位數(shù)的數(shù)字 |
| 檢查是否是一個有效的email地址 | |
| @Future | 檢查該字段的日期是否是屬于將來的日期 |
| @Length(min=,max=) | 檢查所屬的字段的長度是否在min和max之間,只能用于字符串 |
| @Max | 該字段的值只能小于或等于該值 |
| @Min | 該字段的值只能大于或等于該值 |
| @NotNull | 不能為null |
| @NotBlank | 不能為空，檢查時會將空格忽略 |
| @NotEmpty | 不能為空，這里的空是指空字符串 |
| @Null | 檢查該字段為空 |
| @Past | 檢查該字段的日期是在過去 |
| @Pattern(regex=,flag=) | 被注釋的元素必須符合指定的正則表達式 |
| @Range(min=,max=,message=) | 被注釋的元素必須在合適的范圍內(nèi) |
| @Size(min=, max=) | 檢查該字段的size是否在min和max之間，可以是字符串、數(shù)組、集合、Map等 |
| @URL(protocol=,host,port) | 檢查是否是一個有效的URL，如果提供了protocol，host等，則該URL還需滿足提供的條件 |
| @Valid | 該注解主要用于字段為一個包含其他對象的集合或map或數(shù)組的字段，或該字段直接為一個其他對象的引用，這樣在檢查當前對象的同時也會檢查該字段所引用的對象 |
Bean Validation 中內(nèi)置的 constraint
@Null 被注釋的元素必須為 null
@NotNull 被注釋的元素必須不為 null
@AssertTrue 被注釋的元素必須為 true
@AssertFalse 被注釋的元素必須為 false
@Min(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@Max(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@DecimalMin(value) 被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@DecimalMax(value) 被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@Size(max=, min=) 被注釋的元素的大小必須在指定的范圍內(nèi)
@Digits (integer, fraction) 被注釋的元素必須是一個數(shù)字，其值必須在可接受的范圍內(nèi)
@Past 被注釋的元素必須是一個過去的日期
@Future 被注釋的元素必須是一個將來的日期
@Pattern(regex=,flag=) 被注釋的元素必須符合指定的正則表達式
Hibernate Validator 附加的 constraint
@NotBlank(message =) 驗證字符串非null，且長度必須大于0
@Email 被注釋的元素必須是電子郵箱地址
@Length(min=,max=) 被注釋的字符串的大小必須在指定的范圍內(nèi)
@NotEmpty 被注釋的字符串的必須非空
@Range(min=,max=,message=) 被注釋的元素必須在合適的范圍內(nèi)
