maven基础

https://javaguide.cn/tools/maven/maven-core-concepts.html

什么是 Maven

Maven 是一种用来管理 Java 项目的工具，但不是那种用来管理资源规划和调度的工具。 相反，它处理的是管理一个具体的项目所涉及的各种任务，如编译、测试、打包、文档以及分发。

Maven 包括以下的几个部分。

• 一组用于处理依赖管理、目录结构以及构建工作流的约定。

  • 基于这些约定实现的标准化 ，可以极大地简化开发过程。例如，一个常用的目录结构使得开发者可以更加容易地跟上不熟悉的项目的节奏。

• 一个用于项目配置的XML Schema：项目对象模型（Project Object Model），简称POM①。

  • 每一个Maven项目都拥有一个POM文件 ，默认命名为pom.xml，包含了Maven用于管理 该项目的所有的配置信息。

• 一个委托外部组件来执行项目任务的插件架构。

  • 这简化了更新以及扩展 Maven 能力的过程。

Maven 的基本概念

标准的目录结构

POM大纲

构建

任何可以被 Maven 的坐标系统（参见接下来的关于 GAV 坐标的讨论）唯一标识的对象都是一个 Maven 构件。

• 大多数情况下，构件是构建 Maven 项目所生成的文件，如 JAR。

• 但是，只包 含其他 POM（该文件本身并不产生构件）使用的定义的 POM 文件也是 Maven 构件。

• Maven 构件的类型由其 POM 文件的<packaging>元素指定。最常用的值是 pom、jar、 ear、war 以及 maven-plugin

POM 文件的用例

可以通过以下的方式来使用 POM 文件。

• 默认的——用于构建一个构件。

• 父 POM——提供一个由子项目继承的单个配置信息源——声明这个 POM 文件作为它们 的<parent>元素的值。

• 聚合器——用于构建一组声明为<modules>的项目，这些子项目位于其当前聚合器项目的文件夹中，每个都包含有它自己的 POM 文件。

作为父 POM 或者聚合器的 POM 文件的<packaging>元素的值将是 pom。注意，一个 POM

文件可能同时提供两项功能。

GAV 坐标

POM 定义了 5 种称为坐标的元素，用于标识 Maven 构件。首字母缩写 GAV 指的是必须始终指定的 3 个坐标<groupId>、<artifactId>以及<version>的首字

1. <groupId>是项目或者项目组的全局的唯一标识符。这通常是 Java 源代码中使用的全限定的 Java 包名。例如，io.netty、com.google。

2. <artifactId>用于标识和某个<groupId>相关的不同的构件。例如，netty-all、 netty-handler。

3. <type>是指和项目相关的主要构件的类型（对应于构件的 POM 文件中的<packaging> 值）。它的默认值是 jar。例如，pom、war、ear。

4. <version>标识了构件的版本。例如，1.1、2.0-SNAPSHOT①POM 文件必须声明它所管理的构件的坐标。一个具有如下坐标的项目： 、4.1.9.Final。

5. <classifier>用于区分属于相同的 POM 但是却被以不同的方式构建的构件。例如，javadoc、sources、jdk16、jdk17

一个GAV

<groupId>io.netty</groupId> 
<artifactId>netty-all</artifactId> 
<version>4.1.9.Final</version> 
<packaging>jar</packaging>

在这种情况下，它将产生这个构件：

netty-all
-4.1.9.Final.jar

依赖

项目的依赖是指编译和执行它所需要的外部构件

在大多数情况下，你的项目的依赖项也会有它自己的依赖。我们称这些依赖为你的项目的传递依赖。一个复杂的项目可能会有一个深层级 的依赖树；Maven提供了各种用于帮助理解和管理它的工具。

<dependencies> 
    <dependency> 
        <groupId/> 
        <artifactId/> 
        <version/> 
        <type/> 
        <scope/> 
        <systemPath/> 
    </dependency> 
    ... 
</dependencies>

type以及scope元素对于那些值不分别是默认值jar和compile的依赖来说也是必需的

<scope>元素可以具有以下值

• compile—编译和执行需要的（默认值）。

• runtime—只有执行需要。

• optional——不被引用了这个项目所产生的构件的其他项目，视为传递依赖。

• provided——不会被包含在由这个 POM 产生的 WAR 文件的 WEB_INF/lib 目录中。

