Spring Boot中枚举校验需自定义@ValidEnum注解配合ConstraintValidator实现，核心是验证字符串是否为枚举类中定义的有效常量名或值，确保类型安全与REST接口友好性。
Spring Boot 中枚举值校验不能直接用内置的 @NotNull 或 @Pattern 完成，因为枚举是类型安全的 Java 类，校验核心在于“传入的字符串是否为枚举定义的有效常量名（或值）”。推荐通过自定义注解 + ConstraintValidator 实现，兼顾类型安全、可复用性和 REST 接口友好性。
定义自定义校验注解 @ValidEnum
创建一个注解，用于标记需要校验枚举字段的参数或属性：
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumValidator.class)
public @interface ValidEnum {
Class<? extends Enum<?>> enumClass();
String message() default "不合法的枚举值";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
关键点：
-
enumClass()必须指定具体枚举类（如Status.class），因为 Java 泛型擦除，运行时无法获取泛型信息 -
@Constraint(validatedBy = EnumValidator.class)关联校验逻辑
实现校验器 EnumValidator
校验器需支持字符串输入（常见于 JSON 请求体或 URL 参数），并判断其是否匹配枚举的 name() 或自定义字段（如 code）：
public class EnumValidator implements ConstraintValidator<ValidEnum, String> {
private Class<? extends Enum<?>> enumClass;
@Override
public void initialize(ValidEnum annotation) {
this.enumClass = annotation.enumClass();
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if (value == null) return false;
try {
// 默认按 name() 校验（大小写敏感）
Enum.valueOf(enumClass, value);
return true;
} catch (IllegalArgumentException e) {
return false;
}
}
}
进阶建议（可选）：
- 若枚举用
code字段（如public enum Status { ENABLE(1), DISABLE(0); private final int code; ...}），可在注解中加String field() default "name"，并在校验器中用反射读取对应字段值 - 增加忽略大小写支持：用
Arrays.stream(enumClass.getEnumConstants()).map(Enum::name).anyMatch(name -> name.equalsIgnoreCase(value))
在 DTO 或 Controller 参数中使用
校验注解可放在 DTO 字段上（配合 @Valid），也可直接用于 Controller 方法参数：
public enum Gender {
MALE, FEMALE, OTHER
}
public class UserDTO {
@ValidEnum(enumClass = Gender.class)
private String gender;
// getter/setter...
}
@RestController
public class UserController {
// 方式一：DTO 校验（推荐）
@PostMapping("/user")
public Result createUser(@Valid @RequestBody UserDTO dto) {
return Result.ok();
}
// 方式二：直接校验路径/查询参数
@GetMapping("/users")
public Result listUsers(@ValidEnum(enumClass = Gender.class) @RequestParam String gender) {
return Result.ok();
}
}
注意：
- Controller 层需开启校验：确保类上有
@Validated（Spring MVC 默认开启，但显式添加更清晰） - 全局异常处理建议捕获
MethodArgumentNotValidException（DTO）和ConstraintViolationException（参数级），统一返回错误信息
补充：简化方案（仅限简单场景）
如果项目中枚举较少且结构统一，可用 Spring 的 @Enumerated（JPA）或 Jackson 的 @JsonCreator 配合反序列化校验，但这类方式属于“失败抛异常”，不提供细粒度错误提示，也不适用于非 JSON 场景（如表单提交）。自定义注解仍是通用性最强、语义最清晰的选择。
