讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中枚举类怎么配合注解实现校验逻辑

浅伟酱_9615

浅伟酱_9615

发布时间:2026-08-27 12:39:32

|

401人浏览过

|

来源于php中文网

原创

Java中枚举类配合注解实现校验的核心是:自定义@ValidEnum注解+Gender等业务枚举+EnumValueValidator校验器;枚举含code/desc字段并提供fromCode方法,注解通过enumClass指定枚举类型,校验器支持String、Integer、Enum输入并反射调用fromCode或比对ordinal。

java 中枚举类怎么配合注解实现校验逻辑

Java 中枚举类配合注解实现校验逻辑,核心思路是:**自定义校验注解 + 枚举类提供合法值集合 + ConstraintValidator 做运行时比对**。这种方式既保持类型安全,又让校验规则集中、可复用、易维护。

定义带业务语义的枚举类

枚举本身应明确表达取值范围和含义,推荐包含描述字段(如中文名、code),便于后续扩展校验或展示:

public enum Gender {
    MALE("M", "男"),
    FEMALE("F", "女"),
    OTHER("O", "其他");

    private final String code;
    private final String desc;

    Gender(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    public String getCode() { return code; }
    public String getDesc() { return desc; }

    // 提供根据 code 查找枚举的静态方法(ConstraintValidator 里会用到)
    public static Gender fromCode(String code) {
        for (Gender g : Gender.values()) {
            if (g.code.equalsIgnoreCase(code)) {
                return g;
            }
        }
        return null;
    }
}

编写自定义校验注解

注解需标注 @Target({METHOD, FIELD, PARAMETER}) 和 @Constraint(validatedBy = EnumValueValidator.class),并声明支持的枚举类型:

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumValueValidator.class)
public @interface ValidEnum {
    String message() default "不合法的枚举值";
    Class<?> enumClass(); // 运行时传入具体枚举类,如 Gender.class
    Class<? extends Payload>[] payload() default {};
    Class<? extends Group>[] groups() default {};
}

实现 ConstraintValidator 支持泛型枚举校验

关键点在于:通过反射获取枚举类所有常量,并检查待校验值是否在其中。支持 String、Integer、Enum 三种常见输入类型:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载

立即学习“Java免费学习笔记(深入)”;

public class EnumValueValidator implements ConstraintValidator<ValidEnum, Object> {

    private Class<?> enumClass;

    @Override
    public void initialize(ValidEnum constraintAnnotation) {
        this.enumClass = constraintAnnotation.enumClass();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        if (value == null) return true; // 可按需改为 false(非空+枚举双重校验)

        // 如果 value 本身就是该枚举类型,直接允许
        if (enumClass.isEnum() && enumClass.isInstance(value)) {
            return true;
        }

        // 尝试从枚举中查找匹配项:支持 code 字段(String)或 ordinal(Integer)
        try {
            if (value instanceof String str) {
                // 优先调用枚举的 fromCode 方法(如有)
                Method fromCode = enumClass.getDeclaredMethod("fromCode", String.class);
                Object result = fromCode.invoke(null, str);
                return result != null;
            } else if (value instanceof Integer idx) {
                Object[] constants = enumClass.getEnumConstants();
                return idx >= 0 && idx < constants.length;
            }
        } catch (Exception ignored) {}

        return false;
    }
}

在 DTO 或参数中使用注解

校验时只需指定具体枚举类,清晰直观:

public class UserRequest {
    @ValidEnum(enumClass = Gender.class)
    private String genderCode; // 传 "M"、"F" 等字符串

    @ValidEnum(enumClass = Gender.class)
    private Gender genderEnum; // 也可直接传 Gender 枚举实例(前端 JSON 通常传字符串,后端反序列化为枚举需额外配置)

    // getter/setter...
}

Spring Boot 项目中,配合 @Valid 使用即可触发校验:

@PostMapping("/user")
public ResponseEntity<?> createUser(@Valid @RequestBody UserRequest request) {
    // ...
}

若传入非法值(如 "X"),将自动返回 400 和默认错误消息。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

9757

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

6902

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6112

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1064

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

888

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1276

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2569

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

19891

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn