Maven 是一种用来管理 Java 项目的工具,它处理的是一个具体项目所涉及的各种任务,如编译、测试、打包、文档以及分发。
Maven 包括一下几个部分:
- 一组用于处理依赖管理、目录结构以及构建工作流的约定。
- 一个用于项目配置的
XML Schema
:项目对象模型(Project Object Model),简称 POM。 - 一个委托外部组件来执行项目任务的插件架构。
POM 文件大纲
<project>
<groupId></groupId>
<!-- 唯一地第一个 Maven 项目的值 -->
<artifactId></artifactId>
<version></version>
<!-- 该项目所产生的构建类型,默认值是 jar -->
<packaging></packaging>
<!-- 在 POM 中所引用的符号 -->
<properties></properties>
<!-- 构建当前项目所需要的其他 Maven 项目 -->
<dependencies></dependencies>
<!-- 构建该项目所需要执行的任务的配置 -->
<build></build>
<!-- 为不同的用例自定义 POM 的命名的配置 -->
<profiles></profiles>
</project>
Maven 构件
任何可以被 Maven 坐标系统
唯一标识的对象都是一个 Maven 构件
。大多数情况下,构件是构建 Maven 项目所生成的文件,如 JAR。但是,只包含其他 POM 使用的定义的 POM 文件也是 Maven 构件。
Maven 构件类型由<packaging>
元素制定,最常用的值是pom
、jar
、war
以及 maven-plugin
。
GAV 坐标
POM 定义了 5 种称为坐标的元素,用于标识 Maven 构件
。GAV 是指必须始终指定的 3 个坐标:<groupId>
、<artifactID>
以及 <version>
。
-
<groupId>
:项目或者项目组的全局唯一标识符,通常是 Java 源代码种使用的全局限定包名。 -
<artifactId>
:用于标示和某个<groupId>
相关的不同的构件。 -
<type>
:和项目相关的主要构件类型,默认值是 jar。 -
<version>
:标识构件
的版本。 -
<classifier>
:用于区分属于相同的 POM 但是却被以不同的方式构建的构件。
完整的坐标表达式:artifactId:groupId:packaging:version:classifier
POM 文件的用例
可以通过以下方式来使用 POM 文件:
- 默认的 - 用于构建一个构件
- 父 POM - 提供一个由子项目继承的单个配置信息源,声明这个 POM 文件作为他们的
parent
元素的值。 - 聚合器 - 用于构建声明为
<modules>
的项目,这些子项目位于其当前聚合器项目的文件夹中,每个都包含有它自己的 POM 文件。
作为父 POM 或者聚合器的 POM 文件的
<packaging>
元素的值应该是 pom。一个 POM 文件可能同时提供两项功能。
构建的生命周期
Maven 构件的生命周期是一个明确定义的用于构建和分发的过程。有 3 个内置的构建生命周期:clean
、default
和 site
。
一个构建生命周期由一系列的阶段组成:
-
validate
检查项目是否正确,所有必须的信息是否已经就绪。 -
process-sources
处理源代码,如过滤任何值。 -
compile
编译项目的源代码。 -
process-test-resources
复制并处理资源刀测试目标目录中。 -
test-compile
将测试源代码编译到测试目标目录中。 -
test
使用合适的单元测试框架测试编译的源代码。 -
package
将编译的代码打包为它可分发的格式,如 JAR。 -
integration-test
处理并将软件包部署到一个可以运行集成测试的环境中。 -
verify
运行任何的检查以验证软件包是否有效,并且符合质量标准。 -
install
将软件包安装到本地存储库中,在那里其他本地构建项目可以将它引用为依赖。 -
deploy
将最终的构件上传到远程存储库,以与其他开发人员和项目共享。
依赖
项目依赖是指编译和执行它所需要的外部构件,Maven 中的依赖在 <dependency>
中声明,GAV 坐标是必不可少的。type
和 scope
元素对于那些值不是 jar
和 compile
的依赖来说也是必不可少的。
<scope>
元素可以具有以下值:
-
compile
编译和执行需要的默认值。 -
runtime
只有执行需要。 -
optional
不会被其他引用这个项目所产生的构件项目视为传递依赖。 -
provided
不会被包含在由这个 POM 产生的 WAR 文件的 WEB_INF/lib 目录中。 -
test
只有编译和测试的执行需要。 -
import
把外部 POM 的<dependencyManagement>
元素的内容导入到当前 POM 的<dependencyManagement>
元素中。
依赖管理
POM 的 <dependencyManagement>
元素可以包含被其他项目使用的<dependency>
声明,这样的 POM 子项目将会自动继承这些声明。
引用了 <dependencyManagement>
元素的项目可以使用它所声明的依赖,而不需要指定它们的<version>
坐标,如果 <dependencyManagement>
中的 <version>
有所改变,则引用它的 POM 也会改变。
插件
虽然 Maven 协调了所有构建生命周期阶段的执行,但是它并没有直接实现他们,相反,Maven 将它们委托给了插件,这些插件是 maven-plugin
类型的构件
(打包为 JAR 文件)。
Apache Maven 项目为标准构件生命周期所定义的任务都提供了插件,更多是由第三方产生的,用于处理各种自定义的任务。
插件可能拥有多个内部步骤或者目标,也可以被单独调用。例如在一个 JAR 项目中,默认的构建生命周期由 maven-jar-plugin
处理,其将构建的各个阶段映射到了它自己的以及其他插件的目标中。
插件管理
<pluginManagement>
声明了其他 POM 可以使用的信息,但是这只适用于子 POM,因为对于插件来说,没有导入声明。
在声明由 Maven 项目生成的插件时,可以省略 groupId
(org.apache.maven.plugins)。maven
开头的 artifactId
仅供 Maven 项目使用。
配置文件
配置文件(在 <profiles>
中定义)是一组自定义的 POM 元素,可以通过自动或手动启用来改变 POM 的行为。
存储库
Maven 的构件存储库可能是远程的,也可能是本地的。
- 远程存储库是一个 Maven 从其下载 POM 文件所引用的依赖服务。
- 本地存储库是一个本地的目录,其包含从远程存储库下载的构件,以及在本地机器上构建并安装的构件。通常目录为
~/.m2/repository
,Maven 存储库的物理目录结构使用 GAV 坐标。