Hibernate Validator自定义校验枚举类型

原文地址，转载请注明出处： https://blog.youkuaiyun.com/qq_34021712/article/details/87895875  ©王赛超

Bean Validation API定义了一整套标准约束注解，例如@NotNull， @Size等等。如果这些内置约束不够，我们可以轻松创建自定义约束。
参考官方文档：
https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#validator-customconstraints

具体步骤如下：

1. 创建一个注解
2. 实现对该注解的解析
3. 在项目中使用该注解校验参数

有时候在定义接口的时候，我们经常会有一个对象的属性值只能出现在一组常量中的校验需求，例如用户的性别,状态等。那么我们怎么能更好的校验这个参数呢？我们想拥有一个java注解，把它标记在所要校验的字段上，当开启hibernate validator校验时，就可以校验其字段值是否正确。

为了尽可能的通用，上面提到的一组常量值，我们应该是定义一个枚举类，下面我们看代码实现。

代码实现

1.自定义注解

package com.test.validation.config.validation;

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

@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumCheckValidator.class)
public @interface EnumCheck {

    String message() default "";

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

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

    Class<? extends Enum<?>> enumClass();

    String enumMethod();
}

2.定义一个校验器实现对该注解的解析

package com.test.validation.config.validation;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;

/**
 * @author: wangsaichao
 * @date: 2019/2/23
 * @description:
 */
public class EnumCheckValidator implements ConstraintValidator<EnumCheck, String> {

    private Class<? extends Enum<?>> enumClass;
    private String enumMethod;


    @Override
    public void initialize(EnumCheck enumCheck) {
        enumMethod = enumCheck.enumMethod();
        enumClass = enumCheck.enumClass();

    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return Boolean.FALSE;
        }

        if (enumClass == null || enumMethod == null) {
            return Boolean.FALSE;
        }

        Class<?> valueClass = value.getClass();

        try {
            Method method = enumClass.getMethod(enumMethod, valueClass);
            if (!Boolean.TYPE.equals(method.getReturnType()) && !Boolean.class.equals(method.getReturnType())) {
                throw new RuntimeException(String.format("%s method return is not boolean type in the %s class", enumMethod, enumClass));
            }

            if(!Modifier.isStatic(method.getModifiers())) {
                throw new RuntimeException(String.format("%s method is not static method in the %s class", enumMethod, enumClass));
            }

            Boolean result = (Boolean)method.invoke(null, value);
            return result == null ? false : result;
        } catch (NoSuchMethodException | SecurityException e) {
            throw new RuntimeException(String.format("This %s(%s) method does not exist in the %s", enumMethod, valueClass, enumClass), e);
        }catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}

对于被校验的方法我们要求，它必须是返回值类型为Boolean或boolean，并且必须是一个静态的方法，返回返回值为null时我们认为是校验不通过的，按false逻辑走。

3.定义枚举类

package com.test.validation.base;

/**
 * @author: wangsaichao
 * @date: 2019/2/23
 * @description:
 */
public enum UserStatusEnum {

    /**正常的*/
    NORMAL,
    /**禁用的*/
    DISABLED,
    /**已删除的*/
    DELETED;

    /** 判断参数合法性 */
    public static boolean isValidName(String name) {
        for (UserStatusEnum userStatusEnum : UserStatusEnum.values()) {
            if (userStatusEnum.name().equals(name)) {
                return true;
            }
        }
        return false;
    }
}

4.接受请求参数的Model

public class UserInfo {

    /** 主键 */
    @NotNull(message = "用户id不存在")
    @Range(min = 1,max = Integer.MAX_VALUE,message = "id不正确")
    private Integer id;

    /** 姓名 */
    @NotBlank(message = "用户姓名不能为空")
    private String name;

    /** 身份证号 */
    @Pattern(regexp="^(\\d{18}|\\d{17}(\\d{1}|[X|x]))$",message="身份证格式不正确")
    private String idCardNum;

    /** 年龄 */
    @NotNull(message="用户年龄不能为空")
    @Range(min = 1,max = 150,message = "年龄必须在[1,150]")
    private Integer age;

    /** 家庭住址 */
    @NotBlank(message = "用户地址不能为空")
    private String address;

    /** 状态 */
    @EnumCheck(enumClass = UserStatusEnum.class,enumMethod = "isValidName",message = "状态不正确")
    private String state;
}

5.在项目中使用该注解校验参数

@RequestMapping(value = "/demo8",method = RequestMethod.POST)
@ResponseBody
public void demo8(@RequestBody @Valid UserInfo userInfo){
    System.out.println(userInfo.toString());
}

测试

请求参数：

{"id":"10","name":"张三","idCardNum":"123456789012345678","age":"25","address":"河北邯郸","state":"瞎写的值,无法验证通过"}

结果