Maven学习总结(四)——Maven核心概念
一、Maven坐标
1.1、什么是坐标?
在平面几何中坐标(x,y)可以标识平面中唯一的一点。
1.2、Maven坐标主要组成
- groupId:组织标识(包名)
- artifactId:项目名称
- version:项目的当前版本
- packaging:项目的打包方式,最为常见的jar和war两种
样例:
1.3、Maven为什么使用坐标?
- Maven世界拥有大量构建,我们需要找一个用来唯一标识一个构建的统一规范。
- 拥有了统一规范,就可以把查找工作交给机器。
二、依赖管理
2.1、依赖配置
依赖配置主要包含如下元素:
1 <!--添加依赖配置--> 2 <dependencies> 3 <!--项目要使用到junit的jar包,所以在这里添加junit的jar包的依赖--> 4 <dependency> 5 <groupId>junit</groupId> 6 <artifactId>junit</artifactId> 7 <version>4.9</version> 8 <scope>test</scope> 9 </dependency> 10 <!--项目要使用到Hello的jar包,所以在这里添加Hello的jar包的依赖--> 11 <dependency> 12 <groupId>me.gacl.maven</groupId> 13 <artifactId>Hello</artifactId> 14 <version>0.0.1-SNAPSHOT</version> 15 <scope>compile</scope> 16 </dependency> 17 </dependencies>
2.2、依赖范围
首先需要知道,Maven在编译项目主代码的时候需要使用一套classpath. 在执行测试的时候会使用另外一套classpath.实际运行Maven项目的时候,又会使用一套classpath
依赖范围scope用来控制依赖和编译,测试,运行的classpath的关系. 主要的是三种依赖关系如下:
1.compile: 默认编译依赖范围。对于编译,测试,运行三种classpath都有效
2.test:测试依赖范围。只对于测试classpath有效
3.provided:已提供依赖范围。对于编译,测试的classpath都有效,但对于运行无效。因为由容器已经提供,例如servlet-api
4.runtime:运行时提供。例如:jdbc驱动
compile (编译范围)
compile是默认的范围;如果没有提供一个范围,那该依赖的范围就是编译范围(包括编译,测试,运行,打包都能用)。编译范围依赖在所有的classpath 中可用,同时它们也会被打包。
provided (已提供范围)
provided 依赖只有在当JDK 或者一个容器已提供该依赖之后才使用(编译,测试可用)。例如,如果你开发了一个web 应用,你可能在编译 classpath 中需要可用的Servlet API 来编译一个servlet,但是你不会想要在打包好的WAR 中包含这个Servlet API;这个Servlet API JAR 由你的应用服务器或者servlet 容器提供。已提供范围的依赖在编译classpath (不是运行时)可用。它们不是传递性的,也不会被打包。
runtime (运行时范围)
runtime 依赖在运行和测试系统的时候需要(运行时才可用),但在编译的时候不需要。比如,你可能在编译的时候只需要JDBC API JAR,而只有在运行的时候才需要JDBC
驱动实现。
test (测试范围)
test范围依赖在一般的编译和运行时都不需要,它们只有在测试编译和测试运行阶段可用。
system (系统范围)
system范围依赖与provided 类似,但是你必须显式的提供一个对于本地系统中JAR 文件的路径。这么做是为了允许基于本地对象编译,而这些对象是系统类库的一部分。这样的构件应该是一直可用的,Maven 也不会在仓库中去寻找它。如果你将一个依赖范围设置成系统范围,你必须同时提供一个systemPath 元素。注意该范围是不推荐使用的(你应该一直尽量去从公共或定制的 Maven 仓库中引用依赖)。
- 当第二直接依赖的范围是compile的时候,传递性依赖的范围与第一直接依赖的范围一致;
- 当第二直接依赖的范围是test的时候,依赖不会得以传递;
- 当第二直接依赖的范围是provided的时候,只传递第一直接依赖的范围也为provided的依赖,切传递性依赖的范围同样为provided;
- 当第二直接依赖的范围是runtime的时候,传递性依赖的范围与第一直接依赖的范围一致,但compile例外,此时传递性依赖的范围为runtime。
2.3、传递性依赖
MakeFriends.jar直接依赖于HelloFriends.jar,而HelloFriends.jar又直接依赖于Hello.jar,那么MakeFriends.jar也依赖于Hello.jar,这就是传递性依赖,只不过这种依赖是间接依赖,如下图所示:
2.4、可选依赖
当project-A 依赖project-B, project-B 依赖project-D时
<dependency>
<groupId>sample.ProjectD</groupId>
<artifactId>ProjectD</artifactId>
<version>1.0-SNAPSHOT</version>
<optional>true</optional>
</dependency>
所以当project-B的依赖的D项目设置<optional>true</optional>时, project-A中如果没有显式的引入project-D, 则project-A不依赖project-D, 即project-A可以自己选择是否依赖project-D
默认<optional>的值为false, 及子项目必须依赖
三、仓库管理
3.1、Maven仓库
用来统一存储所有Maven共享构建的位置就是仓库
3.2、Maven仓库布局
根据Maven坐标定义每个构建在仓库中唯一存储路径,大致为:groupId/artifactId/version/artifactId-version.packaging
3.3、仓库的分类
3.3.1、本地仓库
每个用户只有一个本地仓库,默认是在~/.m2/repository/,~代表的是用户目录
3.3.2、远程仓库
1、中央仓库:Maven默认的远程仓库,URL地址:http://search.maven.org/
2、私服:是一种特殊的远程仓库,它是架设在局域网内的仓库
四、生命周期
4.1、何为生命周期?
Maven生命周期就是为了对所有的构建过程进行抽象和统一,包括项目清理,初始化,编译,测试,打包,部署等几乎所有构建步骤
4.2、Maven三大生命周期
Maven有三套相互独立的生命周期,请注意这里说的是"三套",而且"相互独立",这三套生命周期分别是:
- Clean Lifecycle 在进行真正的构建之前进行一些清理工作。
- Default Lifecycle 构建的核心部分,编译,测试,打包,部署等等。
- Site Lifecycle 生成项目报告,站点,发布站点。
再次强调一下它们是相互独立的,你可以仅仅调用clean来清理工作目录,仅仅调用site来生成站点。当然你也可以直接运行 mvn clean install site 运行所有这三套生命周期。
clean生命周期每套生命周期都由一组阶段(Phase)组成,我们平时在命令行输入的命令总会对应于一个特定的阶段。比如,运行mvn clean ,这个的clean是Clean生命周期的一个阶段。有Clean生命周期,也有clean阶段。Clean生命周期一共包含了三个阶段:
- pre-clean 执行一些需要在clean之前完成的工作
- clean 移除所有上一次构建生成的文件
- post-clean 执行一些需要在clean之后立刻完成的工作
"mvn clean" 中的clean就是上面的clean,在一个生命周期中,运行某个阶段的时候,它之前的所有阶段都会被运行,也就是说,"mvn clean"等同于 mvn pre-clean clean ,如果我们运行 mvn post-clean ,那么 pre-clean,clean 都会被运行。这是Maven很重要的一个规则,可以大大简化命令行的输入。
Site生命周期pre-site 执行一些需要在生成站点文档之前完成的工作
- site 生成项目的站点文档
- post-site 执行一些需要在生成站点文档之后完成的工作,并且为部署做准备
- site-deploy 将生成的站点文档部署到特定的服务器上
这里经常用到的是site阶段和site-deploy阶段,用以生成和发布Maven站点,这可是Maven相当强大的功能,Manager比较喜欢,文档及统计数据自动生成,很好看。
Default生命周期Default生命周期是Maven生命周期中最重要的一个,绝大部分工作都发生在这个生命周期中。这里,只解释一些比较重要和常用的阶段:
- validate
- generate-sources
- process-sources
- generate-resources
- process-resources 复制并处理资源文件,至目标目录,准备打包。
- compile 编译项目的源代码。
- process-classes
- generate-test-sources
- process-test-sources
- generate-test-resources
- process-test-resources 复制并处理资源文件,至目标测试目录。
- test-compile 编译测试源代码。
- process-test-classes
- test 使用合适的单元测试框架运行测试。这些测试代码不会被打包或部署。
- prepare-package
- package 接受编译好的代码,打包成可发布的格式,如 JAR 。
- pre-integration-test
- integration-test
- post-integration-test
- verify
- install 将包安装至本地仓库,以让其它项目依赖。
- deploy 将最终的包复制到远程的仓库,以让其它开发人员与项目共享。
运行任何一个阶段的时候,它前面的所有阶段都会被运行,这也就是为什么我们运行mvn install 的时候,代码会被编译,测试,打包。此外,Maven的插件机制是完全依赖Maven的生命周期的,因此理解生命周期至关重要。
五、Maven插件
- Maven的核心仅仅定义了抽象的生命周期,具体的任务都是交由插件完成的。
- 每个插件都能实现多个功能,每个功能就是一个插件目标。
- Maven的生命周期与插件目标相互绑定,以完成某个具体的构建任务,例如compile就是插件maven-compiler-plugin的一个插件目标。
Maven生命周期和插件的关系
前面说了,Maven定义了3套相互独立的生命周期。每套生命周期中都包含着一系列的阶段(phase)。这些phase就相当于Maven提供的统一的接口,然后这些phase的实现由Maven的插件来完成。
我们在输入mvn命令的时候 比如 mvn clean,clean对应的就是Clean生命周期中的clean阶段。但是clean的具体操作是由maven-clean-plugin来实现的。
所以说Maven生命周期的每一个阶段的具体实现都是由Maven插件实现的。
插件目标(Plugin Goal)
插件能够为Maven提供不同的功能,而一个插件可能包含多个插件目标(goals),目标可以说是Maven中的最小工作单元。
比如compile:compile 表示执行compile插件的 compile目标。
一个插件通常可以完成多个任务,每一个任务就叫做插件的一个目标。如执行mvn install命令时,调用的插件和执行的插件目标如下:
每个插件都有哪些个目标,官方文档有更详细的说明:Maven Plugins
插件的运行
1. 直接调用插件的目标 mvn plugin:goals
例如
mvn compile:compile
mvn clean:clean
2. 绑定到生命周期的phase中
- 首先Maven默认绑定了一些插件到phase(阶段)中比如
phase | goals |
---|---|
clean | clean:clean |
phase | goals |
---|---|
process-resources | resources:resources |
compile | compiler:compile |
process-test-resources | resources:testResources |
test-compile | compiler:testCompile |
test | surefire:test |
package | ejb:ejb或ejb3:ejb3或jar:jar或par:par或rar:rar或war:war |
install | install:install |
deploy | deploy:deploy |
在当packaging设置为ejb/ejb3/jar/par/rar/war 其中之一的时候,default lifecycle只有下面phase绑定了goal。
phase | goals |
---|---|
process-resources | resources:resources |
compile | compiler:compile |
process-test-resources | resources:testResources |
test-compile | compiler:testCompile |
test | surefire:test |
package | ejb:ejb或ejb3:ejb3或jar:jar或par:par或rar:rar或war:war |
install | install:install |
deploy | deploy:deploy |
phase | goals |
---|---|
site | site:site |
site-deploy | site:deploy |
- 上面是部分Maven已经默认绑定的目标。
- 在默认情况下,并不是所有的phase都绑定了goal,比如clean这个lifecycle是有三个phase的,但是只有其中的一个名为clean的phase默认绑定了一个clean:clean goal,其它两个phase默认没有绑定任何goal。
其他默认的插件目标绑定请参考Maven官方文档。
- 自定义绑定插件
可以在pom.xml中进行绑定配置
<project> ... <build> <plugins> <plugin> <!-- groupId artifactId version 是maven的坐标 --> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-source-plugin</artifactId> <version>2.1.1</version> <executions> <execution> <id>attach-sources</id> <phase>verify</phase> <goals> <goal>jar-no-fork</goal> </goals> </execution> </executions> </plugin> </plugins> </build> ... </project>
以上示例中,声明了maven-source-plugin(使用groupId、artifactId、version指定)。然后在<executions>元素下指定多个任务<execution>,通过指定多个<execution>,就可以把相同插件的目标绑定到不同的生命周期阶段。
<id>指定任务名称(在一个插件中必须唯一),
<phase>指定到的生命周期阶段,
<goal>指定插件目标。
如果没有指定<phase>,那么就会绑定到插件默认的生命周期阶段上。如果插件没有默认生命周期阶段,那么插件目标将不会被执行。
通过以上的配置,现在执行mvn verify将看到maven-source-plugin的jar-no-fork目标被执行。
以后在执行mvn package命令打包项目时,在package阶段之后会执行源代码打包,生成如:ehcache-core-2.5.0-sources.jar形式的源码包。
3. 配置插件
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <configuration> <source>1.7</source> <target>1.7</target> </configuration> </plugin>
maven compile插件默认使用的编译版本是1.5,可以通过配置修改编译版本。
也可以对插件的各个目标进行更具体的配置。Configuring Plug-ins