java脑洞 效率工程利器-代码解析工具 lp-base-export

置顶 已于 2024-08-09 14:44:27 修改
阅读量1.1k 收藏 26
点赞数 22
分类专栏： java脑洞 文章标签： java 开发语言
于 2024-08-09 11:01:27 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wqr503/article/details/141056513
版权

脑洞的由来

开发过程中经常遇到

  1. 将Controller导出成API文档
  2. 将枚举注释导出，用于数据库注释或者API文档注释
  3. 将持久化的DO的注释导出，用于数据库注释
  4. 将错误码导出，用于API文档注释

当前常见解决方案

  1. ctrl + C 和 ctrl + V 大法，武林无敌之技
  2. swagger
  3. apiggs

效率对比

  1. 只要不怕累死，没啥缺点，主要是耗时
  2. 只能针对Controller生成文档，对代码有入侵，而且需要额外开启服务端口，产线禁止
  3. 同样针对Controller生产文档，和swagger相比，apiggs是基于代码解析生成的静态文档，对代码无入侵，而且不需要开启web服务，更安全更简便

介绍 lp-base-export

  1. 支持源码java文件解析，能拿到注释
  2. 支持字节码class文件解析，字节码解析是拿不到注释的
  3. 生成静态文档，无需开启web服务
  4. 对项目无入侵，在项目外通过maven插件或者ant等工具启动任务
  5. 生成文档样式全自定义，通过mvel表达式来解析生成
  6. 能递归获取父类属性
  7. 突破代码解析的最后壁垒（泛型），支持泛型解析后的泛型注入
  8. 能配合lombok（字节码解析支持，源码解析不支持）

版本

日期版本号
2024-08-071.3.0.FINAL
2024-08-071.3.0-SPRING3.FINAL（针对spring3和jdk17的版本）

开始使用

方式一. 通过maven插件使用

1) 引入maven插件
<plugin>
				<groupId>io.github.wqr503</groupId>
				<artifactId>enum-export-plugin</artifactId>
				<version>1.3.0.FINAL</version>
				<configuration>
					<taskList>
						<task>
							<id>enumTask</id>
							<outPutDirection>${project.basedir}/export</outPutDirection>
							<!--                            <classPaths>-->
							<!--                                <classPath>${project.basedir}/target/classes</classPath>-->
							<!--                            </classPaths>-->
							<sourcePath>${project.basedir}/src/main/java</sourcePath>
							<dependencyPaths>
								<dependencyPath>${project.basedir}/target/lib</dependencyPath>
							</dependencyPaths>
							<logLevel>DEBUG</logLevel>
							<logParam>true</logParam>
							<mvlText>
								<![CDATA[
public interface CombinationEnum {
@foreach{entity : entityList}
    // @{entity.typeName}
    String @{entity.name} = "@if{entity.desc != null}@{entity.desc} : @end{}@foreach{data : entity.valueList}@if{data.fieldList.size() > 0}@{data.fieldList[0].value}@end{}@if{data.fieldList.size() <= 0}@{data.ordinal}@end{}:@{data.name}(@if{data.desc != null}@{data.desc}@end{}),@end{}";
@end{}
}
  ]]>
							</mvlText>
						</task>
					</taskList>
				</configuration>
			</plugin>

详情可看另一篇文章：
java脑洞 效率工程利器-代码解析maven插件 enum-export-plugin

方式二. 通过独立项目使用

1) jdk 要求 8+
2) 引入maven
<dependency>
  <groupId>io.github.wqr503</groupId>
  <artifactId>lp-base-export</artifactId>
  <version>1.3.0.FINAL</version>
</dependency>
3) 编写demo
1. 聚合输出，是指所有扫描出来的类聚合输出到一个文件里面，也就是所有扫描出来的类共用一个TableAttribute，TableAttribute中的getAttribute只会获取一次
new Exportor()
                // 输出地址
                .setBaseDir("D:\\lp-base-export\\export")
                // 源码路径地址（和字节码路径地址 二选一）
                //.setSourceJavaPath("D:\\lp-base-export\\src\\main\\java")
                // 字节码路径地址（源码路径地址 二选一）
                .setSourceClassPath("D:\\lp-base-export\\target\\classes")
                // 依赖包路径（可为空，没有依赖包则由于找不到Class则减少了扫描深度）
                .setDependencyPath("D:\\lp-base-export\\target\\lib")
                // 扫描的包路径(可为空)
                .setBasePackage("com.cn.lp.export")
                // 聚合输出的mvel表达式（和CombinationMvlPath 二选一）
