Maven 项目管理构建工具详解

￡神魔★判官ぃ 2023-10-10 21:33 41阅读 0赞

### 一、Maven 基础概念 ###

1.1 Maven 简介

Maven 是一个基于项目对象模型（POM）的项目管理和构建工具。Maven 通过一系列的标准化的插件和约定来帮助开发人员管理项目中的依赖库、构建产物、文档等各种资源。Maven 可以轻松构建 Java 应用程序、Web 应用程序和其他项目类型。

1.2 POM 概念

POM（Project Object Model）是 Maven 的核心概念之一，它是 Maven 构建系统的基础。每个 Maven 项目都必须有一个 pom.xml 文件，该文件描述了项目的结构、依赖关系、构建方式等详细信息。POM 通常包含以下内容：

*  项目名称、版本、描述等基本信息；
 *  依赖库、插件等构建工具；
 *  构建过程中需要执行的目标、生命周期、阶段等；
 *  统一的存储依赖库和插件下载地址。

1.3 Maven 仓库

Maven 仓库是 Maven 中用来存放依赖库和插件的地方。Maven 仓库分为本地仓库和远程仓库两种类型。

*  本地仓库是指位于本地计算机上的存储库，用于存放本地计算机上 Maven 项目所需的依赖库和插件。
 *  远程仓库则是指位于远程服务器上的存储库，用于存放多个开发者和开发团队共享的依赖库、插件、构建产物等。

### 二、Maven 的使用流程 ###

Maven 的使用流程通常包含以下几个步骤：

2.1 安装 Maven

