反射读取枚举描述:基于注解和反射的枚举统一响应处理

酷敏小哥_9764

酷敏小哥_9764

2026-06-02

782人浏览

原创

应使用@enumdesc注解标注枚举常量并配合反射工具类统一读取描述,首次加载时缓存“常量→描述”映射,再通过jackson自定义序列化器或@jsonvalue集成到响应中,避免硬编码和侵入业务。

反射读取枚举描述:基于注解和反射的枚举统一响应处理

要让枚举值在响应中自动显示中文描述,而不是原始枚举名,关键不是硬编码每个枚举的toString()或getDesc(),而是用注解声明描述,再靠反射统一读取——这样新增枚举无需改工具类,也不用侵入业务代码。

定义描述注解

创建一个运行时保留、可标注在枚举常量上的注解,用于携带展示文本:

  • @EnumDesc:标注在枚举常量上,value 为要显示的中文描述
  • 必须用 @Target(ElementType.CONSTANT),确保只能写在枚举值上
  • 加上 @Retention(RetentionPolicy.RUNTIME),反射才能读到

反射读取描述的通用方法

写一个静态工具方法,输入任意枚举常量,返回其@EnumDesc的 value;若未标注,则回退为枚举名:

Neeva
Neeva

一款AI工具,主要用于Neeva是一款无广告、无跟踪、无偏见的AI搜索引擎,适合需要提升相关任务效率的用户。

下载
  • 通过 enumConstant.getDeclaringClass() 获取所属枚举类
  • 调用 enumConstant.getClass().getDeclaredFields() 不适用——字段不可见;应直接用 enumConstant.getClass().getAnnotation(EnumDesc.class)?错,注解在常量上,不是类上
  • 正确方式:用 enumConstant.getClass().getDeclaredMethod("values") 获取所有常量,遍历比对 ==,再对匹配项调用 getAnnotationsByType(EnumDesc.class)
  • 更高效做法:缓存每个枚举类的「常量→描述」映射,首次加载时反射扫描一次,后续直接查 Map

集成到统一响应体

在 Spring Boot 的 @ControllerAdvice 或自定义序列化器(如 Jackson 的 SimpleModule)中注入该逻辑:

  • 当响应对象含枚举字段时,不直接序列化 enum.name(),而是调用上述工具方法获取描述
  • 配合 @JsonSerialize 自定义序列化器,让所有枚举类型默认走描述逻辑
  • 若用 Lombok,可配合 @JsonValue 注解在枚举中统一加一个 getter,内部调用反射工具

避免常见陷阱

反射读枚举描述看似简单,但容易踩坑:

  • 不要在枚举构造器里调用反射——类加载阶段可能未就绪
  • 注意枚举类被代理(如 AOP 增强)后,getClass() 返回的是 CGLIB 类,需用 getSuperclass() 回溯
  • 多模块项目中,确保注解类和工具类在相同类加载器下,否则 instanceof 或反射查找会失败
  • 单元测试时,若用 Mockito.mock() 枚举,反射将失效——应直接用真实枚举实例测试
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10677

6

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

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

2023.07.05

7802

9

java自学难吗
java自学难吗

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

2023.07.31

6772

8

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

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

2023.08.01

1144

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1396

5

java有什么用
java有什么用

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

2023.08.02

2809

5

java在线网站
java在线网站

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

2023.08.03

20111

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1235

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习