Java8中使用Hibernate Validator验证枚举类型的问题

我完全懂你遇到的痛点——Jackson这类JSON库在反序列化时，只要碰到不匹配的枚举值，直接就炸了，根本轮不到咱们的Bean Validation注解（比如@NotNull、自定义注解）发挥作用。要解决这个问题，咱们得分两步走：先让Jackson“宽容”一点，别直接抛异常，然后再用自定义注解做枚举合法性验证。下面给你具体的实现方案：

1. 让Jackson兼容未知枚举值（避免提前抛异常） #

首先得配置Jackson，让它遇到未知的枚举值时不要直接抛出InvalidFormatException，而是把它映射到一个特殊的枚举项，这样后续验证逻辑才能介入。这里推荐给枚举添加一个UNKNOWN项的方式，更直观：

修改你的枚举类：

public enum EnumType {
    A, B, C,
    // 新增特殊项，用来接收反序列化时的未知值
    UNKNOWN;
}

然后自定义一个枚举反序列化器，把未知值自动映射到UNKNOWN：

public class TolerantEnumDeserializer extends StdDeserializer<EnumType> {

    public TolerantEnumDeserializer() {
        super(EnumType.class);
    }

    @Override
    public EnumType deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        String value = p.getText().trim();
        try {
            return EnumType.valueOf(value);
        } catch (IllegalArgumentException e) {
            // 遇到未知值时返回UNKNOWN，避免反序列化直接失败
            return EnumType.UNKNOWN;
        }
    }
}

接下来把这个反序列化器绑定到你的字段上：

public class MyClass {
    @JsonProperty
    @JsonDeserialize(using = TolerantEnumDeserializer.class)
    // 这里加上咱们的自定义验证注解
    @ValidEnum(enumClass = EnumType.class, exclude = EnumType.UNKNOWN)
    private EnumType enumValue;

    // getter、setter 省略
}

2. 自定义枚举验证注解和验证器 #

现在需要创建一个自定义注解，用来检查枚举值是否为合法项（排除UNKNOWN）：

首先定义注解：

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumValidator.class)
public @interface ValidEnum {
    String message() default "无效的枚举值";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};

    // 指定要验证的枚举类
    Class<? extends Enum<?>> enumClass();
    // 可以指定要排除的枚举项（比如这里的UNKNOWN）
    Enum<?>[] exclude() default {};
}

然后实现对应的验证器：

public class EnumValidator implements ConstraintValidator<ValidEnum, Enum<?>> {
    private Set<String> validValues;

    @Override
    public void initialize(ValidEnum constraintAnnotation) {
        Class<? extends Enum<?>> enumClass = constraintAnnotation.enumClass();
        Enum<?>[] excludeEnums = constraintAnnotation.exclude();

        Set<String> excludeValues = Arrays.stream(excludeEnums)
                .map(Enum::name)
                .collect(Collectors.toSet());

        validValues = Arrays.stream(enumClass.getEnumConstants())
                .map(Enum::name)
                .filter(name -> !excludeValues.contains(name))
                .collect(Collectors.toSet());
    }

    @Override
    public boolean isValid(Enum<?> value, ConstraintValidatorContext context) {
        // 如果需要允许null，可以配合@NotNull注解单独控制，这里默认不允许null
        if (value == null) {
            return false;
        }
        return validValues.contains(value.name());
    }
}

3. 确保验证逻辑生效的配置 #

如果是Spring/Spring Boot项目，别忘了确保Bean Validation功能正常启用：

• Spring Boot项目只需引入spring-boot-starter-validation依赖即可，默认已经开启验证
• 非Spring Boot项目可以在配置类中手动声明验证器：

@Configuration
public class ValidationConfig {
    @Bean
    public LocalValidatorFactoryBean validator() {
        return new LocalValidatorFactoryBean();
    }
}

额外补充：不想加UNKNOWN枚举项的替代方案 #

如果你不想给枚举新增UNKNOWN项，也可以让Jackson把未知值设为null，只需在Jackson配置里开启这个特性：

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        // 遇到未知枚举值时自动设为null
        objectMapper.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL);
        return objectMapper;
    }
}

这种情况下，你可以直接在字段上配合@NotNull和自定义注解检查值是否在枚举合法范围内，但缺点是无法提示用户具体传入了哪个非法值，体验不如前一种方案。

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