乐趣区

Maven项目分析剔除无用jar引用

jiezi

一、为什么要做这件事？
项目持续研发，不停地在上面新增功能，新增特性，引入新的框架和组件，jar 包依赖多并且复杂，再加上需求各种变更，有不少已经存在的功能下线，但 jar 包依赖没人管，还是放在项目的 pom.xml 文件里。项目持续的时间一长，经常会出现项目打包要求内存多，时间慢的问题，如何分析项目中哪些依赖是有用的，哪些可以剔除的，一方面减轻打包内存占用多，时间慢的问题，另一方面照顾研发童鞋的强迫症问题（容不得半点无用 jar 包在我的项目里），这事就可以提上日程了。

二、怎么做？
如果是 Maven 项目，执行起来还是比较简单，Maven 自己提供了一个检测工具，输入命令即可。
在 IDEA 中，切换到 Terminal 窗口，或者用命令行打开相应工程目录，直接输入

mvn dependency:analyze

查看控制台输出的日志，重点关注这两部分：

[WARNING] Used undeclared dependencies found:
[WARNING]    com.fasterxml.jackson.core:jackson-annotations:jar:2.9.0:compile
[WARNING]    com.fasterxml.jackson.core:jackson-databind:jar:2.9.9:compile
[WARNING]    io.jsonwebtoken:jjwt:jar:0.9.0:compile
[WARNING]    org.apache.rocketmq:rocketmq-common:jar:4.5.2:compile
[WARNING]    org.springframework:spring-beans:jar:5.1.8.RELEASE:compile
[WARNING]    com.google.code.gson:gson:jar:2.8.0:compile
[WARNING]    org.springframework.boot:spring-boot:jar:2.1.6.RELEASE:compile
[WARNING]    com.fasterxml.jackson.core:jackson-core:jar:2.9.9:compile
[WARNING]    org.springframework:spring-core:jar:5.1.8.RELEASE:compile
[WARNING]    org.apache.rocketmq:rocketmq-remoting:jar:4.5.2:compile
[WARNING] Unused declared dependencies found:
[WARNING]    org.projectlombok:lombok:jar:1.16.20:provided
[WARNING]    org.springframework.boot:spring-boot-starter-test:jar:2.1.6.RELEASE:test
Used undeclared dependencies found

间接依赖，就是说你在当前项目工程的 pom.xml 里没有直接声明，这个依赖是由你声明过的 dependency 里的 pom.xml 依赖传递得来的。
例如 org.apache.rocketmq:rocketmq-common:jar:4.5.2:compile 是你引用了这个：

<dependency>
    <groupId>org.apache.rocketmq</groupId>
    <artifactId>rocketmq-client</artifactId>
    <version>4.5.2</version>
</dependency>

Maven 本来就是这样用的，也不建议说你把这部分引用拷贝到你的 pom.xml 里，一般来说这部分的 WARNING 可以忽略。

Unused declared dependencies found

无用依赖，这个指我们在 pom.xml 声明了这个 jar 包的依赖，但在项目工程里没有使用到，这个不是我们此次关注的重点，确定不需要，就可以剔除掉这个依赖，Reimport 后这个 jar 包就从我们项目中剔掉了。

三、什么时候做？
1）新项目建立时，引用 jar 包时要慎重，不要一股脑儿直接拷贝老项目的依赖，避免后期又花时间来剔除。
2）功能代码重构时，可以适当做一次剔除，因为后面还有自测，提交测试环节，如果有误删，测试的时候能发现。

四、有什么风险要注意的？
1）这个检测的结果仅供参考，有时也不准确，如上文提及的 org.projectlombok:lombok:jar:1.16.20:provided，实际上在项目中有使用到它的注解 @Data，这个属于误判。要注意剔除依赖后多测试，工具毕竟有毕竟的缺陷性。
2）如果童鞋们接手遗留的老项目时，这种问题肯定很多，但刚接手时不建议做这个操作，因为本身对项目不熟悉，上来就删东西导致问题会浪费很多时间和精力搞定依赖的问题，这块东西建议暂时先不要动。

五、补充一个小插件
查看 pom.xml 的依赖关系时，可以在 IDEA 上安装 maven help 插件，可以直观地看到各 jar 依赖关系

专注 Java 高并发、分布式架构，更多技术干货分享与心得，请关注公众号

退出移动版