标题：Spring Boot 中实现通用枚举类型校验

Spring Boot 项目中，经常需要对接收到的参数进行校验，特别是当参数为枚举类型时，确保输入值是枚举中有效值显得尤为重要。本文将介绍如何利用自定义注解和 Java 反射机制，实现一个通用的枚举类型校验器，从而避免为每种枚举类型编写单独的校验逻辑。

首先，我们定义一个自定义注解 @EnumValidation，该注解允许指定需要校验的枚举类型。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = EnumValidator.class)
public @interface EnumValidation {

    String message() default "Invalid enum value";

    Class[] groups() default {};

    Class[] payload() default {};

    Class> enumClass();
}

在上面的代码中，enumClass 属性用于指定需要校验的枚举类型。

接下来，我们需要创建一个校验器 EnumValidator，实现 ConstraintValidator 接口。

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

public class EnumValidator implements ConstraintValidator {

    private List enumValues;

    @Override
    public void initialize(EnumValidation constraintAnnotation) {
        Class> enumClass = constraintAnnotation.enumClass();
        enumValues = Arrays.stream(enumClass.getEnumConstants())
                .map(Enum::name)
                .collect(Collectors.toList());
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true; // 允许 null 值，根据实际需求调整
        }
        return enumValues.contains(value);
    }
}

EnumValidator 的 initialize 方法会在校验器初始化时被调用，用于获取指定枚举类型的所有有效值，并存储到 enumValues 列表中。isValid 方法则用于判断输入值是否在 enumValues 列表中。

示例：

假设我们有一个枚举类型 OrderStatus：

AI Content Detector

Writer推出的AI内容检测工具

下载

public enum OrderStatus {
    PENDING,
    PROCESSING,
    SHIPPED,
    DELIVERED,
    CANCELLED
}

我们可以在 DTO 类的字段上使用 @EnumValidation 注解来校验 OrderStatus 类型的值：

import javax.validation.constraints.NotBlank;

public class OrderDto {

    @NotBlank
    @EnumValidation(enumClass = OrderStatus.class, message = "Invalid order status")
    private String status;

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }
}

使用方法：

1. 确保项目中引入了 javax.validation 依赖。
2. 定义自定义注解 @EnumValidation 和校验器 EnumValidator。
3. 在需要校验的字段上使用 @EnumValidation 注解，并指定 enumClass 属性为对应的枚举类型。
4. 使用 Spring 的 @Valid 注解触发校验。

注意事项：

• isValid 方法中，我们允许 null 值通过校验。如果需要禁止 null 值，可以修改 isValid 方法的逻辑。
• message 属性可以自定义校验失败时的错误信息。
• 如果需要支持国际化，可以将错误信息配置在 messages.properties 文件中。

总结：

通过自定义注解和 Java 反射机制，我们可以实现一个通用的枚举类型校验器，避免为每种枚举类型编写单独的校验逻辑，提高代码的可维护性和可扩展性。这种方法不仅适用于 Spring Boot 项目，也可以应用于其他 Java 项目中。掌握这种技巧，可以帮助开发者编写更加健壮和可靠的代码。