Maven包冲突的原理及解决方法

4,550 阅读3分钟

1.概述

\quad Apache Maven,是一个软件(特别是Java软件)项目管理及自动构建工具。在没有Maven的上古年代,项目中引入jar包需要手动下载一个个的去下载,但是随着代码数量的增加,引入的jar包数量自然会增加,随之而来的就是jar包冲突的问题了。

2.产生jar包冲突的原因

\quad 众所周知,一个项目中不能存在两个全限定类名一致的Class类,并且jar包的本质就是打包好的Class类文件,例如: 将junit-jupiter-api-5.6.2.jar文件解压后,

可以得到多个Class文件,所以项目中同样不能存在两个名称项目的jar包。

\quad 与此同时,jar包之间也会存在相互依赖,就拿这个junit-jupiter-api-5.6.2.jar举例: pom坐标为:

<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-api</artifactId>
    <version>5.6.2</version>
    <scope>test</scope>
</dependency>

那么可以在maven中央仓库找到该jar包的详细信息,地址: https://repo1.maven.org/maven2/org/junit/jupiter/junit-jupiter-api/5.6.2/

打开.pom文件可以看到该jar包还引用了哪些其他jar包,如下图所示: \quad 当然我们可以通过IDEAL及maven工具查看完整的依赖树:

或者将依赖树信息导出到本地:

 mvn dependency:tree > a.txt

如下图所示:

\quad 所以说,随着我们项目的逐渐庞大,所引入的jar包文件逐渐增多,产生包冲突的可能性也会越来越大,我们不可能都用肉眼去查找项目中的包冲突问题。当然我们可以通过一些工具插件帮助我们查找项目中的jar包冲突,比如说Maven Helper

3.引入插件解决冲突

以这个项目为例:

依赖关系图如下:

我们知道,当两个jar包产生冲突时,取舍原则是谁离的项目近选择谁,所以spring-web最终会选择5.1.8版本的。从启动命令中中的CLASSPATH中也可以看出:

"D:\software\IDEA IU\IntelliJ IDEA 2019.3\jbr\bin\java.exe" "-javaagent:D:\software\IDEA IU\IntelliJ IDEA 2019.3\lib\idea_rt.jar=50098:D:\software\IDEA IU\IntelliJ IDEA 2019.3\bin" -Dfile.encoding=UTF-8 -classpath D:\GitHub_Item\resolve-package-conflict\target\classes;
C:\Users\DELL\.m2\repository\org\springframework\spring-web\5.1.8.RELEASE\spring-web-5.1.8.RELEASE.jar;
C:\Users\DELL\.m2\repository\org\springframework\spring-beans\5.1.8.RELEASE\spring-beans-5.1.8.RELEASE.jar;
C:\Users\DELL\.m2\repository\org\springframework\spring-core\5.1.8.RELEASE\spring-core-5.1.8.RELEASE.jar;
C:\Users\DELL\.m2\repository\org\springframework\spring-jcl\5.1.8.RELEASE\spring-jcl-5.1.8.RELEASE.jar;
C:\Users\DELL\.m2\repository\com\github\hcsp\test-library-a\0.4\test-library-a-0.4.jar Main

ps:pom.xml中添加的依赖,Maven会将其缓存到本地的.m2仓库中,并将其加到CLASSPATH中
使用Maven Helper插件分析: 根据自己的需要,选择要排除的版本:

插件就会帮我们在pom.xml文件中,排除掉产生冲突的引入:

点击Reimport按钮,就可以看到冲突已经解决了。

4.引深学习

4.1 <scope>test</scope><scope>compile</scope>的区别?

\quad 对于test而言,表示该依赖只作用于测试类中,也就是src/main/test路径下,在其他路径中,编译器是不会引入该依赖的。对于compile则没有限制,在src/main/java于src/mian/test中均可用。

4.2 <scope>provided</scope>表示什么?

举例说明:

    public static void main(String[] args) throws IOException {
        Workbook workbook = new HSSFWorkbook(new FileInputStream("C:\\Users\\DELL\\Desktop\\new.xlsx"));
    }

pom.xml中引入必要的依赖:

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
            <version>4.1.2</version>
            <scope>provided</scope>
        </dependency>

但是在点击运行的时候,就是会报出:

Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/poi/hssf/usermodel/HSSFWorkbook
	at Main.main(Main.java:10)
Caused by: java.lang.ClassNotFoundException: org.apache.poi.hssf.usermodel.HSSFWorkbook
	at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:581)
	at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:178)
	at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:521)
	... 1 more

类没有找到的问题,原因在于设置<scope>provided</scope>则表示该依赖只在编译时的CLASSPATH中,在运行时则不将该依赖加入CLASSPATH中。一般用于运行环境已经将CLASSPATH设置好,不需要额外添加的情况,比如Tomcat。

5.好书分享