一、Maven 核心概念
Maven 的精髓在于“约定优于配置”(Convention over Configuration)。它为项目构建提供了一套标准化的流程和结构,让我们从繁琐的配置中解放出来。
1. POM (Project Object Model)
pom.xml
是 Maven 的心脏。它是一个 XML 文件,定义了项目的所有信息,包括项目坐标、依赖、插件、构建配置等。
2. GAV - 项目坐标
项目坐标是项目在 Maven 世界中的唯一标识,由三个部分组成:
- GroupId: 项目所属的组织或公司,通常是反向域名,例如
com.google
。 - ArtifactId: 项目的唯一名称,例如
guava
。 - Version: 项目的版本号,例如
31.1-jre
。
<groupId>com.example</groupId>
<artifactId>my-app</artifactId>
<version>1.0.0-SNAPSHOT</version>
3. 依赖 (Dependencies) 与范围 (Scopes)
Maven 最强大的功能之一就是自动化的依赖管理。你只需在 POM 中声明需要的依赖,Maven 就会自动下载并管理它们。
依赖范围 (Scope) 控制了依赖在何时、何种场景下被引入到 Classpath 中。最常见的 Scope 有:
compile
: (默认) 编译、测试、运行阶段都需要。test
: 只在测试编译和运行时需要,例如 JUnit。provided
: 编译和测试时需要,但在运行时由容器(如 Tomcat)提供,例如 Servlet API。runtime
: 编译时不需要,但在测试和运行时需要,例如 JDBC 驱动。
二、构建生命周期 (Build Lifecycle)
Maven 的构建过程被抽象为一系列有序的阶段 (Phase),这就是生命周期。执行一个阶段,会触发其之前所有阶段的执行。Maven 主要有三大生命周期:
1. Clean Lifecycle - 清理生命周期
用于清理项目构建产生的文件。
pre-clean
: 执行清理前的工作。clean
: (常用) 删除上一次构建生成的target
目录。post-clean
: 执行清理后的工作。
2. Default Lifecycle - 默认生命周期 (核心)
这是最核心的生命周期,负责项目的编译、测试和打包。
阶段 (Phase) | 描述 |
---|---|
validate |
验证项目是否正确以及所有必要信息是否可用。 |
compile |
(常用) 编译项目的源代码 (src/main/java )。 |
test |
(常用) 使用合适的单元测试框架运行测试 (src/test/java )。 |
package |
(常用) 将编译后的代码打包成可分发的格式,如 JAR, WAR。 |
verify |
对集成测试的结果进行检查,以保证质量。 |
install |
(常用) 将打好的包安装到本地 Maven 仓库 (.m2 目录),供其他本地项目依赖。 |
deploy |
(常用) 将最终的包复制到远程仓库,供其他开发者或项目共享。 |
插件与生命周期的关系:生命周期本身只是一系列抽象的阶段。真正执行任务的是 Maven 插件 (Plugin)。每个阶段都绑定了一个或多个插件的目标 (Goal)。例如,compile
阶段默认绑定了 maven-compiler-plugin
的 compile
目标。
三、常用命令与核心参数
Maven 命令的基本格式是 mvn [options] [goal(s)] [phase(s)]
。
常用命令 (即生命周期阶段)
mvn clean
: 清理项目。mvn compile
: 编译项目。mvn test
: 运行单元测试。mvn package
: 打包项目。mvn install
: 安装到本地仓库。mvn clean install
: (最常用组合) 先清理,然后打包并安装到本地。
核心命令行参数
参数 | 全称 | 描述与示例 |
---|---|---|
-pl |
--projects |
(多模块必备) 指定要构建的模块。:artifactId 是最便捷的语法。示例: mvn -pl :t6-manage package |
-am |
--also-make |
(多模块必备) 同时构建指定模块所依赖的模块。 示例: mvn -pl :t6-manage -am package |
-D |
--define |
定义一个系统属性。常用于跳过测试。 示例: mvn package -Dmaven.test.skip=true |
-P |
--activate-profiles |
激活在 POM 中定义的 Profile。 示例: mvn package -P prod |
-f |
--file |
指定要使用的 POM 文件路径。 示例: mvn -f /path/to/another/pom.xml package |
-U |
--update-snapshots |
强制检查远程仓库的 SNAPSHOT 版本更新。 示例: mvn install -U |
-T |
--threads |
(提升性能) 开启多线程构建。可以指定线程数或核数倍率。 示例: mvn -T 4 install (使用4个线程) 或 mvn -T 1C install (每个CPU核心使用1个线程) |
四、父子项目 (多模块项目)
大型项目通常被拆分为多个子模块,由一个父 POM 来统一管理,这带来了版本统一、依赖集中管理等诸多好处。
1. 父 POM 的作用
父 POM 文件通常只做管理,packaging
类型为 pom
。其核心职责是:
<modules>
: 声明该父项目下包含了哪些子模块。<dependencyManagement>
: (极其重要) 统一管理所有子模块的依赖版本。这里只声明版本,不实际引入依赖。子模块需要时再声明,无需指定版本号。<pluginManagement>
: 统一管理所有插件的版本和配置。
<!-- 父 POM 示例 -->
<packaging>pom</packaging>
<modules>
<module>t6-api</module>
<module>t6-manage</module>
</modules>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.7.5</version>
</dependency>
</dependencies>
</dependencyManagement>
2. 子模块的 POM
子模块通过 <parent>
标签继承父 POM。当需要使用父 POM 中定义的依赖时,只需声明 `groupId` 和 `artifactId` 即可。
<!-- 子模块 t6-manage 的 POM -->
<parent>
<groupId>com.example</groupId>
<artifactId>t6-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<artifactId>t6-manage</artifactId>
<dependencies>
<!-- 无需指定版本,会自动从父POM继承 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
打包与依赖关系:当模块 A 依赖于模块 B 时 (<dependency><artifactId>B</artifactId></dependency>
),在构建 A 之前,必须确保 B 已经被构建并安装到本地仓库 (通过 `mvn install`),或者 B 在本次构建的反应堆 (Reactor) 中。这就是为什么 -am
参数如此重要。
五、专家级知识点与最佳实践
1. 解密依赖冲突:`mvn dependency:tree`
项目中最大的噩梦之一是依赖冲突 (例如引入了两个不同版本的 `guava`)。dependency:tree
是你的救星!
这个命令可以清晰地打印出当前项目的所有依赖以及它们的传递关系,让你一眼看出冲突的来源。
# 分析当前模块的依赖树
mvn dependency:tree
# 筛选出包含特定关键字的依赖
mvn dependency:tree -Dincludes=com.google.guava
2. 规范的依赖声明:"谁使用,谁声明"
一个模块的 POM 应该明确声明所有它在代码中直接使用到的依赖。绝对不要因为某个依赖被其他模块传递进来了,就省略自己的声明。这会导致构建过程非常脆弱,就像你遇到的问题一样——全量构建能成功,部分构建就失败。
使用 `mvn dependency:analyze` 命令可以自动分析出“使用了但未声明”的依赖。
3. 使用 Profile 管理不同环境
在实际开发中,开发(dev)、测试(test)、生产(prod)环境的配置(如数据库地址)通常是不同的。<profiles>
允许你在一个 POM 文件中定义多套配置,并通过 -P
参数在构建时激活其中一套。
<profiles>
<profile>
<id>prod</id>
<properties>
<db.url>jdbc:mysql://prod-server/db</db.url>
</properties>
</profile>
</profiles>
4. BOM (Bill of Materials) - 更优雅的版本管理
当需要引入一个庞大的技术栈(如 Spring Cloud)时,手动在 dependencyManagement
中管理几十个组件的版本非常痛苦。BOM 是一个特殊的 POM 文件,它定义了一系列相互兼容的依赖版本。
你只需在 dependencyManagement
中引入这个 BOM,就可以轻松使用该技术栈的所有组件,无需再关心版本。
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>2021.0.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
5. 使用 Maven Wrapper (`mvnw`) 实现一致性构建
“在我的机器上能行”是团队协作的大敌。这通常是因为大家使用的 Maven 版本不同。Maven Wrapper 是一个脚本,它可以自动下载项目指定的 Maven 版本来执行构建,从而保证所有开发者和 CI/CD 服务器都使用完全相同的构建环境。
Spring Boot 项目默认就集成了它。以后执行命令时,使用 ./mvnw clean package
代替 mvn clean package
。