使用Hibernate-Validation進行參數驗證

在開發JAVA服務器端代碼時，咱們會遇到對外部傳來的參數合法性進行驗證，而hibernate-validator提供了一些經常使用的參數校驗註解，咱們能夠拿來使用。

1.引入hibernate-validator依賴

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>4.3.1.Final</version> 
</dependency>

2.在Model中定義要校驗的字段

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;
import com.atai.framework.lang.AppException;

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 AppException("0001", String.format("參數校驗失敗:%s", constraintViolations.iterator().next().getMessage()));
        }
    }
}

4.在代碼中調用工具類進行參數校驗

ValidationUtils.validate(requestDto);

5.hibernate-validator中經常使用註解

 

@AssertTrue	用於boolean字段，該字段只能爲true
@AssertFalse	該字段的值只能爲false
@CreditCardNumber	對信用卡號進行一個大體的驗證
@DecimalMax	只能小於或等於該值
@DecimalMin	只能大於或等於該值
@Digits(integer=,fraction=)	檢查是不是一種數字的整數、分數,小數位數的數字
@Email	檢查是不是一個有效的email地址
@Future	檢查該字段的日期是不是屬於未來的日期
@Length(min=,max=)	檢查所屬的字段的長度是否在min和max之間,只能用於字符串
@Max	該字段的值只能小於或等於該值
@Min	該字段的值只能大於或等於該值
@NotNull	不能爲null
@NotBlank	不能爲空，檢查時會將空格忽略
@NotEmpty	不能爲空，這裏的空是指空字符串
@Null	檢查該字段爲空
@Past	檢查該字段的日期是在過去
@Pattern(regex=,flag=)	被註釋的元素必須符合指定的正則表達式
@Range(min=,max=,message=)	被註釋的元素必須在合適的範圍內
@Size(min=, max=)	檢查該字段的size是否在min和max之間，能夠是字符串、數組、集合、Map等
@URL(protocol=,host,port)	檢查是不是一個有效的URL，若是提供了protocol，host等，則該URL還需知足提供的條件
@Valid	該註解主要用於字段爲一個包含其餘對象的集合或map或數組的字段，或該字段直接爲一個其餘對象的引用，這樣在檢查當前對象的同時也會檢查該字段所引用的對象