配置和管理Maven依赖

一、Maven依赖基础知识

Maven项目中用到的jar包都是通过依赖的方式引入，在进行构建的时候会自动从网络中央工厂或本地仓库下载。

（1）依赖配置基础知识

        在“pom.xml”中，可以看到如下代码：

<?xml version="1.0"?>
<project xsi:schemaLocation="http://maven.apache.org/xsd/maven-4.0.0.xsd
" xmlns="
http://maven.apache.org/POM/4.0.0
" xmlns:xsi="
http://www.w3.org/2001/XMLSchema-instance
">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.uni2uni.myapp</groupId>
  <artifactId>myapp</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>
  <name>myapp Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
    ...... 
</project>

        可以看到这个代码片段，如下所示：

<dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

        依赖的配置在<dependencies></dependencies>代码段中，可以包括多个依赖项，如下所示：

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

        常用的参数项为：

        groupId、artifactId和version：是依赖的基本坐标，Maven根据坐标才能找到需要的依赖。

        type：依赖的类型，对应于项目坐标定义的packaging。默认值是jar。

        scope：用于配置依赖的范围，下面会进行详解。

        optional：标记依赖是否可选依赖。默认值为false。

        exclusions：用来排除传递性依赖，下面会进行详解。

（2）配置依赖范围

        scope用于配置依赖的范围，可选参数如下：

        compile：编译依赖范围（默认值）。使用此依赖范围的maven依赖，对于编译、测试、运行三种classpath都有效。

        test：测试依赖范围。使用此依赖范围的maven依赖，只对于测试有效。

        provided：已提供依赖范围。使用此依赖范围的Maven依赖，对于编译和测试classpath有效，但在运行时无效。

        runtime：运行时依赖范围。使用此依赖范围的Maven依赖，对于测试和运行classpath有效，但在编译时无效。

        system：系统依赖范围。该依赖与三种classpath的关系，和provided依赖范围完全一致。但是，使用system范围依赖时必须通过systemPath元素显式地指定依赖文件的路径。由于此类依赖不是通过Maven仓库解析的，而且往往与本机系统绑定，可能造成构建的不可移植，因此应该谨慎使用。

        配置依赖范围代码示例如下：

<dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
</dependencies>

（3）依赖传递性

        如果项目依赖A，A包依赖于B包，当我们在项目中配置对A包的依赖时，系统会自动下载B包。这就是依赖的传递性。

（4）配置可选依赖

        往往存在这样的情况，我们不期望依赖传递，只需要将元素optinal设置为true即可。代码示例如下：

<dependencies>
    <dependency>
      <groupId>xxx</groupId>
      <artifactId>xxx</artifactId>
      <version>x.x.x</version>
      <optinal>true</optinal>
    </dependency>
</dependencies>

（5）配置排除依赖

        当我们引入第三方jar包的时候，难免会引入传递性依赖，有些时候这是好事，然而有些时候我们不需要其中的一些传递性依赖，比如上例中的项目，我们不想引入传递性依赖commons-logging，我们可以使用exclusions元素声明排除依赖，exclusions可以包含一个或者多个exclusion子元素，因此可以排除一个或者多个传递性依赖。需要注意的是，声明exclusions的时候只需要groupId和artifactId，而不需要version元素，这是因为只需要groupId和artifactId就能唯一定位依赖图中的某个依赖。换句话说，Maven解析后的依赖中，不可能出现groupId和artifactId相同，但是version不同的两个依赖。如下是一个排除依赖的例子：

<dependency> 
     <groupId>org.springframework</groupId>
     <artifactId>spring-core</artifactId>
     <version>2.5.6</version>
     <exclusions>
           <exclusion> 
                <groupId>commons-logging</groupId>    
                <artifactId>commons-logging</artifactId>
           </exclusion>
     </exclusions>
</dependency>

