异常教程

Maven 构建生命周期（保姆级教程）

更新时间:

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

  • 新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;
  • 《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前， 星球 内专栏累计输出 82w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 2900+ 小伙伴加入学习 ，欢迎点击围观

前言

在现代软件开发中，构建工具是开发者日常工作中不可或缺的“工具箱”。Maven 作为 Java 生态中广泛使用的构建工具，其核心特性之一便是构建生命周期（Build Lifecycle）。无论是初学者还是中级开发者，理解 Maven 的构建生命周期，不仅能提升项目管理效率，还能避免因构建流程混乱导致的常见问题。本文将通过循序渐进的方式，结合实际案例，深入解析 Maven 构建生命周期的原理、阶段划分及应用场景。

Maven 构建生命周期概述

什么是构建生命周期？

Maven 的构建生命周期是一套预定义的、有序的阶段（Phases），每个阶段对应特定的构建任务。开发者通过执行生命周期中的某个阶段，可以触发一系列预设的构建动作（如编译代码、运行测试、打包应用等）。

核心特性：

  • 标准化流程：Maven 提供了统一的阶段划分，确保不同项目遵循相同的构建逻辑。
  • 插件驱动：每个阶段的实现依赖于插件（Plugin），开发者可通过自定义插件扩展或修改流程。
  • 可组合性：生命周期阶段可按需组合，实现复杂构建需求。

Maven 的三个内置生命周期

Maven 内置了三个独立的构建生命周期，分别解决不同的需求：

生命周期名称主要用途常见场景
clean清理构建产物开始新构建前删除旧文件
default核心构建流程（编译、测试、打包）日常开发与发布
site生成项目文档创建 API 文档或项目报告

类比理解：

  • clean 阶段就像整理房间前的“清空桌面”动作，确保新任务不受旧文件干扰。
  • default 是整个构建过程的“主生产线”，从原材料（源代码）到成品（可执行 JAR）。
  • site 则类似制作项目手册，帮助团队成员快速理解项目结构。

Clean 生命周期：构建前的“清理”

阶段与目标

clean 生命周期包含一个核心阶段：clean。其主要目标是删除项目生成的临时文件和构建产物（如 target/ 目录）。

执行命令：

mvn clean

实际案例

假设项目目录结构如下：

my-project/  
├── src/  
├── target/  # 由 Maven 自动生成的目录  
│   ├── classes/  
│   └── surefire-reports/  
└── pom.xml

执行 mvn clean 后，target/ 目录及其子文件将被删除，确保后续构建基于干净环境。

Default 生命周期：核心构建流程

default 生命周期是 Maven 最关键的构建流程，包含多个阶段，每个阶段依次触发，形成完整的构建链。

阶段详解（按执行顺序）

阶段名称目标描述常见操作示例
validate验证项目是否具备构建条件检查依赖是否完整
compile编译项目源代码将 src/main/java 编译为 .class 文件
test运行单元测试使用 JUnit 或 TestNG 执行测试
package将编译后的代码打包为可分发格式生成 JAR、WAR 或 ZIP 文件
verify验证构建产物是否符合质量标准运行集成测试或代码扫描
install将构建产物安装到本地 Maven 仓库方便其他项目引用
deploy将构建产物部署到远程仓库（如 Nexus）用于团队共享或生产发布

流程类比：
将 Default 生命周期想象为一条汽车生产线：

  1. validate：检查零件是否齐全（依赖是否存在）。
  2. compile：组装车身（编译代码）。
  3. test：进行路测（运行单元测试）。
  4. package：贴上标签（生成可分发的 JAR 包）。
  5. install：存入仓库（本地 Maven 仓库）。

实战案例：从代码到 JAR 包

1. 创建一个简单 Maven 项目

在 pom.xml 中定义基础配置：

<project>  
  <modelVersion>4.0.0</modelVersion>  
  <groupId>com.example</groupId>  
  <artifactId>demo-project</artifactId>  
  <version>1.0-SNAPSHOT</version>  
  <packaging>jar</packaging>  
