Hibernate-validator自定义扩展

Hibernate-validator是springmvc中对于控制层的参数进行校验的常用工具，有些特殊情况下，自带的校验器可能不满足我们的场景需要，我们可以自定义扩展校验注解。

校验一个字段的值是某几个特定的值

增加自定注解Include和校验器IncludeValidator

package com.sinosoft.springbootplus.common.validator;

import org.apache.commons.lang3.StringUtils;

import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.util.Arrays;
import java.util.HashSet;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 校验字段的值只能是特定的值
 */

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(Include.List.class)
@Documented
@Constraint(validatedBy = { Include.IncludeValidator.class })
public @interface Include {
    String message() default "{javax.validation.constraints.Include.message}";

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

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

    String[] value();

    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        Include[] value();
    }

    /**
     * 这个是自定义的校验逻辑
     * 泛型中第一个是注解类名，第二个是参数的数据类型
     */
    class IncludeValidator implements ConstraintValidator<Include, String> {
        private Include constraintAnnotation;
        @Override
        public void initialize(Include constraintAnnotation) {
            this.constraintAnnotation = constraintAnnotation;
        }

        @Override
        public boolean isValid(String val, ConstraintValidatorContext constraintValidatorContext) {
            boolean valid = false;
            HashSet<String> valueSet = new HashSet<String>(Arrays.asList(this.constraintAnnotation.value()));
            if (StringUtils.isNotBlank(val)) {
                return valueSet.contains(val);
            }
            return true;
        }
    }
}

跨字段验证

跨字段验证是我们希望根据多个字段验证数据是不是合法，比如根据证件类型验证证件号码是否合法，不同类型的证件号码验证规则是不同的，此时我们可以自定义注解进行跨字段验证。

自定义注解

package com.sinosoft.springbootplus.common.validator.myValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;


@Target({TYPE, ANNOTATION_TYPE})
@Retention(RUNTIME)
@Constraint(validatedBy = IdCardConstraintValidator.class)
@Documented
public @interface IdCardConstraint {
    String message() default "请输入合法的证件号码";

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

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

    /**
     * @return 证件类型
     */
    String cardType();

    /**
     * @return 证件号码
     */
    String cardId();



    @Target({TYPE, ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Documented
    @interface List
    {
        IdCardConstraint[] value();
    }
}

校验器

package com.sinosoft.springbootplus.common.validator.myValidator;


import cn.hutool.core.util.IdcardUtil;
import com.sinosoft.springbootplus.common.enums.CardTypeEnum;
import org.apache.commons.beanutils.BeanUtils;
import org.apache.commons.lang3.StringUtils;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class IdCardConstraintValidator implements ConstraintValidator<IdCardConstraint, Object>
{
    private String cardType;
    private String cardId;

    @Override
    public void initialize(IdCardConstraint constraintAnnotation) {
        cardType = constraintAnnotation.cardType();
        cardId = constraintAnnotation.cardId();
    }

    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        try
        {
            final String myCardType = BeanUtils.getProperty(o, cardType);
            final String myCardId = BeanUtils.getProperty(o, cardId);
            if(StringUtils.isNotBlank(myCardType)&&StringUtils.isNotBlank(myCardId)){
                if(StringUtils.equals(myCardType, CardTypeEnum.ID_CARD.getValue())){
                    //校验身份证号是否合法
                    return IdcardUtil.isValidCard(myCardId);
                }
                if(StringUtils.equals(myCardType, CardTypeEnum.PASSPORT.getValue())){
                    //校验身份证号是否合法
                    return 9 == StringUtils.length(myCardId);
                }
                if(StringUtils.equals(myCardType, CardTypeEnum.VISA.getValue())){
                    //校验身份证号是否合法
                    return 10 == StringUtils.length(myCardId);
                }
            }

            return true;
        }
        catch (final Exception ignore)
        {
            // ignore
        }
        return true;
    }

}

以上两个自定义注解使用demo

@IdCardConstraint.List({
        @IdCardConstraint(cardId = "cardId",cardType = "cardType")
})
public class ImportStaffExcelParam {
    @ExcelProperty(value = "*姓名")
    @NotBlank(message = "请输入姓名")
    private String name;

    @ExcelProperty(value = "*证件类型")
    @NotBlank(message = "请输入证件类型")
    @Include(value = {"居民身份证", "护照","签证"}, message = "请输入合法的证件类型")
    private String cardType;

    @ExcelProperty(value = "*证件号码")
    @NotBlank(message = "请输入证件号码")
    private String cardId;
 }