Hibernate Validator 自定义注解及验证器

  除了validation-api提供的标准注解，和hibernate-validator提供的扩展注解，我们也可以自定义注解，以实现特定的校验需求。下面将以基于自定义注解完成入参必须在指定枚举值范围内校验为例，讨论下怎么实现注解和验证器的自定义：

1. 自定义注解

   1. 与普通注解相比，这种自定义注解需要增加元注解@Constraint，并通过validatedBy参数指定验证器。
   2. 依据JSR规范，定义三个通用参数：message（校验失败保存信息）、groups（分组）和payload（负载）。
   3. 自定义额外所需配置参数
   4. 定义内部List接口，参数是该自定义注解数组，配合元注解@Repeatable，可使该注解可以重复添加。

   示例代码如下：

package com.inspur.validator.annotation;

import com.inspur.validator.validators.EnumsValidatorForCharSequence;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * 校验字符串在指定枚举值范围之内
 * @author mark
 */
@Documented
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {EnumsValidatorForCharSequence.class})
@Repeatable(Enums.List.class)
public @interface Enums {

    String message() default "不在指定枚举值范围内";

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

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

    /**
     * 指定枚举值<br><br>
     * <b>英文逗号分隔的String类型，示例：'asc, desc'</b><br><br>
     */
    String value() default "";

    /**
     * 是否可为空<br><br>
     * <b>默认为<code>true</code>；如果值为<code>false</code>，则入参为空串会校验失败</b>
     */
    boolean canBeBlank() default true;


    /**
     * Defines several {@code @Enums} annotations on the same element.
     */
    @Documented
    @Target(ElementType.PARAMETER)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface List {
        Enums[] value();
    }

}

2. 自定义验证器

   1. 该验证器需要实现ConstraintValidator接口，ConstraintValidator接口包含两个类型参数，第一个指定验证器要校验的注解，第二个参数指定要验证的数据类型。
   2. 实现initialize方法，通常在该注解中拿到注解的参数值。
   3. 实现isValid方法，方法第一个参数是要校验的属性值；校验逻辑写在该方法内；校验通过返回true，校验失败返回false。

   示例代码如下

package com.inspur.validator.validators;

import com.inspur.validator.annotation.Enums;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

/**
 * 校验字符串在指定枚举值范围之内
 * @author mark
 * @date 2020/11/2 10:57
 */
@Slf4j
public class EnumsValidatorForCharSequence implements ConstraintValidator<Enums, CharSequence> {

    private String value;

    private boolean canBeBlank;

    @Override
    public void initialize(Enums parameters) {
        value = parameters.value();
        canBeBlank = parameters.canBeBlank();
    }

    /**
     * 校验字符串在指定枚举值范围之内
     * @param charSequence The character sequence to validate.
     * @param constraintValidatorContext context in which the constraint is evaluated.
     * @return 如果字符串为null，或字符串在指定枚举值范围之内，返回<code>true</code>，否则返回<code>false</code>
     */
    @Override
    public boolean isValid(CharSequence charSequence, ConstraintValidatorContext constraintValidatorContext) {
        if (charSequence == null) {
            return true;
        }

        if (StringUtils.isBlank(charSequence)) {
            return canBeBlank ? true : false;
        }

        if (StringUtils.isNotBlank(value)) {
            List<String> enumValues = Arrays.stream(value.split(",")).map(x -> x.trim()).collect(Collectors.toList());
            if (!enumValues.contains(charSequence)) {
                return false;
            }
        }

        return true;
    }

}