Maven 基础之依赖管理、范围、传递、冲突

news2024/10/7 8:31:25

祖传图片镇楼

文章目录

- 关于依赖管理
- - 坐标和 mvnrepository 网站
  - pom.xml 中"引"包
- 依赖范围
- 依赖传递
- 依赖冲突

关于依赖管理

坐标和 mvnrepository 网站

在 maven 中通过『坐标』概念来确定一个唯一确定的 jar 包。坐标的组成部分有：

元素	说明
<groupId>	定义当前 Maven 组织名称
<artifactId>	定义实际项目名称
<version>	定义当前项目的当前版本

[✔] 注意
任意两个不同包，它们的这三个属性必定至少有一项是不同的。即，三者的「组合」必须唯一。

那么如何确定一个 java 包的坐标？通过 https://mvnrepository.com 。

mvnrepository 是一个与中央仓库对应的查询系统。在这里你可以查询你所需要的 java 包的坐标。

你只需要复制粘贴你所查到的 java 包的坐标 <repository> 片段即可。

pom.xml 中"引"包

「依赖管理」就是对项目中 jar 包的管理。可以在 pom.xml 文件中定义 jar 包的坐标，管理依赖。

整体结构（其它无关元素略）：

project 
└── dependencies
    ├── dependency
    ├── dependency
    ├── ...
    └── dependency

例如：

<dependencies>
		<!--slf4j-api-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.25</version>
    </dependency>
		<!--slf4j-simple-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-simple</artifactId>
        <version>1.7.25</version>
    </dependency>

    <dependency> ... </dependency>  
    <dependency> ... </dependency>  
    <dependency> ... </dependency>  

</dependencies>

maven 项目会「引用」你本地仓库中的这些 java 包。理论上，你的本地仓库「应该有」这些包，如果没有，maven 会先从网络仓库中下载它们。如果网络仓库也没有，那么 maven 会报错。

这些 java 库在本地仓库的存放的路径规则是：

%homepath%/.m2/repository/<groupId>/<artifactId>/<version>

例如，上面的 slf4j-api 在本地仓库中的存放路径就是

C:\Users\hello world\.m2\repository\org\slf4j\slf4j-api\1.7.25

[✔] 注意
需要注意的是，maven 项目是在「引用」这些 java 库。在项目最终打包前，你的 maven 项目中并没有真正地「包含」这些 java 包，你会发现无论你「引用」多少 java 包，你的项目源码的文件夹大小实际上并没有增加（其中只有你的项目源码）。maven 就是通过这种方式来节约空间。

依赖范围

依赖范围（Scope）	对 main classpath 有效	对 test classpath 有效	打入包中	例子
compile	Yes	Yes	Yes	log4j
test	-	Yes	-	junit
privided	Yes	Yes	-	servlet-api
runtime	-	-	Yes	jdbc 驱动实现类

使用技巧：

compile 是 <scope> 的默认值；
错将 runtime 写成 compile ，对项目无影响；
错将 test 写成 compile ，对项目无太大影响。不影响项目运行，仅仅是项目的 jar/war 包会变大；
唯一需要仔细思考、分辨的是 provided 。如果 provided 被误写成了 compile 会导致项目发布运行时因为包冲突而无法运行，或出现 bug 。

[!attention] 注意
你需要留意、甚至记忆哪些包应该是 provided 的。

依赖传递

<dependencies>

  <!--
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
  </dependency>
  -->

  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.25</version>
  </dependency>

<dependencies>

前面的这个依赖可以将 slf4j-api 去掉，也依然可行。原因在于，虽然我们没有声明引用、使用 lslf4j-api ，但是我们声明要引用、使用的 slf4j-simple 它要使用 slf4j-api ，因此，maven 仍然还是会把 slf4j-api 纳入我们的项目中。

[?] 我们如何知道 slf4j-simple 它会使用 slf4j-api ？

有两种方式：

在 mvnrepository.com 中查询 slf4j-simple 时，该网站上会列出它所依赖的其它的包（如果有的话）。
开发工具会有图形化界面让你能看到包的依赖关系，你可以直观地看到，slf4j-simple 依赖于 slf4j-api 。这样你可以对你的 repositories 进行优化。

依赖冲突

依赖冲突指的是你的项目中「包含了同一个包的两个不同版本」。这种情况下通常会导致项目报错，或启动失败。

依赖冲突常见于两个场景：

同一个项目的两个开发人员不约而同想到使用同一个 java 库，而互相不知道。从而导致项目的 pom 中引入了同一个包的两个不同版本。
项目依赖于 A 和 B 两个库，看似没有问题，但是 B 库本身又依赖于 A 库（或者是，B 库依赖于 C 库，而 C 库依赖于 A 库）。从而导致项目中最终还是包含了 A 库的两个不同版本。

Maven 会自动解决依赖冲突问题，它基于 2 个原则来处理：

路径最近者优先

项目 A 有如下的依赖关系：

A -> B -> C -> X （1.0）

A -> D -> X （2.0）

maven 最终包含的会是 X 库的 2.0 版本。
路径相等，先声明者优先

项目 A 有如下的依赖关系：

A -> B -> Y（1.0）

A -> C -> Y（2.0）

若 pom 文件中 B 的依赖坐标先于 C 进行声明，则最终 Y 的版本为 1.0 。