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

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日