//                .setCombinationMvlText(new CombinationMvlTexter() {
//                    @Override
//                    public String getCombinationMvelText() {
//                        return "测试输出:" +
//                                "//@{dto}\n";
//                    }
//                })
                // 聚合输出的mvel文件（和CombinationMvlText 二选一）
                .setCombinationMvlPath(new CombinationPather() {
                    @Override
                    public String getCombinationPath() {
                        return "D:\\lp-base-export\\export\\mvl\\dto.mvl";
                    }
                })
                // 具体输出文件名
                .setOutputCombinationFileName(new CombinationPather() {
                    @Override
                    public String getCombinationPath() {
                        return "EnumConstants.txt";
                    }
                })
                // 编程语言（语法糖解析）
                .setFormatter(LangFormatter.JAVA)
                // 扫描过滤器
                .addFilter(ClassFilterHelper.ofInclude(new Predicate<ScanClassInfo>() {
                    @Override
                    public boolean test(ScanClassInfo scanClassInfo) {
                        return true;
                    }
                }))
                // 构建提供给mvel的属性对象
                .setCreator(new TableAttributeCreator() {
                    @Override
                    public TableAttribute create() {
                        return new TableAttribute() {

                            private List<String> nameList = new ArrayList<>();

                            // 从扫描出来的对象中提取属性
                            @Override
                            public void putAttribute(ScanClassInfo classInfo, TypeFormatter typeFormatter) {
                                nameList.add(classInfo.getClassName());
                            }

                            // 输出给mvel的属性对象
                            @Override
                            public Map<String, Object> getAttribute() {
                                Map<String, Object> map = new HashMap<>();
                                map.put("nameList", nameList);
                                return map;
                            }
                        };
                    }
                })
                // 是否打印参数
                .setLogParam(true)
                // 设置打印等级 ERROR，WARN，INFO，DEBUG，TRACE
                .setLogLevel(Level.INFO)
                .combinationExportAll();

效果如下图：
image.png
image.png

2. 流水输出，是指所有扫描出来的类每个都会新建一个新的TableAttribute，根据TableAttribute中的getAttribute也会生成一个对应的文件，也就是扫描出3个类，就会有3个TableAttribute和3个对应生成的文件
new Exportor()
                // 输出地址
                .setBaseDir("D:\\lp-base-export\\export")
                // 源码路径地址（和字节码路径地址 二选一）
                //.setSourceJavaPath("D:\\lp-base-export\\src\\main\\java")
                // 字节码路径地址（源码路径地址 二选一）
                .setSourceClassPath("D:\\lp-base-export\\target\\classes")
                // 依赖包路径（可为空，没有依赖包则由于找不到Class则减少了扫描深度）
                .setDependencyPath("D:\\lp-base-export\\target\\lib")
                // 扫描的包路径(可为空)
                .setBasePackage("com.cn.lp.export")
                // 流水输出的mvel表达式(和MvlPath 二选一)，可以不同对象对应不同mvel表达式
                .setMvlTexter(new MvlTexter() {
                    @Override
                    public String getMvelText(ScanClassInfo classInfo) {
                        return "测试输出：\n" +
                                "    @{name}\n";
                    }
                })
                // 流水输出的mvel文件(和MvlTexter 二选一)，可以不同对象对应不同mvel文件
//                .setMvlPath(new Pather() {
//                    @Override
//                    public String getPath(ScanClassInfo classInfo) {
//                        return "D:\\lp-base-export\\export\\mvl\\dto.mvl";
//                    }
//                })
                // 流水输出文件名
                .setOutputFileName(new Pather() {
                    @Override
                    public String getPath(ScanClassInfo classInfo) {
                        return classInfo.getClassName().replace(".", "/") + "_Export.txt";
                    }
                })
                // 编程语言（语法糖解析）
                .setFormatter(LangFormatter.JAVA)
                // 扫描过滤器
                .addFilter(ClassFilterHelper.ofInclude(new Predicate<ScanClassInfo>() {
                    @Override
                    public boolean test(ScanClassInfo scanClassInfo) {
                        return true;
                    }
                }))
                // 构建提供给mvel的属性对象
                .setCreator(new TableAttributeCreator() {
                    @Override
                    public TableAttribute create() {
                        return new TableAttribute() {

                            private String name;

                            // 从扫描出来的对象中提取属性
                            @Override
                            public void putAttribute(ScanClassInfo classInfo, TypeFormatter typeFormatter) {
                                name = classInfo.getClassName();
                            }

                            // 输出给mvel的属性对象
                            @Override
                            public Map<String, Object> getAttribute() {
                                Map<String, Object> map = new HashMap<>();
                                map.put("name", name);
                                return map;
                            }
                        };
                    }
                })
                // 是否打印参数
                .setLogParam(true)
                // 设置打印等级 ERROR，WARN，INFO，DEBUG，TRACE
                .setLogLevel(Level.INFO)
                .exportAll();

效果如下图：
image.png
image.png

3. 对象描述

