一、Maven 基础

文档摘要

一、Maven 基础一、Maven 基础引言：Maven 的魅力与价值在现代软件开发领域，项目构建、依赖管理和项目信息管理变得日益复杂。为了应对这些挑战，Apache Maven 应运而生。Maven 不仅仅是一个构建工具，更是一个强大的项目管理工具。它基于项目对象模型 (Project Object Model, POM) 的概念，通过约定优于配置的方式，极大地简化了项目构建和管理流程，提高了开发效率和团队协作效率。本章节将深入探讨 Maven 的基础知识，帮助您理解 Maven 的核心概念、工作原理以及如何使用 Maven 构建和管理项目。无论您是 Java 新手还是经验丰富的开发者，掌握 Maven 基础都是迈向高效开发的基石。

一、Maven 基础

1. 引言：Maven 的魅力与价值

在现代软件开发领域，项目构建、依赖管理和项目信息管理变得日益复杂。为了应对这些挑战，Apache Maven 应运而生。Maven 不仅仅是一个构建工具，更是一个强大的项目管理工具。它基于 项目对象模型 (Project Object Model, POM) 的概念，通过约定优于配置的方式，极大地简化了项目构建和管理流程，提高了开发效率和团队协作效率。

本章节将深入探讨 Maven 的基础知识，帮助您理解 Maven 的核心概念、工作原理以及如何使用 Maven 构建和管理项目。无论您是 Java 新手还是经验丰富的开发者，掌握 Maven 基础都是迈向高效开发的基石。

2. Maven 的核心概念：构建基石

理解 Maven 的核心概念是掌握 Maven 的关键。Maven 的核心概念包括：

项目对象模型 (POM - Project Object Model)：POM 是 Maven 的灵魂。它是一个 XML 文件 (pom.xml)，描述了项目的基本信息、构建配置、依赖关系、插件配置等。Maven 通过读取 POM 文件来了解如何构建项目。
坐标 (Coordinates)：Maven 使用坐标来唯一标识一个项目、依赖或插件。坐标由 groupId、artifactId 和 version 三个元素组成，它们共同构成了 Maven 世界中资源的唯一地址。
- groupId：组织或团队的唯一标识符，通常是域名的反转，例如 com.example。
- artifactId：项目的唯一标识符，例如 my-app。
- version：项目的版本号，例如 1.0-SNAPSHOT 或 1.0.0。
仓库 (Repository)：仓库是存储 Maven 项目构件（例如 JAR 包、POM 文件等）的地方。Maven 仓库分为三种类型：
- 本地仓库 (Local Repository)：位于开发者本地机器上的仓库，用于缓存从远程仓库下载的构件，默认路径为用户目录下的 .m2/repository。
- 中央仓库 (Central Repository)：由 Maven 社区维护的公共仓库，包含了大量的常用开源库和框架。当本地仓库找不到所需构件时，Maven 会从中央仓库下载。
- 远程仓库 (Remote Repository)：除了中央仓库之外的其他仓库，可以是公司内部搭建的私服仓库，也可以是第三方的公共仓库。
生命周期 (Lifecycle)：Maven 生命周期定义了项目构建的各个阶段。Maven 预定义了三个核心生命周期：
- clean：清理项目，删除之前构建生成的文件。
- default (或 compile)：构建项目的核心生命周期，包括编译、测试、打包、安装和部署等阶段。
- site：生成项目站点文档。
插件 (Plugin)：Maven 插件是执行实际构建任务的组件。每个构建阶段都由一个或多个插件来完成。Maven 插件提供了丰富的功能，例如编译代码、运行测试、打包文件、部署应用等。
依赖管理 (Dependency Management)：Maven 强大的依赖管理系统可以自动处理项目所需的依赖关系。通过在 POM 文件中声明依赖，Maven 可以自动下载依赖库，并解决依赖冲突和传递性依赖问题。

3. Maven 的安装与配置：准备开发环境

