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

本文介绍如何在 Spring Boot 项目中使用自定义注解实现通用的枚举类型校验。通过 Java 反射机制，我们可以创建一个可以应用于不同枚举类型的校验注解，从而简化代码并提高可维护性。本文将提供详细的代码示例和步骤，帮助你理解和实现这一功能。

创建自定义注解

首先，我们需要创建一个自定义注解，该注解将接收需要校验的枚举类型作为参数。

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 属性用于指定需要校验的枚举类型。

创建校验器

接下来，我们需要创建一个校验器，该校验器将使用 Java 反射来验证输入值是否为指定枚举类型的有效值。

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; // 允许空值，如果需要不允许，可以在注解中添加 @NotNull
        }
        return enumValues.contains(value);
    }
}

在这个校验器中，initialize 方法用于获取注解中指定的枚举类型的所有枚举值，并将它们存储在一个列表中。isValid 方法用于验证输入值是否在这个列表中。

使用示例

现在，我们可以在 DTO 类中使用这个自定义注解来验证枚举类型的值。

Munch

AI营销分析工具，长视频中提取出最具吸引力的短片

下载

假设我们有一个名为 MyEnum 的枚举类型：

public enum MyEnum {
    VALUE1,
    VALUE2,
    VALUE3
}

然后，我们可以在 DTO 类中使用 @EnumValidation 注解来验证 myEnumValue 字段：

import javax.validation.constraints.NotBlank;

public class MyDto {

    @NotBlank
    @EnumValidation(enumClass = MyEnum.class, message = "Invalid MyEnum value")
    private String myEnumValue;

    public String getMyEnumValue() {
        return myEnumValue;
    }

    public void setMyEnumValue(String myEnumValue) {
        this.myEnumValue = myEnumValue;
    }
}

现在，当 Spring Boot 验证 MyDto 对象时，如果 myEnumValue 字段的值不是 MyEnum 枚举类型的有效值，将会抛出一个校验异常。

注意事项

• 确保在 Spring Boot 项目中启用了 Bean Validation。通常情况下，只需要在 pom.xml 文件中添加 spring-boot-starter-validation 依赖即可。

    org.springframework.boot
    spring-boot-starter-validation

• 可以根据实际需求自定义注解的 message 属性，以便提供更友好的错误提示信息。
• isValid方法中对value == null进行了处理，可以根据实际需求修改为不允许null值。

总结

通过使用自定义注解和 Java 反射，我们可以实现一个通用的枚举类型校验器，该校验器可以应用于不同的枚举类型。这可以简化代码并提高可维护性。希望本文能够帮助你理解和实现这一功能。