ScanClassInfo 字段描述
字段类型描述
classNameString类名(包含包路径)
simpleNameString文件名
sourceClassSourceClassclass对象
SourceClass 接口描述
字段类型描述
findAnnotation查找注解Optional<SourceAnnotation>
getAnnotationFieldMap获取注解字段 - 只有注解类才有值Map<String, SourceAnnotationField>
getMethodList获取方法列表List<SourceMethod>
getClassLoader获取当前加载的ClassLoaderClassLoader
getClassType获取类信息SourceType
filterSuperClass递归到最深查找是否有该父类Collection<SourceType>
filterInterface递归到最深查找是否有该接口Collection<SourceType>
getEnumValueList获取枚举值List<SourceEnumValue>
getName获取类名String
getDesc获取描述String
getFieldMap获取字段列表Map<String, SourceField>
getAnnotationList获取注解列表List<SourceAnnotation>
SourceType接口描述
字段类型描述
findAnnotation查找注解Optional<SourceAnnotation>
getInterfaceList获取接口列表Collection<SourceType>
getSuperClass获取父类SourceType
isArray是否数组 []boolean
isEnum是否枚举boolean
isFinal是否不可变boolean
isAbstract是否抽象boolean
isAnnotationType是否注解boolean
isInterface是否接口boolean
isHasParameterizedType是否泛型boolean
getClassLoader获取ClassLoaderClassLoader
getActualTypeArgumentMap获取泛型MapMap<String, SourceType>
getTypeName获取类路径（包含包路径）String
getSimpleName获取类名String
getFullName获取包含泛型的名字String
SourceAnnotation接口描述
字段类型描述
getName获取名字String
getFieldMap获取字段列表String
getClassLoader获取ClassLoaderClassLoader
getSourceType获取类信息SourceType
getTypeName获取类路径String
SourceAnnotationField接口描述
字段类型描述
getReturnType获取返回值SourceType
getValue获取值Object
getName获取名字String
getDefaultValue获取默认值Object
getDesc获取描述String
SourceField接口描述
字段类型描述
getModifier获取修饰符String
isVolatile是否volatile修饰boolean
isStatic是否static修饰boolean
isFinal是否final修饰boolean
findAnnotation查找某个注解Optional<SourceAnnotation>
getAnnotationList获取注解列表List<SourceAnnotation>
getFieldType获取字段类型SourceType
getDesc获取描述String
getName获取字段名String
SourceEnumValue接口描述
字段类型描述
getOrdinal获取原序号Integer
getName获取枚举名String
getFieldList获取值列表List<SourceEnumValueField>
getDesc获取描述String
SourceEnumValueField接口描述
字段类型描述
getName获取名字String
getValue获取值Object
SourceParam接口描述
字段类型描述
getAnnotationList获取注解列表List<SourceAnnotation>
getParamType获取类信息SourceType
getName获取入参名String

4. 拓展使用

  1. 配合Ant或者Gradle外部启动lp-base-export程序，分析当前项目代码再生成报告
  2. 封装成maven插件，通过maven插件调用，比如apiggs和enum-export-plugin

结语

起初该项目用于提取代码中枚举的注释然后批量生成接口注释，也可用于提取持久化对象字段的注释批量生成Mysql的字段的注释。最早是用Doclet来解析源码的，然后用ant来启动项目，其实这是相当不方便的，然后最近通过Javaparser来替代Doclet解析源码，减少了项目对jdk的依赖，同时通过提前暴露的思路攻克了泛型注入的问题，使得最后生成的对象更完整和更准确，同时也支持了内部类的解析。项目是独立项目，所以对分析的项目是零入侵，通过maven,gradle,ant等工具拉起项目，最后生成报告到指定目录。该项目我自己一直在使用，如果遇到问题可留言，我会单独联系给你解决。

如果这篇文章对你有帮助请给个star
image.png