• test——只有编译和测试的执行需要。

• import——这将在后面的“依赖管理”一节进行讨论。

<systemPath>元素用来指定文件系统中的绝对位置。

依赖管理

引用了<dependencyManagement>元素的项目可以使用它所声明的依赖，而不需要指定它们的<version>坐标。如果<dependencyManagement>中的<version>在稍后有所改变，则它将被所有引用它的 POM 拾起。

在下面的示例中，所使用的 Netty 版本是在 POM 的<properties>部分中定义，在 <dependencyManagement>中引用的

<properties> 
    <netty.version>4.1.9</netty.version> 
    ... 
    ... 
</properties> 
<dependencyManagement> 
    <dependencies> 
        <dependency> 
            <groupId>io.netty</groupId> 
            <artifactId>netty-all</artifactId> 
            <version>${netty.version}</version> 
        </dependency> 
    </dependencies> 
    ... 
</dependencyManagement>

对于这种使用场景，依赖的<scope>元素有一个特殊的 import 值：它将把外部 POM（没有被声明为<parent>）的<dependencyManagement>元素的内容导入到当前 POM 的<dependencyManagement>元素中

构建的生命周期

Maven 构建的生命周期是一个明确定义的用于构建和分发构件的过程。有 3 个内置的构建生命周期：clean、default 和 site。

一个构建的生命周期由一系列的阶段所组成。下面是默认的构建生命周期的各个阶段的一个部分清单。

•  validate——检查项目是否正确，所有必需的信息是否已经就绪。

•  process-sources——处理源代码，如过滤任何值。

•  compile——编译项目的源代码。

•  process-test-resources——复制并处理资源到测试目标目录中。

•  test-compile——将测试源代码编译到测试目标目录中。

•  test——使用合适的单元测试框架测试编译的源代码。

•  package——将编译的代码打包为它的可分发格式，如 JAR。

•  integration-test——处理并将软件包部署到一个可以运行集成测试的环境中。

•  verify——运行任何的检查以验证软件包是否有效，并且符合质量标准。

•  install——将软件包安装到本地存储库中，在那里其他本地构建项目可以将它引用为依赖。

•  deploy——将最终的构件上传到远程存储库，以与其他开发人员和项目共享。

插件

插件可能拥有多个内部步骤，或者目标，其也可以被单独调用。例如，在一个 JAR 项目中，默认的构建生命周期由 maven-jar-plugin 处理，其将构建的各个阶段映射到了它自己的以及其他插件的目标中，

注意插件的声明，它被打包为 JAR 包，使用了和<dependency>的 GAV 坐标相同的 GAV 坐标。

<plugin> 
    <groupId>org.codehaus.mojo</groupId> 
    <artifactId>exec-maven-plugin</artifactId> 
    <version>1.2.1</version> 
</plugin>
 

插件管理

如同<dependencyManagement>，声明了其他 POM 可以使用的

信息

<build> 
    <pluginManagement> 
        <plugins> 
            <plugin> 
                <artifactId>maven-compiler-plugin</artifactId> 
                <version>3.2</version> 
                <configuration> 
                <source>1.7</source> 
                <target>1.7</target> 
            </configuration> 
            </plugin> 
            <plugin> 
                <groupId>org.codehaus.mojo</groupId> 
                <artifactId>exec-maven-plugin</artifactId> 
                <version>1.2.1</version> 
            </plugin> 
        </plugins> 
    </pluginManagement> 
</build>

配置文件

配置文件（在中定义）是一组自定义的 POM 元素，可以通过自动或者手动启用（激活）来改变 POM 的行为。

例如，你可以定义一个配置文件，它将根据 JDK 版本、操作系 统或者目标部署环境（如开发、测试或者生产环境）来设置构建参数。 可以通过命令行的-P 标志来显式地引用配置文件。下面的例子将激活一个将 POM 自定义为 使用 JDK1.6 的配置文件。

mvn -P jdk16 clean install 

存储库

Maven的构件存储库 ①

• 远程存储库是一个 Maven 从其下载 POM 文件中所引用的依赖的服务。如果你有上传权 限，那么这些依赖中可能也会包含由你自己的项目所产生的构件。大量开放源代码的 Maven 项目（包含 Netty）都将它们的构件发布到可以公开访问的 Maven 存储库。