首先需要在本地计算机上安装 Maven，可以从 Maven 官网（[https://maven.apache.org/）下载对应版本的][https_maven.apache.org] Maven，并根据安装步骤进行安装。

2.2 创建 Maven 项目

创建 Maven 项目的方式有多种，可以通过 Maven Archetype 或手动创建 pom.xml 文件等方式来创建。在创建 Maven 项目时需要确定项目的结构、依赖库、构建方式等相关内容，并对 pom.xml 文件进行配置。

2.3 构建 Maven 项目

在 Maven 中，构建项目通常包含“清理”、“编译”、“测试”、“打包”等多个阶段。Maven 提供了一系列标准化的生命周期和阶段，可以方便开发人员自定义构建过程。在构建 Maven 项目之前需要确保 Maven 仓库中已经存在所需的依赖库和插件。

2.4 安装、部署构建产物

通过 Maven 构建项目后，可以将构建产物安装到本地 Maven 仓库或发布到远程 Maven 仓库中，以便其他开发人员和团队共享使用。可以使用 Maven 提供的命令或插件来完成安装、部署构建产物的操作。

### 三、Maven 的核心概念 ###

3.1 坐标（Coordinate）

在 Maven 中，坐标是用于唯一标识一个项目的重要元素。坐标通常包含以下几个部分：

*  groupId：项目所属的组织或机构名；
 *  artifactId：项目的名称；
 *  version：项目的版本号；
 *  packaging：项目的打包方式，默认为 jar。

例如，org.springframework:spring-core:5.3.10.RELEASE 就是 Spring Framework 的一个依赖库坐标。

3.2 依赖库（Dependency）

依赖库是指用于构建 Java 项目时所需的类库、框架、工具等资源。在 Maven 中，通过在 pom.xml 文件中声明依赖库坐标的方式来管理依赖库。Maven 会自动解析依赖库，并将需要的依赖库下载到本地仓库，并根据依赖关系进行传递性依赖的管理。

例如：

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>5.3.10.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>5.8.0-M1</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

3.3 插件（Plugin）

插件是一种用于扩展 Maven 功能的机制。在 Maven 中，插件通常包含一个或多个目标（Goal），每个目标对应着 Maven 构建过程中的一个生命周期和阶段。通过在 pom.xml 文件中声明插件坐标及相应目标的配置，可以将额外的功能集成到 Maven 构建过程中。

例如：

上面的代码中，maven-compiler-plugin 是用于 Maven 编译过程的一个插件，它包含了一个名为 compile 的目标，用于对 Java 源码进行编译。

3.4 仓库（Repository）

仓库是用于存放依赖库、插件等资源的地方。在 Maven 中，有两种类型的仓库：本地仓库和远程仓库。Maven 运行时会先在本地仓库中查找所需的依赖库和插件，如果本地仓库中没有，则会到远程仓库中获取。

本地仓库默认位于用户目录下的 .m2 目录，在 Windows 系统下通常为 C:\\Users\{user\}.m2，而在 Linux 系统下通常为 ~/.m2。

3.5 生命周期（Lifecycle）

Maven 将构建过程划分为一系列阶段（Phase），每个阶段都包含多个目标（Goal），并按照一定的顺序执行。Maven 提供了一套标准化的生命周期模型，在生命周期中定义了一些默认的阶段及其执行顺序，可以通过配置 pom.xml 文件来定义自己的构建生命周期，或重载默认生命周期模型。例如，Maven 标准化的生命周期包括：clean、default、site 等。

3.6 描述符（Descriptor）

描述符（Descriptor）是用于描述 Maven 项目的元数据文件。Maven 描述符通常指 pom.xml 文件，它描述了一个 Maven 项目的结构、依赖关系、构建方式等详细信息。Maven 描述符还可以包含 profile、build 等其他元素。

### 四、Maven 常用命令 ###

在使用 Maven 进行开发和构建项目时，常用的 Maven 命令有：

*  mvn clean：清理项目的 target 目录；
 *  mvn compile：编译项目源代码；
 *  mvn test：对项目进行单元测试；
 *  mvn package：打包项目，生成 jar 或 war 包；
 *  mvn install：安装项目到本地仓库；
 *  mvn deploy：发布项目到远程仓库；
 *  mvn archetype:generate：生成 Maven 项目模板；
 *  mvn dependency:tree：查看项目依赖树；
 *  mvn help：查看 Maven 帮助信息。

以上是一些比较常用的 Maven 命令，更多 Maven 命令可以通过 mvn --help 命令查看。

### 五、MAVEN配置 ###

##### 1. settings.xml 配置文件 #####

1.1 介绍

settings.xml 是 Maven 的主要配置文件之一，用于配置 Maven 运行时的默认参数和全局设置。settings.xml 文件位于 MAVEN\_HOME/conf 目录下，也可以放到用户目录下的 .m2 目录中，使得每个用户都可以针对自己的需要进行特定的配置。

1.2 常用配置项

1.2.1 localRepository

localRepository 配置项用于指定本地仓库的路径。本地仓库是 Maven 下载和存储依赖库、插件等资源的地方，默认情况下位于用户目录下的 .m2/repository 目录中。

例如：

<settings>
      <localRepository>/path/to/local/repo</localRepository>
    </settings>

1.2.2 mirrors

mirrors 配置项用于指定 Maven 的镜像仓库，可以加快 Maven 的下载速度。当 Maven 下载资源时，它会优先访问 mirrors 中配置的镜像地址，如果找不到则访问原始仓库地址。mirrors 配置可以同时指定多个镜像仓库。

例如：

<settings>
      <mirrors>
        <mirror>
          <id>aliyunmaven</id>
          <name>阿里云公共仓库</name>
          <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
          <mirrorOf>*</mirrorOf>
        </mirror>
      </mirrors>
    </settings>

1.2.3 servers

servers 配置项用于指定 Maven 访问需要认证的服务器的用户名和密码。当 Maven 访问需要认证的服务器时，它会使用 servers 中配置的用户名和密码进行身份验证。

例如：

<settings>
      <servers>
        <server>
          <id>my-server</id>
          <username>my-username</username>
          <password>my-password</password>
        </server>
      </servers>
    </settings>

1.2.4 proxies

proxies 配置项用于指定 Maven 访问 Web 代理服务器的相关信息。当 Maven 访问 Web 网站时，会首先访问 proxies 中配置的 Web 代理服务器，然后再访问目标 Web 服务器。

例如：

<settings>
      <proxies>
        <proxy>
          <id>my-proxy</id>
          <active>true</active>
          <protocol>http</protocol>
          <host>proxy.example.com</host>
          <port>8080</port>
          <nonProxyHosts>localhost|127.0.0.1</nonProxyHosts>
          <username>my-username</username>
          <password>my-password</password>
          <ntlmHost>my-ntlm-host</ntlmHost>
          <ntlmDomain>my-ntlm-domain</ntlmDomain>
        </proxy>
      </proxies>
    </settings>

1.2.5 profiles

profiles 配置项用于定义不同的 Maven 配置文件。根据不同的 profiles，Maven 可以使用不同的配置文件，以满足不同项目的需求。profiles 配置文件可以通过 activeProfiles 激活，并且可以包含 settings.xml 中的大部分配置项。

例如：

<settings>
      <profiles>
        <profile>
            <id>test</id>
            <properties>
                <test.prop>test</test.prop>
            </properties>
            <repositories>
                <repository>
                    <id>central</id>
                    <url>http://central</url>
                </repository>
            </repositories>
        </profile>
      </profiles>
      <activeProfiles>
          <activeProfile>test</activeProfile>
      </activeProfiles>
    </settings>

##### 2、pom.xml 配置文件 #####

2.1 介绍

pom.xml 是 Maven 项目的主要配置文件，用于描述项目的结构、依赖关系、构建方式等详细信息。pom.xml 文件位于项目的根目录下，可以通过编辑该文件来修改项目的配置信息。

2.2 常用配置项

2.2.1 groupId

groupId 配置项用于指定项目的组织或者机构名称。

例如：

<groupId>com.example</groupId>

2.2.2 artifactId

artifactId 配置项用于指定项目的名称。

例如：

<artifactId>my-project</artifactId>

2.2.3 version

version 配置项用于指定项目的版本号。

例如：

2.2.4 dependencies

dependencies 配置项用于配置项目所依赖的库、框架等资源。Maven 会根据这些依赖关系自动下载和安装相应的资源。

例如：

其中，scope 指定了该依赖库的作用域，常用的作用域包括：

*  compile：默认值，表示该依赖库需要在编译时被引入；
 *  provided：表示该依赖库已经被目标环境（如 Web 容器）提供，不需要在编译时被引入；
 *  test：表示该依赖库只在测试时被引入。

2.2.5 build

build 配置项用于定义 Maven 的构建过程。可以在该配置中定义 plugin、resources 等节点。

例如：

其中，plugins 节点定义了插件的相关配置信息，例如上面的代码中，maven-compiler-plugin 用于指定 Java 源码的编译版本。

2.2.6 repositories

repositories 配置项用于定义 Maven 的依赖库仓库。可以在该配置中定义 maven-central、maven-snapshots 等节点，或者自定义的仓库地址。

例如：

<repositories>
        <repository>
            <id>my-repo</id>
            <name>My Repository</name>
            <url>http://myrepo.com/repo</url>
         </repository>
    </repositories>

其中，id 节点用于定义仓库的唯一标识符，name 节点用于定义仓库的名称，url 节点用于定义仓库的地址。

2.2.7 distributionManagement

distributionManagement 配置项用于定义项目构建产物的分发方式。通常用于定义项目构建打包后发布到远程仓库的配置。

例如：

<distributionManagement>
        <repository>
            <id>my-repo</id>
            <url>http://myrepo.com/releases</url>
        </repository>
        <snapshotRepository>
            <id>my-repo</id>
            <url> http://myrepo.com/snapshots</url>
        </snapshotRepository>
        <site>
            <id>my-site</id>
            <url>http://mysite.com</url>
        </site>
    </distributionManagement>

其中，repository 和 snapshotRepository 分别定义了项目构建产物在远程仓库的发布地址，site 定义了项目的站点信息。

2.2.8 plugins

plugins 配置项用于配置 Maven 的插件。可以在该配置中定义各种需要使用的插件，例如编译插件、打包插件等。

例如：

<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>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <mainClass>com.example.demo.Application</mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>

其中，maven-compiler-plugin 插件用于指定 Java 源码的编译版本，maven-jar-plugin 插件用于将 Java 源码打包成 jar 文件。

[https_maven.apache.org]: https://maven.apache.org/%EF%BC%89%E4%B8%8B%E8%BD%BD%E5%AF%B9%E5%BA%94%E7%89%88%E6%9C%AC%E7%9A%84