要使用 Maven，首先需要安装 Maven 并配置好开发环境。

3.1 安装 Maven

下载 Maven: 访问 Apache Maven 官网 https://maven.apache.org/download.cgi 下载最新版本的 Maven 二进制发行包 (Binary zip archive)。
解压 Maven: 将下载的压缩包解压到您想要安装 Maven 的目录，例如 C:\apache-maven-x.x.x (Windows) 或 /opt/apache-maven-x.x.x (Linux/macOS)。
配置环境变量:
- 设置 JAVA_HOME: 确保您的系统已经正确配置了 JAVA_HOME 环境变量，指向 JDK 的安装目录。
- 设置 M2_HOME: 新增 M2_HOME 环境变量，指向 Maven 的安装目录 (例如 C:\apache-maven-x.x.x 或 /opt/apache-maven-x.x.x)。
- 配置 PATH: 将 Maven 的 bin 目录添加到 PATH 环境变量中，例如 %M2_HOME%\bin (Windows) 或 $M2_HOME/bin (Linux/macOS)。

3.2 验证 Maven 安装

打开命令行终端 (Command Prompt 或 Terminal)，输入以下命令并执行：


mvn -v

如果 Maven 安装成功，您将看到 Maven 的版本信息、Java 版本信息和操作系统信息等。

3.3 配置 `settings.xml` (可选)

settings.xml 文件用于配置 Maven 的全局设置，例如本地仓库路径、镜像仓库、代理设置等。Maven 默认的 settings.xml 文件位于 Maven 安装目录的 conf 目录下。您可以复制该文件到用户目录下的 .m2 目录下 (例如 ~/.m2/settings.xml 或 C:\Users\YourUsername\.m2\settings.xml)，并进行自定义配置。

常用的 settings.xml 配置：

配置本地仓库路径: 默认情况下，本地仓库位于用户目录下的 .m2/repository。您可以通过修改 settings.xml 文件中的 <localRepository> 元素来更改本地仓库路径。
```
<settings>
  <localRepository>/path/to/your/local/repository</localRepository>
</settings>
```
配置镜像仓库: 如果网络环境访问中央仓库速度较慢，可以配置镜像仓库，将 Maven 从中央仓库下载构件的请求转发到镜像仓库。常用的国内 Maven 镜像仓库包括阿里云 Maven 仓库、华为云 Maven 仓库等。
```
<settings>
  <mirrors>
    <mirror>
      <id>aliyunmaven</id>
      <mirrorOf>central</mirrorOf>
      <name>阿里云公共仓库</name>
      <url>https://maven.aliyun.com/repository/public</url>
    </mirror>
  </mirrors>
</settings>
```

4. Maven 项目的创建与结构：规范的项目骨架

Maven 提倡约定优于配置，通过定义标准的项目结构，简化了项目创建和管理。

4.1 使用 Archetype 创建 Maven 项目

Maven Archetype 是 Maven 项目模板工具，可以快速生成各种类型的 Maven 项目骨架。

创建 Maven 项目的命令：


mvn archetype:generate \
    -DgroupId=com.example \
    -DartifactId=my-app \
    -DarchetypeArtifactId=maven-archetype-quickstart \
    -DinteractiveMode=false

参数说明：

archetype:generate: 执行 Archetype 插件的 generate 目标。
-DgroupId=com.example: 设置项目的 groupId 为 com.example。
-DartifactId=my-app: 设置项目的 artifactId 为 my-app。
-DarchetypeArtifactId=maven-archetype-quickstart: 指定使用的 Archetype 为 maven-archetype-quickstart，这是一个简单的 Java 应用模板。
-DinteractiveMode=false: 禁用交互模式，避免在创建过程中出现交互式提示。

执行上述命令后，Maven 将在当前目录下创建一个名为 my-app 的项目目录。

4.2 Maven 项目目录结构

使用 maven-archetype-quickstart 创建的 Maven 项目目录结构如下：


