Spring Boot中实现通用枚举校验：基于自定义注解与反射的实践

// 针对特定Platform枚举的注解
@Target({ FIELD, PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = PlatformValidator.class)
public @interface PlatformValidation {
    String message() default "Invalid platform format";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

// 针对特定Platform枚举的校验器
public class PlatformValidator implements ConstraintValidator<PlatformValidation, String> {
    @Override
    public boolean isValid(String platform, ConstraintValidatorContext cxt) {
        if (platform == null) {
            return true; // 允许为空，如果需要非空校验，请结合@NotNull
        }
        try {
            Platform.valueOf(platform); // 尝试转换，如果失败则抛出异常
            return true;
        } catch (IllegalArgumentException ex) {
            return false;
        }
    }
}

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

@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = EnumValueValidator.class) // 指定通用的校验器
public @interface EnumValidation {

    String message() default "Invalid enum value"; // 默认错误消息

    Class<?>[] groups() default {}; // 校验组

    Class<? extends Payload>[] payload() default {}; // 负载信息

    /**
     * 指定要校验的枚举类
     * 必须是Enum的子类
     */
    Class<? extends Enum<?>> enumClass();
}

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.lang.reflect.Method;
import java.util.Objects;

public class EnumValueValidator implements ConstraintValidator<EnumValidation, String> {

    private Class<? extends Enum<?>> enumClass; // 存储注解中传入的枚举类

    @Override
    public void initialize(EnumValidation constraintAnnotation) {
        this.enumClass = constraintAnnotation.enumClass(); // 在初始化时获取注解中指定的枚举类
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true; // 如果值为null，则认为通过校验。如果需要非空校验，请结合@NotNull
        }

        if (enumClass == null || !enumClass.isEnum()) {
            // 如果enumClass未指定或不是枚举类型，通常表示注解使用错误，此处可抛出异常或返回false
            // 但在实际应用中，通常通过编译时检查或良好的文档避免这种情况
            return false;
        }

        try {
            // 使用反射调用枚举类的静态valueOf方法进行校验
            // Enum.valueOf(Class<T> enumType, String name) 是一个安全且通用的方法
            Enum.valueOf((Class<Enum>) enumClass, value);
            return true;
        } catch (IllegalArgumentException e) {
            // 如果valueOf方法抛出IllegalArgumentException，表示值不在枚举范围内
            return false;
        } catch (Exception e) {
            // 捕获其他可能的异常，确保健壮性
            return false;
        }
    }
}

// Platform 枚举
public enum Platform {
    IOS, ANDROID, WEB
}

// OrderStatus 枚举
public enum OrderStatus {
    PENDING, PROCESSING, SHIPPED, DELIVERED, CANCELLED
}

import javax.validation.constraints.NotBlank;
import lombok.Data; // 假设使用Lombok简化DTO

@Data
public class MyRequestDTO {

    @NotBlank(message = "Platform cannot be empty")
    @EnumValidation(enumClass = Platform.class, message = "Invalid platform value. Must be IOS, ANDROID, or WEB.")
    private String platform;

    @NotBlank(message = "Order status cannot be empty")
    @EnumValidation(enumClass = OrderStatus.class, message = "Invalid order status. Must be PENDING, PROCESSING, SHIPPED, DELIVERED, or CANCELLED.")
    private String orderStatus;

    // 其他字段...
}

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;

@RestController
public class MyController {

    @PostMapping("/submit")
    public ResponseEntity<String> submitData(@Valid @RequestBody MyRequestDTO requestDTO) {
        // 如果校验通过，则执行业务逻辑
        return ResponseEntity.ok("Data submitted successfully!");
    }
}