👨🎓作者：bug菌
✏️博客：CSDN、掘金、infoQ、51CTO等
🎉简介：CSDN|阿里云|华为云|51CTO等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，掘金 | InfoQ | 51CTO等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。...
✍️温馨提醒：本文字数：1999字, 阅读完需：约 5 分钟
🏆本文收录于《Spring Boot从入门到精通》，专门攻坚指数提升。
本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中…欢迎大家订阅持续学习。
环境说明：Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE
1. 前言
近日bug菌在奋力赶项目，都是日常的接口逻辑实现，论复杂与否，也就论自己是否理解了业务，理解了其实写起来就顺。
但是论前端有个不想接的活儿，她不想写死表列名，原本返回给她的数据结构是一个对象，key自然是字段名，value为具体的值，比如{"id":"1","name":"张三"},然后需求是要展示一张中文列名的表格，但是给后端而言，这无非是在增加工作量，我本来数据直接从数据库查询而来，这样，我还得替他插入中文注释。
于是，活从天上来，谁让我是男生呢，那我就想办法给她实现一下吧，照顾一下女孩子，我仔细一下，我是采用对象来接收的，swagger能将对于的字段名 展示中文注释，于是，我的灵感从这里而来。
需求就是要将字段名对于的中文注释一并返回，比如返回格式：
需求前可得知：
{
"id":"1",
"name":"张三",
"age":18
}
需求后：
{
"value":"1",
"name":"序号"
},
{
"value":"张三",
"name":"姓名"
},
{
"value":18,
"name":"年龄"
}
如果这个需求给你，你是否能有好的建议或者办法快速实现？
2. 正文
这里我是想到了一点，大家请看，我们为了给swagger接口文档方便调用时能更直观看到每个字段代表啥，会添加@ApiModelProperty注解，给value属性添加中文注释。
所以，我们要实现这个需求，那我们便可以从这里出发，我们先获取数据，由于获取到的是一个对象，那我们便将对象通过强转成map集合，具体结构展示如下：
{
"id":"1",
"name":"张三",
"age":18
}
可以通过这种方法快速将对象转成map：
BeanMap map = BeanMap.create(Object);
然后我们就还需要做一件事，将key所对应的中文注释也一定转成map的形式，这样我们就可以通过key对比，来一一获取对应的中文注释了。
所以重点来了，怎么获取将字段名跟对应的中文注释获取到呢，比如如下格式：
{
"create_time":"创建时间",
"creator":"创建人",
"update_time":"修改时间",
"updator":"修改人"
}
我们就想到了，可以通过java反射，获取该类BaseEntity上的@ApiModelProperty注解的所有属性！这样我们再通过map给存放起来返回，这样不就获取到了！Good idea！我们来实现一下
3. 代码实现🔥
接下来，我来展示下我的实现方式，仅供参考，如果有更好的方式实现，那么请一定要告诉bug菌，一起学习一起进步。
/**
* 通过反射获取指定类@ApiModelProperty注解修饰的name值跟value值
*/
public static LinkedHashMap getApiModelProperty(String classPath) {
//定义一个可顺序集合存放
LinkedHashMap res = new LinkedHashMap();
try {
// 1.根据类路径获取类
Class<?> c = Class.forName(classPath);
// 2.获取类的属性
Field[] declaredFields = c.getDeclaredFields();
// 3.遍历属性，获取属性上ApiModelProperty的值，属性的名，存入res
if (declaredFields.length != 0) {
for (Field field : declaredFields) {
if (field.getAnnotation(ApiModelProperty.class) != null) {
// 这存的key为注解的[name]类属性名，value为注解的[value]值
res.put(field.getName(), field.getAnnotation(ApiModelProperty.class).value());
}
}
return res;
}
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
return null;
}
获取获取指定类，你也可以这样写：但是这样就不是很灵活了，这种指定类写法。
Class<BaseEntity> aClass = BaseEntity.class;
Field[] declaredFields = aClass.getDeclaredFields();
其中，我来解释一下：我们通过遍历拿到field对象，我们可以对其进行属性获取，就这样写：field.getAnnotation(ApiModelProperty.class)，然后再点，就可以拿到该注解的所有属性了，比如获取value，可以调用value()方法等。
注释我写的很详细，其实这也是通过方法，我们也可以将该注解@ApiModelProperty换成其他的，都是一样的获取注解属性值，所以你们可以举一反三。比如我换成@TableField注解。
然后写法就直接改成这样即可。
最后，我们来写个main方法调用一下，测试一下，结果是否拿到了。
public static void main(String[] args) {
LinkedHashMap apiModelProperty = AopUtils.getApiModelProperty("com.example.demo.entity.BaseEntity");
System.out.println(apiModelProperty);
}
具体控制台打印请看如下：
是不是成功了？哈哈，非常流批哦，最后，我们只需要遍历这两个map即可，根据key找到另一个map中的中文注释，这不是超级简单，我就不一一实现了，你们可以试着自己实现一下。
... ...
ok，以上就是我这期的全部内容啦，如果还想学习更多，你可以看看如下的往期热文推荐哦，每天积累一个奇淫小知识，日积月累下去，你一定能成为令人敬仰的大佬。
「赠人玫瑰，手留余香」，咱们下期拜拜~~
4. 热文推荐💭
为了便于同学快速定位文章学习，熬夜几天终于整理出了【基础篇】及【进阶篇】专栏的文章及有效地址，同学们敬请吩咐bug菌吧。
目前基础篇已完结75篇+，进阶篇已完结45篇+，两专栏都在持续更新中；生命不息，更新不止，加油卷起来吧，同学们。部分文章总结如下：
4.1 Spring Boot【基础篇】
Spring Boot入门(01)：Spring Boot的奋斗成长史
Spring Boot入门(02)：快速开发环境搭建和项目启动
Spring Boot入门(03)： yaml、properties配置文件介绍及使用
Spring Boot入门(06)：Spring Boot常用注解大全
Spring Boot入门(07)：整合 MySQL 和 Druid数据源(两万字教学)
Spring Boot入门(08)：整合Mybatis访问MySQL实现增删改查
Spring Boot入门(09)：使用MyBatis的XML配置方式访问MySQL实现增删改查
Spring Boot入门(10)： mybatis之xml映射文件＞、＜=等特殊符号写法
Spring Boot入门(11)：Spring Boot 整合 JPA
Spring Boot入门(12)：整合Mybatis-Plus mybatis-plus实现接口增删改查
Spring Boot入门(13)： Mybatis-Plus之条件构造器使用手册
Spring Boot入门(14)： mybatis-plus之如何自定义sql
Spring Boot入门(15)：Spring Boot 整合 MyBatis-Plus AutoGenerator 自动生成项目骨架代码
Spring Boot入门(16)：Spring Boot整合Swagger-UI实现在线API文档
Spring Boot入门(17)：Spring Boot整合Knife4j，美化强化丑陋的Swagger
Spring Boot入门(18)：Spring Boot静态资源映射
Spring Boot入门(19)：Spring Boot 整合 Thymeleaf 模板引擎，开发Web页面
Spring Boot入门(20)：实现多数据源配置，开箱即用
Spring Boot入门(21)：整合Log4j2以及配置详解
Spring Boot入门(22)：整合LogBack 实现日志文件本地保存
Spring Boot入门(23)：Spring Boot基于AOP拦截日志
Spring Boot入门(24)：Spring Boot事务
Spring Boot入门(25)：过滤器、拦截器、监听器对比及使用场景
Spring Boot入门(26)：实现邮件发送简单邮件、附件邮件、嵌入资源(图片)邮件、模板邮件等
Spring Boot入门(30)：Windows安装Redis客户端？你玩过么
4.2 Spring Boot【进阶篇】
Spring Boot进阶(01)：Spring Boot 集成 Redis，实现缓存自由
Spring Boot进阶(02)：使用Validation进行参数校验
Spring Boot进阶(03)：如何使用MyBatis-Plus实现字段的自动填充
Spring Boot进阶(04)：如何使用MyBatis-Plus快速实现自定义sql分页
Spring Boot进阶(05)：Spring Boot 整合RabbitMq，实现消息队列服务
Spring Boot进阶(06)：Windows10系统搭建 RabbitMq Server 服务端
Spring Boot进阶(07)：集成EasyPoi，实现Excel/Word的导入导出
Spring Boot进阶(08)：集成EasyPoi，实现Excel/Word携带图片导出
Spring Boot进阶(09)：集成EasyPoi，实现Excel文件多sheet导入导出
Spring Boot进阶(10)：集成EasyPoi，实现Excel模板导出成PDF文件
Spring Boot进阶(11)：Spring Boot 如何实现纯文本转成.csv格式文件？
Spring Boot进阶(12)：Spring Boot 如何获取Excel sheet页的数量？
Spring Boot进阶(13)：Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值？
Spring Boot进阶(14)：Spring Boot 如何手动连接库并获取指定表结构？一文教会你
Spring Boot进阶(15)：根据数据库连接信息指定分页查询表结构信息
Spring Boot进阶(16)：Spring Boot 如何通过Redis实现手机号验证码功能？
Spring Boot进阶(17)：Spring Boot如何在swagger2中配置header请求头等参数信息
Spring Boot进阶(18)：SpringBoot如何使用@Scheduled创建定时任务？
Spring Boot进阶(19)：Spring Boot 整合ElasticSearch
Spring Boot进阶(21)：配置Undertow容器
Spring Boot进阶(22)：Tomcat与Undertow容器性能对比分析
Spring Boot进阶(24)：如何快速实现多文件上传？
Spring Boot进阶(25)：文件上传的单元测试怎么写?
Spring Boot进阶(26)：Mybatis 中 resultType、resultMap详解及实战教学
Spring Boot进阶(27)：Spring Boot 整合 kafka(环境搭建+演示)
Spring Boot进阶(28)：Jar包Linux后台启动部署及滚动日志查看，日志输出至实体文件保存
Spring Boot进阶(29)：如何正确使用@PathVariable，@RequestParam、@RequestBody等注解？不会我教你，结合Postman演示
Spring Boot进阶(30)：@RestController和@Controller 注解使用区别，实战演示
...
若想学习更多，可以参考这篇专栏总结《2023最新首发，全网最全 Spring Boot 学习宝典(附思维导图)》，本专栏致力打造最硬核 Spring Boot 进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中。欢迎大家订阅持续学习。
在入门及进阶之途，我必助你一臂之力，系统性学习，从入门到精通，带你不走弯路，直奔终点；投资自己，永远性价比最高，都这么说了，你还不赶紧来学？？
5. 文末💭
我是bug菌，CSDN | 阿里云 | 华为云 | 51CTO 等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，掘金 | InfoQ | 51CTO等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。
