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

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

作者: Liam666 | 来源:发表于2019-08-09 20:56 被阅读0次

    依赖范围(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用户都应该知道的一些事:关于依赖的常见问题

    相关文章

      网友评论

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

          本文链接:https://www.haomeiwen.com/subject/ccekjctx.html