（6）配置依赖归类

        如果我们项目中用到很多关于Spring Framework的依赖，它们分别是org.springframework:spring-core:2.5.6, org.springframework:spring-beans:2.5.6,org.springframework:spring-context:2.5.6,它们都是来自同一项目的不同模块。因此，所有这些依赖的版本都是相同的，而且可以预见，如果将来需要升级Spring Framework，这些依赖的版本会一起升级。因此，我们应该在一个唯一的地方定义版本，并且在dependency声明引用这一版本，这一在Spring Framework升级的时候只需要修改一处即可。如下所示：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.mycompany.app</groupId>
	<artifactId>my-app-simple</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>
	<name>my-app-simple</name>
	<properties>
		<springframework.version>2.5.6</springframework.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>3.8.1</version>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>${springframework.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-beans</artifactId>
			<version>${springframework.version}</version>			
		</dependency>
	</dependencies>
</project>

（7）配置依赖聚合

        为了能够使用一条命令就能构建 account-email和 account-persist两个模块，我们需要建立一个额外的名为 account-aggregator的模块，然后通过该模块构建整个项目的所有模块。 account-aggregator本身也是个 Maven项目，它的 POM如下：

<project>
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.juvenxu.mvnbook.account</groupId>
 <artifactId>account-aggregator</artifactId>
 <version>1.0.0-SNAPSHOT</version>
 <packaging> pom </packaging>
 <name>Account Aggregator</name>
  <modules>
  <module>account-email</module>
  <module>account-persist</module>
  </modules>
</project>

注意：packaging的类型为pom ，module的值是一个以当前POM为主目录的相对路径。

（8）配置依赖继承

        可声明父POM供子 POM继承。父模块POM如下：

<project>
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.juvenxu.mvnbook.account</groupId>
 <artifactId> account-parent </artifactId>
 <version>1.0.0-SNAPSHOT</version>
 <packaging>pom</packaging>
 <name>Account Parent</name>
</project>

        子模块声明继承如下：

<project>
 <modelVersion>4.0.0</modelVersion>
 <parent>
  <groupId>com.juvenxu.mvnbook.account</groupId>
  <artifactId> account-parent </artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <relativePath >../account-parent/pom.xml</ relativePath>
 </parent>
 <artifactId> account-email </artifactId>
 <name>Account Email</name>
  ...

</project>

        最后，同样还需要把 account-parent加入到聚合模块account-aggregator中。聚合的 POM如下：

<project>
 <modelVersion>4.0.0</modelVersion>
 <groupId>com.juvenxu.mvnbook.account</groupId>
 <artifactId>account-aggregator</artifactId>
 <version>1.0.0-SNAPSHOT</version>
 <packaging> pom </packaging>
 <name>Account Aggregator</name>
 <modules>
  <module>account-email</module>
  <module>account-persist</module>
  <module> account-parent</module>
 </modules>
</project>

注意：
1、子模块没有声明groupId和version, 这两个属性继承至父模块。但如果子模块有不同与父模块的 groupId、version ，也可指定；
2、不应该继承artifactId,如果groupId ，version，artifactId 完全继承的话会造成坐标冲突；另外即使使用不同的 groupId或version，同样的 artifactId也容易产生混淆。
3、使用继承后 parent也必须像自模块一样加入到聚合模块中。也就是在在聚合模块的 pom中加入<module>account-parent</module>。

二、在MyEclipse中管理依赖

        在MyEclipse中可以通过图形界面来管理maven的依赖。在”pop.xm“中点击Dependency Hierarchy可以看到依赖树，如下图所示：

        

        点击Dependencies可以添加新的依赖，点击选择一个依赖，点击remove可以删除，点击Add可以新增一个依赖，如下图：

        

三、知识扩展

（1）Maven可继承的POM元素

        groupId：项目组 ID ，项目坐标的核心元素；
        version：项目版本，项目坐标的核心元素；
        description：项目的描述信息；
        organization：项目的组织信息；
        inceptionYear：项目的创始年份；
        url：项目的 url 地址
        develoers：项目的开发者信息；
        contributors：项目的贡献者信息；
        distributionManagerment：项目的部署信息；
        issueManagement：缺陷跟踪系统信息；
        ciManagement：项目的持续继承信息；
        scm：项目的版本控制信息；
        mailingListserv ：项目的邮件列表信息；
        properties ：自定义的 Maven 属性；
        dependencies ：项目的依赖配置；
        dependencyManagement ：醒目的依赖管理配置；
        repositories ：项目的仓库配置；
        build ：包括项目的源码目录配置、输出目录配置、插件配置、插件管理配置等；
        reporting ：包括项目的报告输出目录配置、报告插件配置等。