用好spring mvc validator能夠簡化代碼

時間 2019-11-10

標籤用好 spring mvc validator 能夠簡化代碼欄目 Spring 简体版

原文原文鏈接

表單的數據檢驗對一個程序來說很是重要，由於對於客戶端的數據不能徹底信任，常規的檢驗類型有：git

參數爲空，根據不一樣的業務規定要求表單項是必填項
參數值的有效性，好比產品的價格，必定不能是負數
多個表單項組合檢驗，好比在註冊時密碼與確認密碼必須相同
參數值的數據範圍，常見的是一些狀態值，或者叫枚舉值，若是傳遞的參數超出已經定義的枚舉那麼也是無心義的

上面的這些檢驗基本上都是純數據方面的，還不算具體的業務數據檢驗，下面是一些強業務相關的數據檢驗正則表達式

根據產品ID，去檢驗ID是否真實存在
註冊用戶時，須要檢驗用戶名的惟一性
....

根據上面的需求，若是咱們將這些檢驗的邏輯所有與業務邏輯耦合在一塊兒，那麼咱們的程序邏輯將會變得冗長並且不便於代碼複用，下面的代碼就是耦合性強的一種體現：spring

           if (isvUserRequestDTO == null) {
                log.error("can not find isv request by request id, " + isvRequestId);
                return return_value_error(ErrorDef.FailFindIsv);
            }
            if (isvUserRequestDTO.getAuditStatus() != 1) {
                log.error("isv request is not audited, " + isvRequestId);
                return return_value_error(ErrorDef.IsvRequestNotAudited);
            }

咱們能夠利用spring提供的validator來解耦表單數據的檢驗邏輯，能夠將上述的代碼從具體的業務代碼的抽離出去。mvc

Hibernate validator，它是JSR-303的一種具體實現。它是基於註解形式的，咱們看一下它原生支持的一些註解。

ide

註解	說明
@Null	只能爲空，這個用途場景比較少
@NotNull	不能爲空，經常使用註解
@AssertFalse	必須爲false，相似於常量
@AssertTrue	必須爲true，相似於常量
@DecimalMax(value)
@DecimalMin(value)
@Digits(integer,fraction)
@Future	表明是一個未來的時間
@Max(value)	最大值，用於一個枚舉值的數據範圍控制
@Min(value)	最小值，用於一個枚舉值的數據範圍控制
@Past	表明是一個過時的時間
@Pattern(value)	正則表達式，好比驗證手機號，郵箱等，很是經常使用
@Size(max,min)	限制字符長度必須在min到max之間this

基礎數據類型的使用示例spa

@NotNull(message = "基礎數量不能爲空")
    @Min(value = 0,message = "基礎數量不合法")
    private Integer baseQty;

嵌套檢驗，若是一個對象中包含子對象（非基礎數據類型）須要在屬性上增長@Valid註解。hibernate

   @Valid
   @NotNull(message = "價格策略內容不能爲空")
    private List<ProductPricePolicyItem> policyItems;

除了原生提供的註解外，咱們還能夠自定義一些限制性的檢驗類型，好比上面提到的多個屬性之間的聯合檢驗。該註解須要使用@Constraint標註，這裏我編寫了一個用於針對兩個屬性之間的數據檢驗的規則，它支持兩個屬性之間的以下操做符，並且能夠設置多組屬性對。3d

建立註解code

經過@Constraint指定檢驗的實現類CrossFieldMatchValidator
增長兩個屬性名稱字段，用於後續的檢驗
增長一個註解的List，用來支持一個對象中檢驗多組屬性對。好比即須要檢驗最大數量與最小數量，也須要檢驗密碼與確認密碼

@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RUNTIME)
@Constraint(validatedBy = CrossFieldMatchValidator.class)
@Documented
public @interface CrossFieldMatch {

    String message() default "{constraints.crossfieldmatch}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    /**
     * @return The first field
     */
    String first();

    /**
     * @return The second field
     */
    String second();

    /**
     * first operator second
     * @return
     */
    CrossFieldOperator operator();

    /**
     * Defines several <code>@FieldMatch</code> annotations on the same element
     *
     * @see CrossFieldMatch
     */
    @Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        CrossFieldMatch[] value();
    }
}

檢驗實現類

isValid方法，經過反射能夠取到須要檢驗的兩個字段的值以及數據類型，而後根據指定的數據操做符以及數據類型作出計算。目前這個檢驗只針對個人業務並不十分通用，須要根據本身的項目狀況來靈活處理。

