- 引言
- 一、引入Maven依赖
- 二、自定义注解@EnumValid 用于对枚举类校验
- 三、定义接口EnumValidate 用于实现枚举的校验
- 四、枚举校验器 用于校验EnumValidator
- 五、自定义枚举类 实现EnumValidate接口中的方法
- 六、在用于参数接收的VO中使用刚才我们自定义的@EnumValid注解
- 七、在Controller参数接收的位置添加@Validated注解
引言
ValidationApi框架就是用来解决参数校验中代码冗余问题,它提供一些注解用来帮助我们对请求参数进行校验。但是在实际项目中经常需要自定义枚举类来限制参数类型,此篇文章笔者将带领大家解决这个问题。
一、引入Maven依赖二、自定义注解@EnumValid 用于对枚举类校验javax.validation validation-api 2.0.1.Final org.apache.commons commons-lang3 3.3.2 org.projectlombok lombok 1.18.2 true com.github.xiaoymin knife4j-spring-boot-starter 2.0.4
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {EnumValidator.class})
@Documented
public @interface EnumValid {
String message() default "";
Class>[] groups() default {};
Class extends Payload>[] payload() default {};
Class>[] target() default {};
Class extends Enum>> enumClass();
}
三、定义接口EnumValidate 用于实现枚举的校验
public interface EnumValidate四、枚举校验器 用于校验EnumValidator{ boolean existValidate(T value); }
public class EnumValidator implements ConstraintValidator五、自定义枚举类 实现EnumValidate接口中的方法{ private Class extends Enum> enumClass; @Override public void initialize(EnumValid enumValid) { enumClass = enumValid.enumClass(); } @Override public boolean isValid(String value, ConstraintValidatorContext context) { if (value == null || "".equals(value)) { return true; } EnumValidate[] enums = (EnumValidate[]) enumClass.getEnumConstants(); if(enums ==null || enums.length == 0){ return false; } return enums[0].existValidate(value); } }
@Getter public enum SexEnun implements EnumValidate六、在用于参数接收的VO中使用刚才我们自定义的@EnumValid注解{ SEX_MEN("1", "男"), SEX_WOMEN("2", "女"); private final String sex; private final String value; SexEnun(String sex, String value){ this.sex = sex; this.value = value; } @Override public boolean existValidate(String value) { if (value == null || "".equals(value)) { return false; } for (SexEnun testEnum : SexEnun.values()) { if (testEnum.getSex().equalsIgnoreCase(value)) { return true; } } return false; } }
public class StudentVO {
private String studentId;
@NotBlank(message = "学生姓名为必填项")
private String studentName;
@EnumValid(message = "学生性别参数有误!", enumClass = SexEnun.class)
private String studentSex;
}
七、在Controller参数接收的位置添加@Validated注解
@RestController
@RequestMapping("
@PostMapping("***")
public VResponse