wqr503
关注
专栏目录
Java反编译工具JD-GUI
08-24
总之，Java反编译工具JD-GUI是开发者手中的一把利器，它为我们揭示了Java字节码背后的秘密，使我们能够学习和利用已编译的Java库，从而提升开发效率和问题解决能力。然而，使用这些工具时需谨慎，遵守开源社区的规则...
jd-gui最好的JAVA反编译工具
09-17
Java开发过程中，有时我们需要查看已编译的.class文件的源代码，这在原始源代码丢失或需要理解他人代码逻辑时尤为关键。...它不仅简化了反编译过程，还提升了工作效率，使得理解和修改已编译的Java代码变得更加容易。
java代码分析及分析工具
09-04 1375
一个项目从搭建开始，开发的初期往往思路比较清晰，代码也比较清晰。随着时间的推移，业务越来越复杂。代码也就面临着耦合，冗余，甚至杂乱，到最后谁都不敢碰。 作为一个互联网电子商务网站的业务支撑系统，业务复杂不言而喻。从09年开始一直沿用到现在，中间代码经过了多少人的手，留下了多少的坑，已经记不清楚了，谁也说不清了。 代码的维护成本越来越高。代码已经急需做调整和改善。最近项目组专门设立了一个小组，利
java代码架构分析工具_Java代码度量分析工具：DesigniteJava简介
weixin_26798991的博客
02-13 319
Duplicate Abstraction:重复抽象，This smell arises when two or more abstractions have identical names or identical implementation or both.Feature Envy:This smell occurs when a method seems more interested i...
9 个最佳 Java 静态代码分析工具
最新发布
欢迎拜读我的作品，喜欢的领域请给我留言
08-13 2003
使用顶级 Java 静态代码分析工具列表来提高您的代码质量 - 确保您的代码干净、高效且无错误。开发人员如何防止频繁出现应用程序故障？自动化分析可能是答案。Java 静态代码分析工具有助于检测任何问题或，并通过自动化代码审查流程来帮助提高我们将探索一些市场上最好的工具，这些工具可以增强工作流程并创建更强大的代码。什么是静态代码分析？静态代码分析是一种无需执行源代码即可对其进行检查的技术。通过根据编码规则分析代码集，这种高级静态分析工具可以读取代码中的错误并确保其符合标准和最佳实践。
Java中的代码分析工具
weixin_46372265的博客
07-21 947
静态代码分析工具可以在不运行程序的情况下，对源代码进行检查和分析。这些工具通过扫描代码，发现潜在的错误、代码风格问题、性能瓶颈以及安全漏洞等。下面我们来详细介绍几款常用的Java静态代码分析工具。在这个快速发展的技术时代，保持高质量的代码不仅仅是为了提高程序的可靠性，更是为了确保软件的安全性和可维护性。通过使用如SonarQube、PMD、Checkstyle等静态代码分析工具，我们可以在开发的早期阶段发现和解决潜在问题，从而节省后期的维护成本。
java常用代码分析工具
iqbon的烂笔头
02-20 141
静态检查工具CheckStyle、PMD、FindBugs 重复代码检查PMD-CPD、Simian 圈复杂度分析工具SourceMonitor、JavaNCSS 代码设计质量分析JDepend
最快速的java代码生成器 rapid-generator
06-06
"最快速的Java代码生成器 Rapid-Generator"是一款专为Java开发者设计的高效工具，旨在提升开发效率，减少手动编写重复代码的工作量。这款工具以其快速、灵活和强大的自定义能力在Java开发社区中受到广泛关注。 ...
Android 反编译工具 jadx-gui （APP备案利器）
10-27
**Android 反编译工具 jadx-gui：APP备案利器** 在Android应用开发和安全分析领域，反编译工具起着至关重要的作用。其中，jadx-gui是一款强大的Android反编译器，它允许开发者和安全研究人员对APK文件进行逆向工程...
bootstrap-table-export.js和tableExport.js
11-02
总的来说，“bootstrap-table-export.js”和“tableExport.js”是增强Bootstrap表格功能的利器，它们简化了数据导出的过程，提高了用户体验，同时也为开发者提供了更灵活的控制选项。在处理大量数据并需要导出功能的...
java源码工具-java-plugin-javaParser:java源代码检测工具
05-19
java 源码工具
JAVA源代码分析工具比较
09-27
介绍了静态代码分析的基本概念及主要技术，随后分别介绍了现有 4 种主流 Java 静态代码分析工具 (Checkstyle，FindBugs，PMD，Jtest)，最后从功能、特性等方面对它们进行分析和比较。
直接看java源码的工具
04-28
直接将class或者jar包资源拖入工具，就可以反编译看源码了.
Java源代码解释器
01-21
一个java的辅助工具,旨在编写java时,能适时的解释代码段作用.
4 种主流 Java 静态代码分析工具
05-27
java静态代码分析工具包括Checkstyle，FindBugs，PMD，Jtest
java 代码解析工具_改善 Java 代码质量的工具与方法
weixin_39694174的博客
02-27 183
原标题：改善 Java 代码质量的工具与方法 我们可能见过上面的有关代码质量的图片，究竟如何衡量一段代码好坏？代码质量是什么？为什么它很重要？作家通过他的著作来讲述了一个清晰的、令人信服的故事。他们使用章节、标题和段落等工具来清晰地组织他们的思想，并轻松地引导读者。开发者的工作与作家类似，只是使用不同术语如命名空间、类和方法。如果创作者不能有效地使用他们的工具，那么无论他们的作品是书还是代码，读者...
java脑洞 效率工程利器-代码解析maven插件 enum-export-plugin
08-09 327
java脑洞 效率工程利器-代码解析maven插件 enum-export-plugin
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值