my-app/
├── pom.xml
└── src/
    ├── main/
    │   └── java/
    │       └── com/
    │           └── example/
    │               └── App.java
    └── test/
        └── java/
            └── com/
                └── example/
                    └── AppTest.java

目录结构说明：

pom.xml: 项目的 POM 文件，描述了项目的配置信息。
src/main/java: 存放项目的主要 Java 源代码。
src/test/java: 存放项目的测试 Java 源代码。
src/main/resources: 存放项目的主要资源文件，例如配置文件、静态资源等。
src/test/resources: 存放项目的测试资源文件。
target/: Maven 构建输出目录，存放编译后的 class 文件、打包后的 JAR/WAR 文件等 (默认情况下，该目录在构建后生成)。

Graph TD 图示 Maven 项目结构：

5. POM 文件详解：项目的配置中心

pom.xml 文件是 Maven 项目的核心配置文件，它包含了项目的各种配置信息。理解 pom.xml 文件的结构和元素是使用 Maven 的关键。

5.1 `pom.xml` 基本结构

一个基本的 pom.xml 文件结构如下：


<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>my-app</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>My App</name>
    <description>A simple Maven application</description>
    <dependencies>
        <!-- 依赖声明 -->
    </dependencies>
    <build>
        <!-- 构建配置 -->
    </build>
</project>

5.2 `pom.xml` 常用元素详解

<modelVersion>: POM 模型的版本，固定值为 4.0.0。
<groupId>, <artifactId>, <version>: 项目的坐标，用于唯一标识项目。
<packaging>: 项目的打包方式，常用的值包括：
- jar: Java 归档文件，用于 Java 类库项目。
- war: Web 应用程序归档文件，用于 Web 项目。
- pom: POM 项目，用于聚合项目或父项目。
<name>: 项目的名称，用于在 Maven 生成的报告和站点文档中显示。
<description>: 项目的描述，用于在 Maven 生成的报告和站点文档中显示。
<url>: 项目的 URL 地址，用于在 Maven 生成的报告和站点文档中显示。
<properties>: 自定义属性，可以在 POM 文件中定义一些属性，然后在其他地方引用这些属性，方便统一管理配置。
```
<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <java.version>1.8</java.version>
</properties>
```

<dependencies>: 依赖声明，用于声明项目所需的依赖库。每个依赖使用 <dependency> 元素进行声明。


<dependencies>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
  </dependency>
</dependencies>

<build>: 构建配置，用于配置项目的构建过程，例如指定源代码目录、资源文件目录、插件配置等。


<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.8.1</version>
      <configuration>
        <source>${java.version}</source>
        <target>${java.version}</target>
        <encoding>${project.build.sourceEncoding}</encoding>
      </configuration>
    </plugin>
  </plugins>
</build>

6. Maven 的生命周期：构建流程自动化

Maven 生命周期定义了项目构建的各个阶段，Maven 按照预定义的生命周期阶段顺序执行构建任务。Maven 的生命周期分为三个核心生命周期：clean、default 和 site。

6.1 Clean 生命周期

Clean 生命周期用于清理项目，它包含以下阶段：

pre-clean: 执行一些清理前准备工作。
clean: 清理项目工作目录中的生成文件，例如 target 目录。
post-clean: 执行一些清理后收尾工作。

常用命令：


mvn clean

6.2 Default (或 Compile) 生命周期

Default 生命周期是 Maven 构建的核心生命周期，用于构建项目，它包含以下常用阶段 (按顺序执行)：

validate: 验证项目 POM 文件是否正确，项目环境是否配置正确。
compile: 编译项目源代码。
process-resources: 处理项目资源文件，例如将资源文件复制到输出目录。
test-compile: 编译项目测试源代码。
process-test-resources: 处理项目测试资源文件。
test: 运行单元测试。
package: 将编译后的代码和资源打包成可发布的格式，例如 JAR、WAR 等。
install: 将打包后的构件安装到本地仓库。
deploy: 将打包后的构件部署到远程仓库。