• 本地存储库是一个本地的目录，其包含从远程存储库下载的构件，以及你在本地机器上构建并安装的构件。它通常放在你的主目录下，

Maven 存储库的物理目录结构使用 GAV 坐标，如同 Java 编译器使用包名一样。例如，在 Maven 下载了下面的依赖之后：

Maven 存储库的物理目录结构使用 GAV 坐标，如同 Java 编译器使用包名一样。例如，在 
Maven 下载了下面的依赖之后：

Maven 存储库的物理目录结构使用 GAV 坐标，如同 Java 编译器使用包名一样。例如，在 Maven 下载了下面的依赖之后：

快照和发布

远程存储库通常会为正在开发的构件，以及那些稳定发布或者生产发布的构件，定义不同的 区域。这些区域被分别称为快照存储库和发布存储库。

• 一个<version>值由-SNAPSHOT 结尾的构件将被认为是还没有发布的**。这种构件可以重复 地使用相同的<version>值被上传到存储库**。每次它都会被分配一个唯一的时间戳。当项目检 索构件时，下载的是最新实例。

• 一个<version>值不具有-SNAPSHOT 后缀的构件将会被认为是一个发布版本。通常，存储库策略只允某一特定的发布版本上传一次

SNAPSHOT 的拉取

• 当构建一个具有 SNAPSHOT 依赖的项目时，Maven 将检查本地存储库中是否有对应的副本。 如果没有，它将尝试从指定的远程存储库中检索，在这种情况下，它将接收到具有最新时间戳的构件。

• 如果本地的确有这个构件，并且当前构建也是这一天中的第一个，那么 Maven 将默认尝试更新该本地副本。这个行为可以通过使用 Maven 配置文件（settings.xml）中的配置或者命令行 标志来进行配置

POM 实例

<?xml version="1.0" encoding="ISO-8859-15"?> 
<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion> 
    <groupId>com.example</groupId> 
    <artifactId>myproject</artifactId> 
    <version>1.0-SNAPSHOT</version> 
    <packaging>jar</packaging> 
    <name>My Jar Project</name> 
    
    <dependencies> 
        <dependency> 
        <groupId>io.netty</groupId> 
        <artifactId>netty-all</artifactId> 
        <version>4.1.9.Final</version> 
        </dependency> 
    </dependencies> 
    <build> 
        <plugins> 
            <plugin> 
                <groupId>org.apache.maven.plugins</groupId> 
                <artifactId>maven-compiler-plugin</artifactId> 
                <version>3.2</version> 
                <configuration> 
                    <source>1.7</source> 
                    <target>1.7</target> 
                </configuration> 
            </plugin> 
        </plugins> 
    </build> 
</project>

继承和组合

<project> 
    <modelVersion>4.0.0</modelVersion> 
    <parent> 
        <groupId>nia</groupId> 
        <artifactId>nia-samples-parent</artifactId> 
        <version>1.0-SNAPSHOT</version> 
    </parent> 
    <artifactId>chapter2</artifactId> 
    <packaging>pom</packaging> 
    <name>2. Echo Client and Server</name> 
    <modules> 
        <module>Client</module> 
        <module>Server</module> 
    </modules> 
    <properties> 
        <echo-server.hostname>localhost</echo-server.hostname> 
        <echo-server.port>9999</echo-server.port> 
        </properties> 
    <dependencies> 
    <dependency> 
        <groupId>io.netty</groupId> 
        <artifactId>netty-all</artifactId> 
        </dependency> 
    </dependencies> 
    <build> 
        <plugins> 
            <plugin> 
                <artifactId>maven-compiler-plugin</artifactId> 
            </plugin> 
            <plugin> 
                <artifactId>maven-failsafe-plugin</artifactId> 
            </plugin> 
            <plugin> 
                <artifactId>maven-surefire-plugin</artifactId> 
            </plugin> 
            <plugin> 
                <groupId>org.codehaus.mojo</groupId> 
                <artifactId>exec-maven-plugin</artifactId> 
            </plugin> 
        </plugins> 
    </build> 
</project>

POM 继承

• POM 文件可能包含子项目要继承（并可能重写）的信息。

• 通过parent 实现

POM 聚合

• 聚合器 POM 会构建一个或者多个子项目，这些子项目驻留在该 POM 所在目录的子目录中。 子项目，或者<modules>标签，是由它们的目录名标识的：

• 通过<modules> 实现