Maven用户都应该知道的一些事:关于依赖的常见问题

依赖范围(scope)不同选项的区别

依赖范围参数的作用是控制依赖在不同阶段与classpath的关系,具体区别如下图所示。

依赖范围图

表中没有列出的值是import,这个选项是用于引入dependencyManagement,下文会有介绍。

依赖调解,调解同一依赖的不同版本

假设你的项目有如下的依赖树

POM
|-- A
|   `-- B 1.0
|-- C
|   `-- D
|       `-- B 2.0
`-- E
    `-- B 3.0

POM同时依赖了B的1.0和2.0版本,可Maven是不会重复引入相同坐标的依赖的,那么究竟哪个版本会生效呢?

Maven对于依赖的调解遵循两个基本原则:

  • 1 依赖路径长度短者优先;
  • 2 如果依赖路径长度相同,则后声明优先。

所以根据1,2.0版本被排除,根据2,3.0版本被实际引入。

如果你自己明确知道该引入哪个版本的B,那么直接在POM中声明B依赖就好了,因为这时的依赖路径是最短了。

可选依赖(optional)含义

可选依赖的作用就是声明该依赖不被传递依赖。

POM
`-- A
   `-- B(optional)

这里B不会被引入。

Super POM(Project Object Model)

Super POM是Maven自带的全局POM文件,所有的POM文件都默认继承了Super POM。其中定义了各种默认配置,以简化POM文件的编写。下面是Maven 3.5.4的Super POM的核心部分。

<project>
  <modelVersion>4.0.0</modelVersion>
 
  <repositories>
    <repository>
      <id>central</id>
      <name>Central Repository</name>
      <url>https://repo.maven.apache.org/maven2</url>
      <layout>default</layout>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
  </repositories>
 
  <pluginRepositories>
    <pluginRepository>
      <id>central</id>
      <name>Central Repository</name>
      <url>https://repo.maven.apache.org/maven2</url>
      <layout>default</layout>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
      <releases>
        <updatePolicy>never</updatePolicy>
      </releases>
    </pluginRepository>
  </pluginRepositories>
 
  <build>
    <directory>${project.basedir}/target</directory>
    <outputDirectory>${project.build.directory}/classes</outputDirectory>
    <finalName>${project.artifactId}-${project.version}</finalName>
    <testOutputDirectory>${project.build.directory}/test-classes</testOutputDirectory>
    <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
    <scriptSourceDirectory>${project.basedir}/src/main/scripts</scriptSourceDirectory>
    <testSourceDirectory>${project.basedir}/src/test/java</testSourceDirectory>
    <resources>
      <resource>
        <directory>${project.basedir}/src/main/resources</directory>
      </resource>
    </resources>
    <testResources>
      <testResource>
        <directory>${project.basedir}/src/test/resources</directory>
      </testResource>
    </testResources>
    ...

Super POM中定义了中央依赖仓库、中央插件仓库,以及各种文件夹的默认路径。

POM继承

如果你的项目有多个模块,通常每个模块之间会有一些相同的公共的依赖,你可以把依赖声明在模块各自的POM中,如下所示。

.
|-- mod A
|   `-- pom.xml
|       `-- P(1.0)
`-- mod B
    `-- pom.xml
        `-- P(1.0)

这样A模块和B模块都依赖了P,但是如果有天你想要修改P的版本,又希望A,B模块依赖的P版本相同,那就得同时修改POM-A和POM-B,太不优雅了。

所以Maven提供了POM继承功能,让我们可以吧公共的依赖抽取出来。

.
|-- pom.xml (父POM)
|   `-- P(1.0)
|-- mod A
|   `-- pom.xml
`-- mod B
    `-- pom.xml

做法如上,在父POM中声明依赖P,在AB模块的POM中声明对父POM的继承,便能实现AB模块对P依赖的引入。

AB模块中加入下面一段,便能实现对父POM的继承。

  <parent>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <relativePath>../pom.xml</relativePath>
  </parent>

relativePath的默认值即是‘../pom.xml’,可以省略。

值得一提的是,这里父POM并不需要知道子POM的信息。

总之,有了继承,子模块就能拥有父模块同样的依赖。

POM聚合

假设你的项目有多个模块,通常每个模块需要各自单独构建,如果想要所有模块能同时构建,则需要使用Maven的聚合功能。

使用聚合同样需要建一个父POM

.
|-- pom.xml (父POM)
|-- A
|   `-- pom.xml
`-- B
    `-- pom.xml

父POM内容如下:

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <packaging>pom</packaging>
 
  <modules>
    <module>A</module>
    <module>B</module>
  </modules>
</project>

其中packaging必须是pom,modules中声明需要聚合的子模块。
与继承相反,子POM中不需要父POM的信息。

总之,有了聚合,所有对父模块执行的Maven命令,同样会对子模块执行。

依赖管理(dependencyManagement)是什么

在前面讲继承的时候,我们通过父POM使得AB两个模块都拥有了依赖P,但是如果我们现在添加一个模块C,模块C并不需要依赖P,只需要父POM中的其他配置和依赖,该怎么办呢?

这就要用到dependencyManagement这个配置了,dependencyManagement与dependencies元素不同在于并不会真的引入依赖,只是指定依赖的版本。

做法是在父POM中添加dependencyManagement配置

 <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>groupabc</groupId>
        <artifactId>p</artifactId>
        <version>1.0</version>
      </dependency>
  </dependencyManagement>

然后在AB模块的POM中添加如下,注意不含版本信息。

  <dependencies>
    <dependency>
      <groupId>groupabc</groupId>
      <artifactId>p</artifactId>
    </dependency>
  </dependencies>  

如此一来,AB模块都引入了依赖p的v1.0,而模块C没有引入依赖p。

另外还有pluginManagement与此类似,不过是针对插件而已。

参考文献

Introduction to the POM

Introduction to the Dependency Mechanism

《Maven实战》

转载请保留原文地址:Maven用户都应该知道的一些事:关于依赖的常见问题

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,463评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,868评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,213评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,666评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,759评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,725评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,716评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,484评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,928评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,073评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,718评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2 352

推荐阅读更多精彩内容

  • 直奔主题,课外知识自行脑补。 1、传递依赖和继承依赖 继承依赖是个啥?就是你定义了一个父模块,然后子模块的pom里...
    HighTao_eb74阅读 1,888评论 0 1
  • 前言 在Java项目开发中,项目的编译、测试、打包等是比较繁琐的,属于重复劳动的工作,浪费人力和时间成本。以往开发...
    JourWon阅读 1,119评论 0 1
  • 逅弈 转载请注明原创出处,谢谢! 以前的日子 以前我们写代码时,jar包都默认放在一个叫 /lib 的目录下,然后...
    逅弈阅读 2,883评论 3 45
  • 刚刚来新公司,发现项目中大量的单例使用的双重检查锁方式的单例,但是很奇怪并没有加volatile修饰词。认真复习了...
    嘟嘟赌起阅读 269评论 1 0
  • 不好意思,来晚了。又是忘了更新的一天,每天都在23点快要到了的时候才发现我的日更没有更上,好懊恼,好气愤。 什么时...
    没有眼神的杀手阅读 299评论 0 0