public class CrossFieldMatchValidator implements ConstraintValidator<CrossFieldMatch, Object> {

    private String firstFieldName;
    private String secondFieldName;
    private CrossFieldOperator operator;

    @Override
    public void initialize(final CrossFieldMatch constraintAnnotation) {
        firstFieldName = constraintAnnotation.first();
        secondFieldName = constraintAnnotation.second();
        operator=constraintAnnotation.operator();
    }

    @Override
    public boolean isValid(final Object value, final ConstraintValidatorContext context) {
        try {
            Class valueClass=value.getClass();
            final Field firstField = valueClass.getDeclaredField(firstFieldName);
            final Field secondField = valueClass.getDeclaredField(secondFieldName);
            //不支持爲null的字段
            if(null==firstField||null==secondField){
                return false;
            }

            firstField.setAccessible(true);
            secondField.setAccessible(true);
            Object firstFieldValue= firstField.get(value);
            Object secondFieldValue= secondField.get(value);

            //不支持類型不一樣的字段
            if(!firstFieldValue.getClass().equals(secondFieldValue.getClass())){
                return false;
            }

            //整數支持 long int short
            //浮點數支持 double
            if(operator==CrossFieldOperator.EQ) {
                return firstFieldValue.equals(secondFieldValue);
            }
            else if(operator==CrossFieldOperator.GT){
                if(firstFieldValue.getClass().equals(Long.class)||firstFieldValue.getClass().equals(Integer.class)||firstFieldValue.getClass().equals(Short.class)) {
                    return (Long)firstFieldValue > (Long) secondFieldValue;
                }
                else if(firstFieldValue.getClass().equals(Double.class)) {
                    return (Double)firstFieldValue > (Double) secondFieldValue;
                }

            }
            else if(operator==CrossFieldOperator.GE){
                if(firstFieldValue.getClass().equals(Long.class)||firstFieldValue.getClass().equals(Integer.class)||firstFieldValue.getClass().equals(Short.class)) {
                    return Long.valueOf(firstFieldValue.toString()) >= Long.valueOf(secondFieldValue.toString());
                }
                else if(firstFieldValue.getClass().equals(Double.class)) {
                    return Double.valueOf(firstFieldValue.toString()) >= Double.valueOf(secondFieldValue.toString());
                }
            }
            else if(operator==CrossFieldOperator.LT){
                if(firstFieldValue.getClass().equals(Long.class)||firstFieldValue.getClass().equals(Integer.class)||firstFieldValue.getClass().equals(Short.class)) {
                    return (Long)firstFieldValue < (Long) secondFieldValue;
                }
                else if(firstFieldValue.getClass().equals(Double.class)) {
                    return (Double)firstFieldValue < (Double) secondFieldValue;
                }
            }
            else if(operator==CrossFieldOperator.LE){
                if(firstFieldValue.getClass().equals(Long.class)||firstFieldValue.getClass().equals(Integer.class)||firstFieldValue.getClass().equals(Short.class)) {
                    return Long.valueOf(firstFieldValue.toString()) <= Long.valueOf(secondFieldValue.toString());
                }
                else if(firstFieldValue.getClass().equals(Double.class)) {
                    return Double.valueOf(firstFieldValue.toString()) <= Double.valueOf(secondFieldValue.toString());
                }
            }
        }
        catch (final Exception ignore) {
            // ignore
        }
        return false;
    }
}

調用示例：

@CrossFieldMatch.List({
        @CrossFieldMatch(first = "minQty", second = "maxQty",operator = CrossFieldOperator.LE ,message = "最小數量必須小於等於最大數量")
})
public class ProductPriceQtyRange implements Serializable{
    /**
     * 最小數量
     */
    @Min(value = 0,message = "最小數量不合法")
    private int minQty;
    /**
     * 最大數量
     */
    @Min(value = 0,message = "最大數量不合法")
    private int maxQty;

    public int getMinQty() {
        return minQty;
    }

    public void setMinQty(int minQty) {
        this.minQty = minQty;
    }

    public int getMaxQty() {
        return maxQty;
    }

    public void setMaxQty(int maxQty) {
        this.maxQty = maxQty;
    }
}

須要在mvc的配置文件中增長以下節點以啓動檢驗

 <mvc:annotation-driven validator="validator">

  <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
        <property name="validationMessageSource" ref="messageSource"/>
    </bean>

    <bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
        <property name="useCodeAsDefaultMessage" value="false"/>  
        <property name="defaultEncoding" value="UTF-8"/>
    </bean>