如何实现支持指定枚举类的Spring Boot通用枚举校验注解

当然可以实现这种通用的枚举校验注解，不用为每个枚举单独编写校验器。下面是具体的实现步骤和代码：

1. 定义通用校验注解 #

创建带参数的注解，允许指定要校验的枚举类，同时支持自定义错误消息，还能通过占位符动态展示枚举的有效值：

@Target({FIELD, PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = GenericEnumValidator.class)
public @interface EnumValidation {
    String message() default "无效的枚举值，允许的值为: {enumValues}";

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

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

    // 核心参数：指定需要校验的枚举类
    Class<? extends Enum<?>> enumClass();
}

2. 实现通用校验器 #

编写通用校验器，通过反射获取指定枚举的所有有效值，完成输入值的合法性校验：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.Set;
import java.util.stream.Collectors;

public class GenericEnumValidator implements ConstraintValidator<EnumValidation, String> {
    private Set<String> validEnumValues;
    private EnumValidation constraintAnnotation;

    @Override
    public void initialize(EnumValidation constraintAnnotation) {
        this.constraintAnnotation = constraintAnnotation;
        // 提取枚举的所有name值，存入集合用于快速校验
        validEnumValues = Arrays.stream(constraintAnnotation.enumClass().getEnumConstants())
                .map(Enum::name)
                .collect(Collectors.toSet());
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 允许null值通过（如果需要强制非null，可配合@NotBlank等注解一起使用）
        if (value == null) {
            return true;
        }

        boolean isValid = validEnumValues.contains(value);
        if (!isValid) {
            // 替换错误消息中的占位符，显示实际的枚举有效值
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate(
                    constraintAnnotation.message().replace("{enumValues}", validEnumValues.toString())
            ).addConstraintViolation();
        }
        return isValid;
    }
}

3. 使用示例 #

在DTO字段或接口参数上直接使用该注解，指定对应的枚举类即可：

public class BusinessDTO {
    // 自定义错误消息
    @EnumValidation(enumClass = Platform.class, message = "平台类型错误，可选值：{enumValues}")
    private String platform;

    // 使用默认错误消息
    @EnumValidation(enumClass = OrderStatus.class)
    private String orderStatus;

    // getter、setter方法
}

扩展说明 #

如果你的枚举不是通过name()值校验，而是有自定义编码字段（比如code），可以给注解增加fieldName参数，在校验器中通过反射获取对应字段的值进行校验：

// 扩展注解
public @interface EnumValidation {
    // ... 原有参数
    String fieldName() default "name"; // 默认校验name字段
}

// 校验器中修改初始化逻辑
validEnumValues = Arrays.stream(constraintAnnotation.enumClass().getEnumConstants())
        .map(enumConstant -> {
            try {
                Field field = enumConstant.getClass().getDeclaredField(constraintAnnotation.fieldName());
                field.setAccessible(true);
                return field.get(enumConstant).toString();
            } catch (Exception e) {
                throw new RuntimeException("获取枚举字段失败", e);
            }
        })
        .collect(Collectors.toSet());

这样就能支持更灵活的枚举字段校验了。

内容的提问来源于stack exchange，提问作者Safari