Maven之依赖
最近一年做项目时,一直在与Maven打交道,在网上也看了很多的博客,也看了《Maven实战》这本书,感觉受益匪浅,但是过一段时间很多东西也会忘记,所以就想根据这本书上看到的,还有自己的经验,写几篇Maven的博客来梳理一下核心点。
依赖配置
一个依赖包的声明主要包括以下的一些元素:
1 | <project> |
先简单介绍一下上面这几个元素的意义:
- groupId、artifactId和version:依赖的基本坐标(这个本文就不在讲解了);
- type:依赖的类型,对应于项目坐标定义的
packaging
,一般情况下,该元素不用声明,默认为jar
; - scope:依赖的范围;
- optional:标记依赖是否可选;
- exclusions:用来排除传递性依赖。
依赖范围
Maven依赖的依赖范围有一下几类,分别是:compile
、test
、provided
、runtime
、system
和import
。
之所以Maven会有这么多依赖范围,主要原因是:Maven在编译项目主代码的时候需要使用一套classpath;Maven在编译和执行测试的时候会使用另外一套classpath;Maven实际运行项目的时候,又会使用一套classpath。依赖范围就是用来控制依赖与这三种classpath的关系。
- compile:编译依赖范围(默认值),对编译、测试、运行三种classpath都有效;
- test:测试依赖范围,只对测试classpath有效;
- provided:已提供依赖范围,对编译和测试classpath有效;
- runtime:运行时依赖范围,对测试和运行classpath有效;
- system:系统依赖范围,以provided依赖范围一致,但使用
system
范围时必须通过systemPath
元素显示地制定依赖文件的路径; - import:导入依赖范围,该依赖不会对三种classpath产生实际影响。
使用system
的例子如下:
1 | <dependency> |
用表格的形式表示以上依赖如下所示:
scope | 对编译有效 | 对测试有效 | 对运行有效 |
---|---|---|---|
compile | Y | Y | Y |
test | - | Y | - |
provided | Y | Y | - |
runtime | - | Y | Y |
system | Y | Y | - |
传递性依赖
传递性依赖:比如一个项目account-email
有一个compile范围的spring-core
依赖,而spring-core
有一个compile范围的commons-logging
的依赖,那么commons-logging
就会成为account-email
的compile范围依赖,commons-logging
是account-email
的一个传递性依赖。
有个传递性依赖机制,在使用account-email
的时候就不用去考虑它依赖了什么。明白了传递性依赖,下面就看一下传递性依赖和依赖范围的关系,假设A依赖于B,B依赖于C,我们说A对于B是第一直接依赖范围,B对于C是第二依赖范围,A对于C是传递性依赖。第一直接依赖的范围和第二直接依赖的范围决定了传递性依赖的范围,如下表所示,最左边一列表示第一直接依赖,最上面一行表示第二直接依赖范围,中间的结果就表示传递性依赖范围。
依赖范围 | compile | test | provided | runtime |
---|---|---|---|---|
compile | compile | —— | —— | runtime |
test | test | —— | —— | test |
provided | provided | —— | provided | provided |
runtime | runtime | —— | —— | runtime |
仔细观察上表,我们可以得到以下结论:
- 当第二直接依赖的范围是
compile
的时候,传递性依赖的范围与第一直接依赖的范围一致; - 当第二直接依赖的范围是
test
的时候,依赖不会得以传递; - 当第二直接依赖的范围是
provided
的时候,只传递第一直接依赖范围也为provided
的依赖,且传递性依赖的范围同样为provided
; - 当第二直接依赖的范围是
runtime
的时候,传递性依赖的范围与第一依赖的范围一致,但compile
例外,此时传递性依赖的范围为runtime
。
依赖调解
假如项目A有这样的依赖的关系:A->B->C->X(1.0),A->D->X(2.0),X是A的传递性依赖,但是有两条路径,那么应该选择哪个版本呢?
Maven依赖调解(Dependency Mediation)有两个原则:
- 路径最近者优先;
- 第一声明者优先(路径相等的前提下,在POM中依赖声明的顺序决定了谁会被解析使用);
可选依赖
假设有这样一个依赖关系,项目A依赖与项目B,项目B依赖于项目X和Y,B对于X和Y的依赖都是可选依赖:A->B、B->X(可选)、B->Y(可选),那么X、Y就是A的传递性依赖。然而,由于这里X、Y是可选依赖,依赖将不会得以传递。
下面是设置可选依赖的一个例子:
1 | <dependency> |
一般情况下,不应该使用可选依赖,使用可选依赖的原因是某一个项目实现了多个特性,在面向对象设计中,有个单一职责性原则,意指一个类应该只有一项职责,而不应该糅合太多的功能。当项目需要某个依赖的可选依赖,可以显式地声明这一依赖。
排除依赖
有时候会出现这样的情况,你的Hibernate
依赖于Sun JTA API
,但是因为版权原因,Sun JTA API
并不在仓库中。而Apache Geronimo
项目有一个对应的实现。这时你就可以排除Sun JAT API
,再声明Geronimo
的JTA API
实现,见代码清单:
1 | <dependency> |
上述代码中,项目A依赖于项目B,但是由于一些原因,不想引入传递性依赖C,而是自己显示声明对于项目C1.0.0版本的依赖。代码中用exclusions元素可以包含多个exclusion子元素。需要注意的是声明exslusion的时候只需要groupId和artifactId,而不需要version元素(Maven解析后的依赖中,不可能出现groupId和artifactId相同,但是version不同的两个依赖)。
归类依赖
当我们使用Spring Framework
的依赖时,会有许多依赖,如:spring-core:2.5.6.org
、org.springframework:spring-beans:2.5.6
等,它们是来自同一项目下的不同模块。它们依赖的版本都是相同时,当需要升级Spring Framework
时,这些依赖的版本都会一起升级。这时候我们可以用Maven属性的方式来定义一个名为springframework.version
的属性,让所有的spring framework
子模块都引用它。
1 |
|
这样当我们需要升级的时候,就只需要改属性值springframework.version
就可以了。
优化依赖
- 使用
mvn dependency:list
命令可以查看项目已解析的依赖; - 使用
mvn dependency:tree
命令可以查看项目构成的依赖树; - 使用
mvn dependency:analyze
命令可以分析当前项目的依赖.
参考:
公众号
个人公众号(柳年思水)已经上线,最新文章会同步在公众号发布,欢迎大家关注~