springboot 自定义validation参数校验注解 校验枚举值

在写springboot项目的时候，经常需要对参数进行校验。如果是一个参数还好，写一个if-else就好了。但如果传入的参数是一个对象，那就需要写很多if-else了，而且这个对象可能在很多地方作为参数使用。

validation 介绍

这个时候就可以考虑使用参数校验注解了，首先是引入依赖。

<dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> </dependency>

然后我们可以看到它为我们提供了以下参数校验注解，基本看名字就知道什么意思。具体使用可以看后面自定义的注解使用示例。

自定义注解

但是，有时候这些注解并不能满足我们的需求。那么我们就可以自己定义一个校验注解。validation-api 也为我们提供了拓展的功能。

需求：很多参数如xx类型，xx状态这种，一般都有一个枚举类对应。所以需要写一个校验参数值是否属于指定枚举类的值的注解，参数值都为整型。

实现： 首先需要定义一个接口，让枚举类实现这个接口。这里的 getValue 获取的对象就是参数传过来的对象。（也可以直接把范型改成 int）

public interface IEnum<T extends Serializable> { T getValue(); }

下面就是自定义注解的内容

定义校验注解

可以仿照默认的注解，依据自己的实际需求，给注解添加相关属性，其中groups, payload 必须添加。

/** * 自定义参数验d证注解, 用于验证枚举类的 int 值作为参数 */ @Retention(RetentionPolicy.RUNTIME) // 这个注解是validation提供的，用于指定对应的校验器 @Constraint(validatedBy = EnumIntValueConstraintValidator.class) @Target({ElementType.FIELD, ElementType.PARAMETER}) public @interface EnumIntValue { String message() default "参数不合法"; /** * @return 指定分组 */ Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; /** * @return 指定枚举类型，参数值必须是这个枚举类型中的值 */ Class<? extends IEnum<Integer>> enumClass(); /** * @return 是否可以为 null */ boolean nullable() default false; /** * @return 需要排除的值 */ int[] exclusion() default {}; }

实现校验方法

自定义的校验方法需要实现ConstraintValidator接口，并指定对应的注解和校验的参数类型。

public class EnumIntValueConstraintValidator implements ConstraintValidator<EnumIntValue, Integer> { private boolean nullable; private Class<? extends IEnum<Integer>> enumClass; private int[] exclusion; private Set<Integer> vals; /** * 初始化校验器，获取注解中的属性并记录下来 */ @Override public void initialize(EnumIntValue constraintAnnotation) { this.nullable = constraintAnnotation.nullable(); this.enumClass = constraintAnnotation.enumClass(); this.exclusion = constraintAnnotation.exclusion(); vals = new HashSet<>(); IEnum<Integer>[] enumConstants = enumClass.getEnumConstants(); for (IEnum<Integer> iEnum : enumConstants) { vals.add(iEnum.getValue()); } for (int i : exclusion) { vals.remove(i); } } /** * 校验参数是否合法 */ @Override public boolean isValid(Integer param, ConstraintValidatorContext context) { if (nullable && param == null) { return true; } return vals.contains(param); } }

使用示例

就和默认的注解一样使用 （很简单的一个示例）

@Getter @AllArgsConstructor public enum SexEnum implements IEnum<Integer> { male(0), female(1); private Integer value; } @Data public class StudentParam { @NotEmpty private String name; @EnumIntValue(enumClass = SexEnum.class, nullable = true) private Integer sex; } // 使用时 public String addStudent(@Validated StudentParam stu) { return "sucess"; }