SpringBoot自定义枚举类型参数校验

在Spring Boot中,你可以使用@Validated注解和自定义的注解来对枚举类型参数进行验证。以下是一个简单的例子:

首先,定义一个用于验证枚举值的注解和其验证器:




// 自定义注解
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = EnumValueValidator.class)
public @interface EnumValue {
    String message() default "Invalid enum value";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    Class<? extends Enum<?>> enumClass();
}
 
// 注解的验证器
public class EnumValueValidator implements ConstraintValidator<EnumValue, Object> {
    private Class<? extends Enum<?>> enumClass;
 
    @Override
    public void initialize(EnumValue enumValue) {
        this.enumClass = enumValue.enumClass();
    }
 
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }
        for (Enum<?> enumItem : enumClass.getEnumConstants()) {
            if (enumItem.name().equals(value.toString())) {
                return true;
            }
        }
        return false;
    }
}

然后,在你的控制器中使用这个注解来验证枚举类型的参数:




// 枚举示例
public enum Color {
    RED, GREEN, BLUE
}
 
// 控制器方法示例
@RestController
public class MyController {
 
    @PostMapping("/color")
    public ResponseEntity<?> getColor(@@Validated @EnumValue(enumClass = Color.class) @RequestParam String color) {
        // 处理请求逻辑
        return ResponseEntity.ok("Color is valid");
    }
}

在这个例子中,我们定义了一个EnumValue注解和它的验证器EnumValueValidator。在控制器的方法参数上使用@EnumValue注解,指定enumClass属性为你的枚举类。当请求到达控制器方法时,Spring Framework会自动使用@Validated注解触发验证过程。如果参数不是有效的枚举值,则会返回错误信息。

最后修改于:2024年09月02日 10:37

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日