Maven项目中的依赖管理——dependencyManagement

DepencyManagement应用场景

当我们的项目模块很多的时候，我们使用Maven管理项目非常方便，帮助我们管理构建、文档、报告、依赖、scms、发布、分发的方法。可以方便的编译代码、进行依赖管理、管理二进制库等等。

由于我们的模块很多，所以我们又抽象了一层，抽出一个itoo-base-parent来管理子项目的公共的依赖。为了项目的正确运行，必须让所有的子项目使用依赖项的统一版本，必须确保应用的各个项目的依赖项和版本一致，才能保证测试的和发布的是相同的结果。

在我们项目顶层的POM文件中，我们会看到dependencyManagement元素。通过它元素来管理jar包的版本，让子项目中引用一个依赖而不用显示的列出版本号。Maven会沿着父子层次向上走，直到找到一个拥有dependencyManagement元素的项目，然后它就会使用在这个dependencyManagement元素中指定的版本号。

来看看我们项目中的应用：

在实际开发过程中，会使用多模块的项目搭建，因此就会存在一个顶级项目，以及模块项目。

通常顶级项目也就是父类项目，是会删除其src文件夹，保留pom文件，通常作为各个模块的依赖的jar的管理。

在使用 Maven 创建多模块项目的时候，在父项目的 pom 文件中经常会碰见 <dependencyManagement> 标签的使用，比如如下代码：

Itoo-base-parent(pom.xml)

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.SR2</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Itoo-base(pom.xml)

<!--继承父类-->  
<parent>  
        <artifactId>itoo-base-parent</artifactId>  
        <groupId>com.tgb</groupId>  
  
        <version>0.0.1-SNAPSHOT</version>  
        <relativePath>../itoo-base-parent/pom.xml</relativePath>  
    </parent>  
        <modelVersion>4.0.0</modelVersion>  
        <artifactId>itoo-base</artifactId>  
        <packaging>ejb</packaging>  
          
        <!--依赖关系-->  
        <dependencies>  
        <dependency>  
            <groupId>javax</groupId>  
            <artifactId>javaee-api</artifactId>  
        </dependency>  
          
        <dependency>  
            <groupId>com.fasterxml.jackson.core</groupId>  
            <artifactId>jackson-annotations</artifactId>  
        </dependency>  
          
        <dependency>  
            <groupId>org.eclipse.persistence</groupId>  
            <artifactId>org.eclipse.persistence.jpa</artifactId>  
            <scope>provided</scope>  
        </dependency>  
    </dependencies>  
</project>

这样做的好处：统一管理项目的版本号，确保应用的各个项目的依赖和版本一致，才能保证测试的和发布的是相同的成果，因此，在顶层pom中定义共同的依赖关系。同时可以避免在每个使用的子项目中都声明一个版本号，这样想升级或者切换到另一个版本时，只需要在父类容器里更新，不需要任何一个子项目的修改；如果某个子项目需要另外一个版本号时，只需要在dependencies中声明一个版本号即可。子类就会使用子类声明的版本号，不继承于父类版本号。

DepencyManagement作用

那么它的作用究竟是什么呢？我们直接把标签名翻译过来，其意思为“依赖管理”，是的，它在 Maven 中提供了一种管理依赖版本号的方式。

在常规使用中，一个 Maven 项目如果要引用某个依赖，那么直接就在 dependencies 中添加 dependency 描述所需的依赖坐标信息即可完成。这样就达到了一个要什么，就直接写什么的效果，决定权都在是否用 dependency 指定了引用构件的坐标。

但在实际项目管理过程中，会有多个模块，如果把这些模块所需的依赖各自引入，不仅会导致管理的不方便，更甚会有版本冲突等问题，所以此时应该设计一个全局的依赖管理。也就是说，把整个项目要引用的依赖，事先分析整理好，形成一个全局的集合。当某个 Maven 模块需要具体引用某依赖的时候，直接在集合中指定若干个。这样就可以实现整个项目依赖的全局管理，不至于零碎地分布在每个 Maven 模块中。

正是基于这样的考虑，就产生 dependencyManagement 的设计，在此标签元素中声明所需依赖的版本号等信息，那么所有子项目再次引入此依赖 jar 包时则无需显式的列出版本号。Maven 会沿着父子层级向上寻找拥有 dependencyManagement 元素的项目，然后使用它指定的版本号。

我们在Eclispe的Pom依赖视图中，看到managed字样的jar包，都是由dependencyManagement指定管理的。

例如，在父项目中的 pom.xml 如下：

<properties>
    <springframework.version>1.2.3.RELEASE</springframework.version>
</properties>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${springframework.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

此配置即声明了 Spring Boot 的版本信息，注意其中还有 type（打包类型）和 scope 标签，import 表示当前项目的依赖可用于另外一个项目，并且 import 范围只有在 denpendencyManagement 元素下才有效果，由于其范围有特殊性，一般都是指向打包类型为 pom 的模块。

如果某子项目中需要使用上述的依赖，直接引入即可，并且不必再指定版本号，它会自动继承父类的版本信息。子项目的 pom.xml 如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

注意：

父项目中的 dependencyManagement 中定义的只是依赖的声明，并不实现引入，因此子项目需要显式的声明需要用的依赖。
如果子项目重新指定了依赖的版本号，那么它会引入一个新的依赖而不是从父项目继承。
scope=import 只能用在 dependencyManagement 里面，且仅用于 type=pom 的 dependency。

dependencyManagement 只是声明依赖，并不实际引入，因此需要在子项目中引入。

例如：使用pom.xml中的dependencyManagement 元素能让所在子项目中引用一个依赖而不用显示的列出版本号。maven会沿着父子层级向上走，直到找到有个拥有dependencyManagement 元素的项目，然后使用这个dependencyManagement 元素中指定的依赖版本号
例如父工程定义如下：

<dependencyManagement>
	<dependencies>
		<dependency>
		   <groupId>mysql</groupId>
		   <artifactId>mysql-connector-java</artifactId>
		   <version>5.1.47</version>
		</dependency>
	</dependencies>
</dependencyManagement>

然后子工程中就可以不用在定义mysql的版本号，会默认和父版本一致，如果子工程引入了自己的版本号，则会使用自己定义的版本。

<dependencies>
		<dependency>
		   <groupId>mysql</groupId>
		   <artifactId>mysql-connector-java</artifactId>
		</dependency>
	</dependencies>

dependencies 和 dependencyManagement 的不同：

父项目中使用 dependencies 引入依赖，子项目会自动继承父项目中的全部依赖项（全部继承）；
父项目中使用 dependencyManagement 声明依赖，并不会引入依赖，子项目需要时再引入。

例如：如果在父级项目中的pom文件中

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>xxx</version>
         </dependency>
     </dependencies>

其他的模块都是会自动导入该模块。

dependencyManagement 的优势：

如果有多个子项目都引用同一样依赖，则可以避免在每个使用的子项目里都声明一个版本号；
当想升级或切换到另一个版本时，只需要在顶层父容器里更新，而不需要逐个修改子项目；
另外如果某个子项目需要另外的一个版本，只需要声明 version 即可。

92IT

Just love IT.

Maven项目中的依赖管理——dependencyManagement