校验枚举参数是否为合法性

 

 

 

开发过程中，有很多地方需要对参数进行校验，而有的参数比如状态1，2，3，4，5的，只能输入这个返回的值。

这个时候大多数采用枚举来做，以保证数据的安全性。

本文采用注解来实现对枚举的值的校验，编写自定义注解如下：

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

    Class<?> value();

    String message() default "The parameter is not in the specified enumeration!";

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

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


}

处理自定义注解类

public class EnumValidatorClass implements ConstraintValidator<EnumValidator,Object>, Annotation {

    private final  static Logger logger = LoggerFactory.getLogger(EnumValidator.class);
    private List<Object> values = new ArrayList<>();

    @Override
    public void initialize(EnumValidator enumValidator) {
        Class<?> clazz = enumValidator.value();
        Object [] objects = clazz.getEnumConstants();
        try {
            Method method = clazz.getMethod("getCode");
            if (Objects.isNull(method)){
                throw new Exception(String.format("Enumeration object {} is missing a field with the field name value",clazz.getName()));

            }
            Object value = null;
            for (Object obj : objects) {
                value = method.invoke(obj);
                values.add(value);
            }
        }catch (Exception e){
            logger.error("[Handling enumeration check exceptions]");
        }


    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        return Objects.isNull(value) || values.contains(value)?true:false;
    }

    @Override
    public Class<? extends Annotation> annotationType() {
        return null;
    }
}

切面类：

@Order(2)
@Component
@Aspect
public class ValidatorAspect {

    @Autowired
    private LocalValidatorFactoryBean localValidatorFactoryBean;

    public ValidatorAspect(){

    }

    @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)"+
         "||@annotation(org.springframework.web.bind.annotation.GetMapping)"+
            "||@annotation(org.springframework.web.bind.annotation.PostMapping)"+
            "||@annotation(org.springframework.web.bind.annotation.PutMapping)"+
            "||@annotation(org.springframework.web.bind.annotation.DeleteMapping)"

    )
    private void paramPointCut(){

    }


    /**
     * 校验参数
     */
    @Before("paramPointCut() && args(requestBase,..)")
    public void validateParameter(JoinPoint joinPoint, RequestBase requestBase){
        Set<ConstraintViolation<RequestBase>> validates = this.localValidatorFactoryBean.validate(requestBase, new Class[]{Default.class});
        Iterator iterator = validates.iterator();
        StringBuffer errorMsg =new  StringBuffer();

        while (iterator.hasNext()){
            ConstraintViolation constraintViolation = (ConstraintViolation) iterator.next();
            String error = constraintViolation.getPropertyPath() + ":" + constraintViolation.getMessage();
            errorMsg.append(iterator.hasNext() ? error + "; " : error);
        }

        if(!validates.isEmpty()){
           throw  new CalorieException(errorMsg.toString());
        }



    }

}

 

编写请求父类，实体类需要继承此类

public class RequestBase {
}

使用此类

public class TestEntity implements RequestBase{
    //使用此注解完成对此参数的校验
    //TestEnum是枚举类(code,desc)
    @EnumValidator(value = TestEnum.class)
    private String status;
}

枚举类书写如下：

public enum TestEnum{

STATUS_ONE("1","状态1"),
STATUS_ONE("2","状态2"),
STATUS_ONE("3","状态3"),
STATUS_ONE("4","状态4"),
STATUS_ONE("5","状态5");
private String code;
private String desc;

private TestEnum(String code,String desc){
    this.code = code;
    this.desc = desc;
}

public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

}