Maven基本原理
项目构建原理
Maven是一种常用的项目构建工具,项目构建工具将我们在软件开发中中的一些重复又易出错的固定活动,如编码,加载依赖,编译,测试,打包,发布等管理起来,开发人员只要是用项目构建工具的一些简单的命令,就可以完成这些活动。
因此,项目构建工具主要做下面三件事:
- 规范并完善一个完整的构建生命周期模型,标准化构建过程。
- 有效的依赖管理与版本管理。
- 为统一,标准的配置提供一套规范。
作为常用的项目构建工具,Maven能够基于POM来提供除了项目构建生命周期的管理之外的版本管理,是Java构建管理的第二代产品,它提出了一个很重要的概念就是约定大于配置,即按照约定成俗的构建生命周期来构建项目。
通过以下对Maven生命周期,配置文件,仓库等的介绍,我们可以理解Maven的构建原理。
生命周期
Maven 有以下三个标准的生命周期:
- clean:项目清理的处理
- default(或 build):项目部署的处理
- site:项目站点文档创建的处理
clean
clean的主要目的是清空项目工作中产生的一些中间件,比如上次打的jar包,临时文件等。该生命周期主要用于在build生命周期之前做清理工作。
clean生命周期包含三个阶段:
阶段 | 处理 | 描述 |
---|---|---|
pre-clean | 预清理 | 执行一些需要在clean之前完成的工作 |
clean | 清理 | 移除所有上一次构建生成的文件 |
post-clean | 后清理 | 执行一些需要在clean之后立刻完成的工作 |
在一个生命周期中,运行某个阶段的时候,它之前的所有阶段都会被运行,因此maven clean
命令会执行pre-clean
和clean
阶段,而mvn post-clean
命令会执行clean生命周期的三个阶段:pre-clean, clean, post-clean
。
default (build)
build(构建)声明周期是maven的主要生命周期,主要用于构建应用。包括23个阶段,下面介绍常用的7种:
阶段 | 处理 | 描述 |
---|---|---|
validate | 验证项目 | 验证项目是否正确且所有必须信息是可用的 |
compile | 执行编译 | 源代码编译在此阶段完成 |
test | 测试 | 使用适当的单元测试框架运行测试。 |
package | 打包 | 将编译后的代码打包成需要的格式,比如JAR |
verify | 检查 | 对集成测试的结果进行检查,以保证质量达标 |
install | 安装 | 安装打包的项目到本地仓库,以供其他项目使用 |
deploy | 部署 | 将在最终的build环境上面完成,拷贝最终的工程包到远程仓库中, 以共享给其他开发人员和工程 |
site
Maven Site 插件一般用来创建新的报告文档、部署站点等。
阶段 | 处理 |
---|---|
pre-site | 执行一些需要在生成站点文档之前完成的工作 |
site | 生成项目的站点文档 |
post-site | 执行一些需要在生成站点文档之后完成的工作,并且为部署做准备 |
site-deploy | 将生成的站点文档部署到特定的服务器上 |
经常用到的是site阶段和site-deploy阶段,用以生成和发布Maven站点。
构建配置文件
构建配置文件的类型
构建配置文件大体上有三种类型:
类型 | 在哪定义 |
---|---|
项目级(Per Project) | 定义在项目的POM文件pom.xml中 |
用户级 (Per User) | 定义在Maven的设置xml文件中(%USER_HOME%/.m2/settings.xml) |
全局(Global) | 定义在 Maven 全局的设置 xml 文件中(%M2_HOME%/conf/settings.xml) |
下面介绍POM文件配置
POM配置
在项目的根目录下面有个pom.xml的文件,该文件是用来配置Maven项目的,其中包括版本,生命周期,构建过程,依赖等的配置。
版本
在创建Maven项目的时候,需要手动指定GroupId,ArtifactId, Version,这就是项目的版本配置。
-
GroupId :是项目组织中唯一的标识符,对应Java包结构,在idea中看到的是main目录里java的目录结构。一般分为多个段,这里我只说两段,第一段为域,第二段为公司名称。域又分为
org
、com
、cn
等等许多,其中org
为非营利组织,com
为商业组织。 - ArtifactId: 是项目的唯一的标识符,实际对应项目的名称(就是idea中工程的名字),就是项目根目录的名称。
-
Version: 是该项目的版本信息。
如下是我创建的demo项目的版本配置:
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
生命周期配置
Maven一般是通过约定大于配置的方式来约定整个生命周期的,但是也可以通过在POM文件里面的配置来指定其构建过程。
比如将 maven-antrun-plugin:run
目标添加到 pre-clean、clean 和 post-clean 阶段中。这样我们可以在 clean 生命周期的各个阶段显示文本信息。
构建命令
Maven命令通常有两部分构成:
- mvn
- 1或多个构建生命周期,构建阶段,或构建目标
如:
mvn clean
多个构建过程写在一条命令里,则按顺序执行,如下先执行clean再执行build:
mvn clean build
- 连接
30个常用maven命令 -
注
在命令行使用、maven构建命令时,命令行窗口位置应切换到项目pom文件所在目录,也即项目的根目录
另外,在idea中,View --> Tool Windows --> maven,在打开的窗口中,我们可以看到上面提到的maven常用的生命周期的几个阶段,点击即可执行。
依赖配置
在POM里面的dependencies下面添加依赖配置。
如下是我的demo项目的pom中引入的依赖:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
配置文件在仓库中寻找,下面就来介绍仓库。
仓库
在Maven中,仓库是用来存放依赖文件的地方,是依赖管理的重要组成部分。仓库按照存放位置可以分为本地仓库,远程仓库以及中央仓库。
本地仓库
本地仓库,就是本地开发自己机器上的仓库。在idea的settings中我们可以查看自己本地仓库的位置。
中央仓库
Maven 中央仓库是由 Maven 社区提供的仓库,其中包含了大量常用的库。
中央仓库的关键概念:
- 这个仓库由 Maven 社区管理。
- 不需要配置。
- 需要通过网络才能访问。
远程仓库
当条件限制,不允许在中央仓库下载依赖,那么组织可以自己定制一个远程仓库,让所有开发都从此仓库下载。定义好远程仓库后,然后修改POM文件即可:
<repositories>
<repository>
<id>companyname.lib1</id>
<url>http://download.companyname.org/maven2/lib1</url>
</repository>
<repository>
<id>companyname.lib2</id>
<url>http://download.companyname.org/maven2/lib2</url>
</repository>
</repositories>
依赖下载顺序
当我们执行 Maven 构建命令时,Maven 开始按照以下顺序查找依赖的库:
- 步骤 1 - 在本地仓库中搜索,如果找不到,执行步骤 2,如果找到了则执行其他操作。
- 步骤 2 - 在中央仓库中搜索,如果找不到,并且有一个或多个远程仓库已经设置,则执行步骤 4,如果找到了则下载到本地仓库中以备将来引用。
- 步骤 3 - 如果远程仓库没有被设置,Maven 将简单的停滞处理并抛出错误(无法找到依赖的文件)。
- 步骤 4 - 在一个或多个远程仓库中搜索依赖的文件,如果找到则下载到本地仓库以备将来引用,否则 Maven 将停止处理并抛出错误(无法找到依赖的文件)。