常用命令：

mvn compile: 编译项目源代码。
mvn test: 运行单元测试。
mvn package: 打包项目。
mvn install: 安装项目到本地仓库。
mvn deploy: 部署项目到远程仓库。

6.3 Site 生命周期

Site 生命周期用于生成项目站点文档，它包含以下阶段：

pre-site: 执行一些站点生成前准备工作。
site: 生成项目站点文档。
post-site: 执行一些站点生成后收尾工作。
site-deploy: 将生成的站点文档部署到站点服务器。

常用命令：


mvn site
mvn site-deploy

Graph TD 图示 Maven 生命周期：

生命周期阶段执行顺序：

当您执行一个 Maven 命令时，例如 mvn package，Maven 会自动执行该生命周期阶段之前的所有阶段。例如，执行 mvn package 命令，Maven 会依次执行 validate、compile、process-resources、test-compile、process-test-resources、test 和 package 阶段。

7. Maven 的依赖管理：简化依赖配置

Maven 强大的依赖管理系统是其核心优势之一。通过在 pom.xml 文件中声明依赖，Maven 可以自动下载、管理和解决项目依赖问题。

7.1 依赖声明

在 pom.xml 文件的 <dependencies> 元素中，使用 <dependency> 元素声明项目依赖。每个 <dependency> 元素需要指定依赖的坐标 (groupId、artifactId、version)。


<dependencies>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.12.0</version>
  </dependency>
</dependencies>

7.2 依赖范围 (Scope)

依赖范围 (Scope) 用于控制依赖在不同构建阶段的可见性和作用域。常用的依赖范围包括：

compile (默认)：编译范围，在编译、测试、运行阶段都有效。
test: 测试范围，只在测试阶段有效，用于测试代码的依赖，例如 JUnit。
provided: 已提供范围，在编译和测试阶段有效，但在运行时由容器或 JDK 提供，例如 Servlet API。
runtime: 运行时范围，在测试和运行阶段有效，但在编译阶段不需要，例如 JDBC 驱动。
system: 系统范围，类似于 provided，但需要显式指定依赖的系统路径，不推荐使用。
import: 导入范围，只在 <dependencyManagement> 中使用，用于导入其他 POM 文件的依赖配置。

7.3 传递性依赖

Maven 支持传递性依赖，即如果项目 A 依赖于项目 B，项目 B 又依赖于项目 C，那么项目 A 也会间接依赖于项目 C。Maven 会自动解析和下载传递性依赖。

7.4 依赖冲突解决

当项目存在多个依赖，并且这些依赖之间存在版本冲突时，Maven 会根据 最近依赖原则 和 路径最近原则 来解决依赖冲突。

最近依赖原则: 当同一个构件存在多个版本时，POM 文件中直接声明的依赖版本优先级高于传递性依赖的版本。
路径最近原则: 当依赖路径长度不同时，路径最短的依赖版本优先级最高。

您可以使用 mvn dependency:tree 命令查看项目的依赖树，分析依赖关系和冲突。

8. Maven 常用命令：提升开发效率

掌握 Maven 常用命令可以极大地提升开发效率。以下是一些常用的 Maven 命令：

mvn clean: 清理项目。
mvn compile: 编译项目源代码。
mvn test: 运行单元测试。
mvn package: 打包项目。
mvn install: 安装项目到本地仓库。
mvn deploy: 部署项目到远程仓库。
mvn site: 生成项目站点文档。
mvn dependency:tree: 查看项目依赖树。
mvn dependency:analyze: 分析项目依赖，找出未使用或未声明的依赖。
mvn help:effective-pom: 查看项目生效的 POM 配置。
mvn help:describe -Dplugin=插件名 -Dgoal=目标名: 查看插件目标的使用帮助。

9. Maven 插件：扩展构建功能

