maven(5)坐标和依赖

【0】README
1)本文部分文字转自 “maven实战”,旨在 review  “maven(5)坐标和依赖 的相关知识;

【2】坐标详解 
1)intro:坐标用于定位 类库,而一组maven 坐标通过一些元素来进行定义的:groupId, artifactId,version, packaging, classifier;
对以上元素的分析(Analysis):
A1)groupId:定义当前 maven 项目隶属的实际项目;maven 项目和 实际项目不是一一对应的,如spring framework是一个实际项目,而 maven 项目有很多如 spring-core, spring-context等;
A2)artifactId:定义实际项目中的一个 maven 项目(模块),使用实际项目名称作为 artifactId的前缀,以便于寻找实际构件;(其groupId 为spring,而artifaceId 为 spring-aop 或 spring-core 等等 )
maven(5)坐标和依赖_第1张图片
A3)packaging:该元素定义 maven 项目的打包方式;打包方式有 jar 和 war ,前者是默认的;
A4)classifier:用来帮助定义构建输出的一些附属构件。附属构件 与 主构件 相对应,如主构件 spring-aop-4.2.6.RELEASE.jar ,其附属构件还可以是 spring-aop-4.2.6.RELEASE-javadoc.jar,spring-aop-4.2.6.RELEASE-sources.jar;(干货——引入了主构件和附属构件)


Attention)
A1)以上坐标的5个元素:前3个是必须的,而  packaging 是可选的,而 classifier 是不能直接定义的;
A2)项目构件的文件名和坐标是对应的:规则为 artifactId-version [-classfier].packaging ;

【4】依赖配置
1)intro:其定义如下:
<project>
......
<dependencies>
  <dependency>
   <groupId>junit</groupId>
   <artifactId>junit</artifactId>
   <version>4.7</version>
   <type>....</type> 
   <scope>test</scope>
    <optional>...</optional>
    <exclusions>
        <exclusion>...</exclusion>
    </exclusions>
  </dependency>
 </dependencies>
...
</project>
对以上代码的分析(Analysis):
A1)type:是依赖类型 ,默认为jar ,不必声明;
A2)scope:依赖的范围(test,compile(默认));
A3)optional:标记是否可选;
A4)exclusions:用来排除传递性依赖;

【5】依赖范围
1)maven 在编译项目主代码的时候需要用到一套 classpath;
classpath1)首先:编译项目主代码的时候需要用到 spring-core,该文件以依赖的方式被引入到 classpath中;
classpath2)其次:maven 在编译和执行测试的时候会使用另外一套 classpath;
classpath3)最后:实际运行maven 项目的时候,又会使用一套 classpath;
2)intro:依赖范围就是用来控制依赖与这三种classpath(编译classpath, 测试 classpaht, 运行classpath)的关系,maven 有以下几种依赖范围:
scope1)compile:编译依赖范围
scope2)test:测试依赖范围:
scope3)provided:已提供依赖范围;
scope4)runtime:运行时 依赖范围;
scope5)system:系统依赖范围;(最好不要使用)
scope6)import:导入依赖范围;

3)上述除了 import以外的各种依赖范围与 三种classpath 的关系如下表所示:


【6】传递性依赖
【6.1】何为传递性依赖
1)problem + solution:
1.1)problem:考虑一个基于 spring framework 的项目,如果不使用 maven ,那么在项目中就需要 手动下载相关依赖;
1.2)solution:maven 的 传递性依赖就可以很好解决这个问题;
2)看个荔枝: 以 spring mvc 项目为荔枝,其有一个 spring-core-4.2.6.RELEASE.jar 的依赖,而上述jar 还会依赖于 commons-logging-1.2.jar;springmvc 项目依赖于spring-core,而sring-core 依赖于 commons-logging,则 springmvc 项目就传递依赖于 commons-logging,则传递依赖如下;(干货——传递性依赖的定义)


【6.2】传递性依赖和依赖范围
1)intro:依赖范围不仅可以控制依赖 与 三种 classpath 的关系,还对传递性依赖产生影响;
2)第1直接依赖,第2直接依赖:对于 springmvc项目,spring-core就是第1直接依赖,而 commons-logging 就是 第2直接依赖;
3)第1和第2直接依赖的范围决定了传递性依赖的范围,如下表所示;最左边一列表示第1直接依赖范围,而最上一行表示第2直接依赖范围,中间的交叉单元格则表示传递依赖性范围;
maven(5)坐标和依赖_第2张图片
对上表的分析(Analysis):看第2行,当第1 为 test,第2为compile的时候,其传递依赖的范围是 test;那所以 如果 spring-core ==compile, 而 commons-logging == test(依赖范围),则 commons-logging 相对于 springmvc 项目的依赖范围是 test ;

【7】依赖调节
1)intro:当依赖发生冲突时,需要依赖调节;
2)看个荔枝
荔枝1)如项目A 有这样的依赖关系: A->B->C->X(1.0) AND A->D->X(2.0),则 依赖调节的第一原则是:路径最近者优先(长度最短者),所以会选择 X(2.0);
荔枝2)如项目A 有这样的依赖关系: A->B->X(1.0) AND A->D->X(2.0);则依赖调节的第二原则是:第一声明者优先,在长度相等的case下,在pom 中声明的顺序决定了谁会被使用;(干货——调节依赖的第一和第二原则)