</project>

2. 执行 mvn package

mvn package

执行结果：

  • compile：编译 src/main/java 中的代码到 target/classes/。
  • test：运行测试代码（若存在 src/test/java）。
  • package：生成 target/demo-project-1.0-SNAPSHOT.jar。

3. 安装到本地仓库

执行 mvn install 将触发 install 阶段，将 JAR 文件复制到本地仓库路径（如 ~/.m2/repository/com/example/demo-project/1.0-SNAPSHOT/）。

Site 生命周期：生成项目文档

阶段与用途

site 生命周期包含两个核心阶段：

  • site：生成项目站点内容（如 API 文档、依赖列表）。
  • deploy：将生成的站点内容部署到远程服务器。

典型场景：

mvn site  # 生成文档  
mvn site:deploy  # 部署到指定服务器

示例：生成项目 API 文档

在 pom.xml 中添加 maven-javadoc-plugin 配置：

<build>  
  <plugins>  
    <plugin>  
      <groupId>org.apache.maven.plugins</groupId>  
      <artifactId>maven-javadoc-plugin</artifactId>  
      <version>3.5.0</version>  
    </plugin>  
  </plugins>  
</build>

执行 mvn site 后，生成的 HTML 文档将位于 target/site/apidocs/ 目录中。

自定义构建流程：插件与阶段扩展

插件的作用

Maven 的灵活性源于其插件系统。每个生命周期阶段的实现，本质是调用插件的目标（Goal）。例如，compile 阶段默认调用 maven-compiler-plugin:compile。

添加自定义阶段

开发者可通过 maven-surefire-plugin 自定义测试行为：

<plugin>  
  <groupId>org.apache.maven.plugins</groupId>  
  <artifactId>maven-surefire-plugin</artifactId>  
  <version>3.0.0-M5</version>  
  <configuration>  
    <includes>  
      <include>**/*Test.java</include>  
    </includes>  
  </configuration>  
</plugin>

示例：添加资源复制阶段

若需在编译前复制资源文件，可在 pom.xml 中绑定插件到 process-resources 阶段：

<plugin>  
  <groupId>org.apache.maven.plugins</groupId>  
  <artifactId>maven-resources-plugin</artifactId>  
  <version>3.3.0</version>  
  <executions>  
    <execution>  
      <phase>process-resources</phase>  
      <goals>  
        <goal>copy-resources</goal>  
      </goals>  
      <configuration>  
        <resources>  
          <resource>  
            <directory>src/main/config</directory>  
          </resource>  
        </resources>  
      </configuration>  
    </execution>  
  </executions>  
</plugin>

常见问题与解决方案

问题 1：依赖未被正确下载

现象：编译时报 ClassNotFoundException。
解决：检查 pom.xml 中依赖的 groupId、artifactId 是否正确，或执行 mvn clean install 强制重新下载依赖。

问题 2：测试阶段失败阻断构建

解决：若需跳过测试，可在命令行中添加 -DskipTests：

mvn install -DskipTests

问题 3：自定义插件未生效

原因：插件未绑定到正确阶段。
解决：检查 <executions> 配置中的 <phase> 是否与目标阶段一致。

结论

Maven 构建生命周期是项目自动化构建的核心机制，其标准化的阶段划分和插件扩展能力，为开发者提供了高效、可复用的构建流程。通过理解 clean、default、site 三个生命周期的差异，开发者可以：

  1. 快速定位构建失败原因（如依赖问题或资源未复制）。
  2. 自定义构建流程以满足特定需求（如多环境打包）。
  3. 通过文档生成提升团队协作效率。

建议读者通过实际项目练习，逐步掌握各阶段的执行逻辑。例如，尝试修改 maven-compiler-plugin 的 source 和 target 版本，观察对编译结果的影响。掌握 Maven 构建生命周期，不仅能提升个人开发效率，更是迈向专业级项目管理的关键一步。

最新发布

查看更多文章