java入参校验——枚举类型

Posted 2020-11-15 豆豆323

一般来讲，对一些post请求，我们可以使用@valid+javax.validation.constraints包下注解的方式，优雅把参数验证放在control层的requst中，举例说明如下图：

 

 

 

 

 

 但是此时，如果我们知道可以修改的状态只能为枚举类中存在的值，并没有已有的注解可以用，我们可以采用以下代码来实现此功能：

首先我们自己实现一个验证注解，具体代码如下

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

    String message() default "";

    // 作用参考@Validated和@Valid的区别
    Class<?>[] groups() default {};

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

    /**
     * 目标枚举类
     */
    Class<?> target() default Class.class;

    /**
     * 是否忽略空值
     */
    boolean ignoreEmpty() default true;
}

可以的看到上面的注解上，使用了EnumValidator类进行校验，实际上EnumValidator类实现一个ConstraintValidator接口，并在实现isValid与initialize方法，具体代码如下：

public class EnumValidator implements ConstraintValidator<EnumValid, Integer> {

    // 枚举校验注解
    private EnumValid annotation;

    @Override
    public void initialize(EnumValid constraintAnnotation) {

        annotation = constraintAnnotation;
    }

    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
        boolean result = false;

        Class<?> cls = annotation.target();
        boolean ignoreEmpty = annotation.ignoreEmpty();

        // target为枚举，并且value有值，或者不忽视空值，才进行校验
        if (cls.isEnum() && (value != null || !ignoreEmpty)) {

            Object[] objects = cls.getEnumConstants();
            for (Object obj : objects) {
                // 使用此注解的枚举类需要重写toString方法，改为需要验证的值
                if (obj.toString().equals(String.valueOf(value))) {
                    result = true;
                    break;
                }
            }
        } else {
            result = true;
        }
        return result;
    }
}

完成以上代码，由于ConstraintValidator的类型指定为Integer，所以要求枚举中的要校验的值只能为integer型。最后还需要在要使用注解的枚举中重写tostring方法，如下图：

 

 

 完成上述配置后，我们就可以在代码中使用了，具体如下图：