【8】可选依赖
1)intro:项目A 依赖 项目B,项目B 依赖于 项目X 和 Y,则 B 对于 X 和 Y 都是 可选依赖: A->B AND B->X(OPTIONAL) AND B->Y(OPTIONAL);
2)根据传递性依赖的定义,如果这3个依赖的范围都是 compile,那么 X and Y 就是 A 的 compile 范围的传递性依赖了。然而,由于 X and Y 是 可选依赖,依赖将不会得以传递;换句话说,X and Y 将不会对 A 有任何影响;如下图所示:
maven(5)坐标和依赖_第3张图片
3)为什么要使用可选依赖呢?如,B是一个持久层框架包 ,它支持多种数据库,包括MySQL, oracle,在构建这个 工具包的时候,需要这两种数据库的驱动程序,但在使用的时候,只会用到其中一个 驱动程序;项目B的声明如下:
maven(5)坐标和依赖_第4张图片
对以上代码的分析(Analysis): 因为项目B 依赖的驱动程序 是 可选的,所以当 项目如A 依赖 B 的时候,该驱动程序(项目)的这个依赖将不会传递,即项目A 不会依赖 驱动程序这个项目;

Conclusion)
C1)在理想case下,是不应该使用可选依赖的。因为在面向对象设计中,有一个 单一职责性原则,指一个类应该只有一个职责,而不是柔和太多的职责;
C2)那所以,在上面的case上,就应该 分别为 mysql 和 oracle 创建一个 maven项目,基于同样的 groupId 不同的 artifactId ,在各自的 pom 中声明对应的 jdbc 驱动依赖,而不是使用可选依赖;

【9】 最佳实践
【9.1】排除依赖
1)由于某些原因,不想依赖以前声明的 maven 项目了;
2)看个荔枝:项目A 依赖 项目B,而不想引入对项目C 的依赖,而是自己显示地 声明对于 项目 C1.1.0 版本的依赖;代码中使用 exclusions 元素声明排除依赖,exclusions 可以有多个 exclusion 子元素;


3)该实例的逻辑图如下所示:
maven(5)坐标和依赖_第5张图片
【9.2】归类依赖
1)intro:在某个地方声明 项目的版本 对 多个项目进行归类;
2)看个荔枝:关于 springframework项目,
maven(5)坐标和依赖_第6张图片

【9.3】优化依赖
1)intro:maven  会自动解析所有项目的直接依赖和传递性依赖,并且根据规则正确判断每个依赖的范围,对于一些依赖冲突,maven 也可以进行调节,以确保任何一个构件只有唯一的版本在依赖中存在;
2)已解析依赖:在上述工作做完后,最后得到的那些依赖称为 已解析依赖;(干货——引入已解析依赖)
3)可以运行 mvn dependency:list 查看 已解析依赖;
D:\classical_books\java_set\maven_in_action\mycode\chapter3>mvn dependency:list
[INFO] Scanning for projects...
[WARNING]
[WARNING] Some problems were encountered while building the effective model for com.maven.chapter3:service:jar:1.0-SNAPSHOT
[WARNING] 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-compiler-plugin is missing. @ line 22, column 15
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building service says hello maven. 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:2.8:list (default-cli) @ service ---
[INFO]
[INFO] The following files have been resolved:
[INFO]    junit:junit:jar:4.7:test
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 7.462 s
[INFO] Finished at: 2016-06-18T20:52:40+08:00
[INFO] Final Memory: 13M/153M
[INFO] ------------------------------------------------------------------------
4)依赖树:这些依赖被解析后,会构成一个 依赖树,通过这颗树就可以清楚地看到某个依赖是通过哪条路径引入的; (干货——引入依赖树)
5)运行 mvn dependency:tree 查看
D:\classical_books\java_set\maven_in_action\mycode\chapter3>mvn dependency:tree
[INFO] Scanning for projects...
[WARNING]
[WARNING] Some problems were encountered while building the effective model for com.maven.chapter3:service:jar:1.0-SNAPSHOT
[WARNING] 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-compiler-plugin is missing. @ line 22, column 15
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building service says hello maven. 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:2.8:tree (default-cli) @ service ---
[INFO] com.maven.chapter3:service:jar:1.0-SNAPSHOT
[INFO] \- junit:junit:jar:4.7:test // 传递性依赖,该项目会传递依赖于  junit;
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.172 s
[INFO] Finished at: 2016-06-18T20:54:26+08:00
[INFO] Final Memory: 13M/217M
[INFO] ------------------------------------------------------------------------
6)分析当前项目的依赖( mvn dependency:analyze)
D:\classical_books\java_set\maven_in_action\mycode\chapter3>mvn dependency:analyze
[INFO] Scanning for projects...
[WARNING]
[WARNING] Some problems were encountered while building the effective model for com.maven.chapter3:service:jar:1.0-SNAPSHOT
[WARNING] 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-compiler-plugin is missing. @ line 22, column 15
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building service says hello maven. 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] >>> maven-dependency-plugin:2.8:analyze (default-cli) > test-compile @ service >>>
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ service ---
[WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory D:\classical_books\java_set\maven_in_action\mycode\chapter3\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ service ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ service ---
[WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory D:\classical_books\java_set\maven_in_action\mycode\chapter3\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ service ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] <<< maven-dependency-plugin:2.8:analyze (default-cli) < test-compile @ service <<<
[INFO]
[INFO] --- maven-dependency-plugin:2.8:analyze (default-cli) @ service ---
[INFO] No dependency problems found
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.028 s
[INFO] Finished at: 2016-06-18T20:56:17+08:00
[INFO] Final Memory: 15M/222M
[INFO] ------------------------------------------------------------------------
对以上console info 的分析(Analysis):
A1)Used undeclared dependencies:意指项目中使用到 的,但没有显式声明的依赖;
A2)Unused declared dependencies:意指项目中未使用到的,但显式声明的依赖;

Attention)由于mvn dependency:analyze 只会分析 编译主代码 和 测试代码需要用到的 依赖,一些执行测试 和 运行时 需要的 依赖它发现不了;

你可能感兴趣的:(maven(5)坐标和依赖)