Maven 插件是 Maven 的扩展机制，通过插件可以扩展 Maven 的构建功能。Maven 插件分为 构建插件 (Build Plugin) 和 报告插件 (Reporting Plugin)。

构建插件: 在构建生命周期中执行，用于完成实际的构建任务，例如编译、打包、测试等。
报告插件: 在站点生命周期中执行，用于生成项目报告，例如项目站点文档、代码质量报告等。

常用的 Maven 插件：

maven-compiler-plugin: 用于编译 Java 源代码。
maven-surefire-plugin: 用于运行单元测试。
maven-jar-plugin: 用于打包 JAR 文件。
maven-war-plugin: 用于打包 WAR 文件。
maven-deploy-plugin: 用于部署构件到远程仓库。
maven-site-plugin: 用于生成项目站点文档。
jacoco-maven-plugin: 用于生成代码覆盖率报告。
checkstyle-maven-plugin: 用于代码风格检查。

插件配置通常在 pom.xml 文件的 <build> 元素的 <plugins> 子元素中进行配置。


<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <version>3.8.1</version>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
      </configuration>
    </plugin>
  </plugins>
</build>

10. 总结：Maven 基础回顾与展望

本章节深入探讨了 Maven 的基础知识，包括 Maven 的核心概念、安装配置、项目创建、POM 文件详解、生命周期、依赖管理、常用命令和插件等。掌握这些基础知识是使用 Maven 进行项目构建和管理的关键。

Maven 作为一款强大的项目管理工具，在软件开发中扮演着至关重要的角色。通过学习和实践 Maven 基础，您可以：

标准化项目结构: 使用 Maven Archetype 创建规范的项目骨架，提高项目可维护性和可读性。
自动化构建流程: 利用 Maven 生命周期和插件，实现项目构建流程的自动化，减少手动操作，提高构建效率。
高效依赖管理: 通过 Maven 依赖管理系统，简化依赖配置，解决依赖冲突，提高依赖管理的效率和可靠性。
提升团队协作: Maven 的约定优于配置和项目管理功能，有助于团队成员更好地协作，提高开发效率和代码质量。

在未来的学习和工作中，您可以继续深入学习 Maven 的高级特性，例如 Maven Profile、Reactor 构建、多模块项目管理、自定义插件开发等，进一步提升 Maven 的应用能力，更好地应对复杂的项目构建和管理挑战。

希望本章节的内容能够帮助您扎实 Maven 基础，开启高效的 Maven 开发之旅！

作者与出处

原作者：灏天文库

来源：灏天文库

原文： https://aiknowledge.cn/collection/210-maven%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%E4%B8%8E%E7%AE%A1%E7%90%86%E6%95%99%E7%A8%8B

整理：灏天文库整理

由灏天文库平台收录，内容或由平台用户上传，仅供学习交流

一、Maven 基础

文档摘要

一、Maven 基础

一、Maven 基础

1. 引言：Maven 的魅力与价值

2. Maven 的核心概念：构建基石

3. Maven 的安装与配置：准备开发环境

3.1 安装 Maven

3.2 验证 Maven 安装

3.3 配置 settings.xml (可选)

4. Maven 项目的创建与结构：规范的项目骨架

4.1 使用 Archetype 创建 Maven 项目

4.2 Maven 项目目录结构

5. POM 文件详解：项目的配置中心

5.1 pom.xml 基本结构

5.2 pom.xml 常用元素详解

6. Maven 的生命周期：构建流程自动化

6.1 Clean 生命周期

6.2 Default (或 Compile) 生命周期

6.3 Site 生命周期

7. Maven 的依赖管理：简化依赖配置

7.1 依赖声明

7.2 依赖范围 (Scope)

7.3 传递性依赖

7.4 依赖冲突解决

8. Maven 常用命令：提升开发效率

9. Maven 插件：扩展构建功能

10. 总结：Maven 基础回顾与展望

3.3 配置 `settings.xml` (可选)

5.1 `pom.xml` 基本结构

5.2 `pom.xml` 常用元素详解