Maven入门，读这篇文章就够了

短命女 2021-09-10 16:30 380阅读 0赞

一年前，当我和小伙伴小龙一起做一个外包项目的时候，受到了严重的鄙视。我那时候还不知道 [Maven][]，所以搭建项目用的还是最原始的方式，小龙不得已在导入项目的时候花了很长时间去下载项目依赖的开源类库。

出于对我的尊重，小龙没有破口大骂，而是非常委婉地说了一句：“二哥，你好歹也有一定的知名度了，竟然没用 Maven 构建项目，真让我大开眼界啊。”

作为一名富有上进心的程序员，不能忍啊。借此机会，有必要隆重地向大家介绍一下 Maven 了。

### 01、Maven 是什么？ ###

不管英文功底好不好，先看看官网给出的介绍语吧：

> Apache Maven is a software project management and comprehension tool. Based on the concept of a project object model (POM), Maven can manage a project's build, reporting and documentation from a central piece of information.

大致的意思就是说，Apache Maven 是一个项目管理和自动化构建工具，基于项目对象模型（POM）的概念，可以管理项目的构建、报告以及文档。作为 Apache 组织中的一个颇为成功的开源项目，**Maven 主要服务于基于 Java 的项目构建、依赖管理和项目信息管理**。

Maven 采用了约定优先配置的原则，这些原则如下表所示：

<table> 
 <thead> 
  <tr> 
   <th>目录</th> 
   <th>目的</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>${basedir}</code></td> 
   <td>存放 pom.xml 和所有的子目录</td> 
  </tr> 
  <tr> 
   <td><code>${basedir}/src/main/java</code></td> 
   <td>存放 Java 源代码</td> 
  </tr> 
  <tr> 
   <td><code>${basedir}/src/main/resources</code></td> 
   <td>存放项目的资源文件，比如说 log4j.properties</td> 
  </tr> 
  <tr> 
   <td><code>${basedir}/src/test/java</code></td> 
   <td>存放测试类</td> 
  </tr> 
  <tr> 
   <td><code>${basedir}/src/test/resources</code></td> 
   <td>存放测试用的资源</td> 
  </tr> 
  <tr> 
   <td><code>${basedir}/src/main/webapp</code></td> 
   <td>存放 Web 前端文件</td> 
  </tr> 
  <tr> 
   <td><code>${basedir}/target</code></td> 
   <td>项目打包后的输出目录</td> 
  </tr> 
  <tr> 
   <td><code>${basedir}/target/classes</code></td> 
   <td>项目编译后输出目录</td> 
  </tr> 
  <tr> 
   <td><code>~/.m2/repository</code></td> 
   <td>默认的 Maven 仓库目录（~表示用户目录）</td> 
  </tr> 
 </tbody> 
</table>

使用约定优先配置带来的最大好处就是项目的目录结构图非常的统一，不同的开发者在开发一个 Maven 项目的时候，文件存放位置几乎没有差别，省去了很多不必要的麻烦，有利于促进项目团队的标准化。

我们这个年代非常崇尚开源精神，几乎所有的 Java 项目都会借用一些第三方的开源类库，这些类库可以通过依赖的方式引入到项目中来。但随着依赖的增多，版本冲突、依赖臃肿的问题就会接踵而来。手工解决这些问题是十分枯燥的，幸运的是 Maven 提供了一个优秀的解决方案，它通过一个三维的坐标（`<groupId>`、`<artifactId>`、`<version>`）来准确地定位每一个开源类库。

另外，我认为 Maven 特别优秀的一点是，它把项目依赖的所有开源类库都从远程中央仓库下载到了指定的本地仓库中，也就是说，这些开源类库可以在多个项目之间共用，无需重复下载——假如我用 Maven 构建项目的话，小龙就不用下载那么多开源类库了，他的本地仓库中可能已经有了——我也就不会被鄙视了。

### 02、配置 Maven 环境 ###

1）安装 Maven 之前，先确保电脑上已经安装了 JDK。

2）去 Maven 官网下载想要的版本并解压，下载地址为：

[https://maven.apache.org/download.cgi][https_maven.apache.org_download.cgi]

3）设置环境变量，主要是 MAVEN\_HOME 和 Path。

![1179389-d0c366dcb2eb9444.png][]

4）打开命令行，输入 `mvn -v` 验证 Maven 是否配置成功。

![1179389-7b91632add097ce2.png][]

5）Maven 的 conf 目录下包含了一个非常重要的文件 settings.xml，一般情况下，我倾向于将该文件复制到 `~/.m2/` 目录下——建议你也这么做。

打开该文件，在 `<mirrors></mirrors>` 节点下添加阿里云的镜像地址（参照下面的代码）。为什么要这么做呢？因为 Maven 默认的仓库在不翻强的情况下很难访问到。

<mirror>
    <id>alimaven</id>
    <name>aliyun maven</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
    <mirrorOf>central</mirrorOf>
    </mirror>

这里需要注意的是，`<mirrorOf>` 的值有下面四种方式：

*  `<mirrorOf>*<mirrorOf>`：匹配所有远程仓库，也就是说任何对于中央仓库的请求都会转至该镜像。
 *  `<mirrorOf>external:*<mirrorOf>`：匹配所有不在本机上的远程仓库。
 *  `<mirrorOf>repo1,repo2<mirrorOf>`：匹配仓库 repo1 和 repo2，使用逗号分隔多个远程仓库。
 *  `<mirrorOf>*,!repo<mirrorOf>`：匹配所有远程仓库，repo 除外，使用感叹号将仓库从匹配中排除。

6）在 Eclipse 下依次选择菜单 Window → Show View → Other → Maven → Maven Workspace Build，查看镜像是否配置成功（**我习惯了使用 Eclipse，所以请见谅**，不过不管使用哪种集成开发环境，思路和步骤都大差不差）。

![1179389-fbd8bc1ec2a97c72.png][]

### 03、快速创建 Maven 项目 ###

为了尽快步入重点，这一小节我会有意的避重就轻，没必要的步骤会略过。

1）在 Eclipse 中新建项目的时候选择 Maven Project。

2）在接下来选择项目类型的时候，选择 maven-archetype-quickstart，如下图所示。

![1179389-af3f0f112774ac3c.png][]

3）然后指定项目参数的时候填写 group id 和 artifact id。

4）项目创建成功后的目录结构图如下图所示。

![1179389-3e4f4ca23c7ca8f3.png][]

Maven 3 默认使用的依然是 JDK 1.5，不过我们可以为其配置更高版本的 JDK，后面会聊到。

### 04、详细分析 pom.xml ###

毫无疑问，Maven 项目的灵魂只有一个，那就是 pom.xml 文件，所以接下来我会详细地对其进行分析。

**1）项目基本信息**

pom.xml 文件的第一部分主要用来描述项目的基本信息。

<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.cmower</groupId>
    <artifactId>test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    
    <name>test</name>
    
    </project>

①、`<project>` 是 pom.xml 的根元素，声明了相关的命名空间。

②、`<modelVersion>` 指定了当前项目对象模型（POM）的版本，对于 Maven 3.x 来说，该值只能是 4.0.0。

③、`<groupId>` 定义了项目的组名，这个组往往和项目所在的组织或公司关联。

④、`<artifactId>` 定义了当前 Maven 项目在组中唯一的 ID。

⑤、`<version>` 定义了项目的版本号，`SNAPSHOT` 为快照的意思，也就是说该项目还处于开发阶段。

⑥、`<packaging>` 定义了项目的打包类型，可选值有 war、jar 等。

⑦、`<name>` 定义了项目的名称。

**2）变量配置信息**

pom.xml 文件的第二部分通常用来配置一些变量信息。

<properties>
    <spring.version>5.1.5.RELEASE</spring.version>
    </properties>

有了变量的配置信息后，可以通过 `${spring.version}` 的形式来调用这些配置项。这样做的好处显而易见，当依赖项的版本升级的时候，可以直接修改变量值即可。

**3）依赖管理**

阿里云的 Maven 仓库下有各种各样的第三方类库，换句话说就是，只有你想不到的，没有你找不到的。大多数 Maven 项目的依赖项列表都会很长很长，为了便于说明，下面我只列出某些具有特色的。

<dependencies>
    <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>3.8.1</version>
    <scope>test</scope>
    </dependency>
    <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>${spring.version}</version>
    <exclusions>
    <exclusion>
    <groupId>commons-logging</groupId>
    <artifactId>commons-logging</artifactId>
    </exclusion>
    </exclusions>
    </dependency>
    <dependency>
    <groupId>commons-logging</groupId>
    <artifactId>commons-logging</artifactId>
    <version>1.1.1</version>
    </dependency>
    </dependencies>

①、上文中曾提到，`<groupId>`、`<artifactId>`、`<version>` 合起来可以准确地定位一个依赖项。那怎么找到想要的依赖项呢？

第一步，进入 MavenRepository 网站，地址如下：

[http://mvnrepository.com][http_mvnrepository.com]

然后在搜索框中输入第三方类库的关键字，比如说「spring-core」，点击「search」按钮，可以查看到该类库的链接导航。

第二步，点击链接进入到「spring-core」的主页，可以看到所有版本的「spring-core」，选择一个使用率最高的。使用率高在一定程度上表明这个版本的类库最稳定，它已经得到了广大程序员的认可。

第三步，进入该版本的主页，只需要左键轻轻地在 「Maven」选项卡内点一下，就已经把该类库的 Maven 依赖信息复制到粘贴板了（不需要「Ctrl+C」，非常的人性化），如下图所示。

![1179389-e94ecc83d460af80.png][]

第四步，将类库的依赖信息粘贴到 pom.xml 文件的 `<dependencies>` 节点下，然后按下快捷键「Ctrl+S」保存。紧接着，依次展开 test → Java Resources → Libraries → Maven Dependencies 节点，你可以看到该类库已经悄悄地添加进来了。

②、 `<exclusions>` 主要用于排除依赖。

有时候，我们引入的依赖中可能会包含一些不想要的依赖包，我们想引入自己想要的，这时候就要用到排除依赖了。

使用 `<exclusion>` 的时候只需要指定 groupId 和 artifactId 就行了，并不需要 version，这是因为 groupId 和 artifactId 就可以定位某种类型的依赖。

③、 `<scope>` 用来控制依赖的范围。

**test**：测试依赖范围。典型的例子是 Jnuit，它只有在编译测试代码及运行测试的时候才需要。

**compile**：编译依赖范围（其实不止是编译，对测试、运行同样有效），缺省项，如果没有指定，就会默认使用该依赖范围。

**provided**：提供依赖范围。对编译和测试有效，但在运行时候无效。

**runtime**：运行时依赖范围。对测试和运行有效，但在编译时无效。

PS：如果不知道选哪一种，缺省就对了。

**4）构建配置**

`<build>` 元素中包含了执行 Maven 构建周期目标所需的插件以及相关的配置。

<build>
    <finalName>test</finalName>
    <plugins>
    
    <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>2.3.2</version>
    <configuration>
    <source>${jdk.version}</source>
    <target>${jdk.version}</target>
    </configuration>
    </plugin>
    
    </plugins>
    
    <resources>
    <resource>
    <directory>src/main/java</directory>
    <includes>
    <include>**/*.xml</include>
    </includes>
    </resource>
    </resources>
    </build>

①、`<finalName>`，打成 jar 包或者 war 包时的名称。上文中曾提到，项目打包后的输出目录为 `${basedir}/target`。

②、`<plugins>` 用于指定项目在构建过程中使用的插件。

*  `<groupId>`、`<artifactId>`、`<version>` 用于确定使用的插件。
 *  `<configuration>`，该插件所需要的特殊配置。Maven 3 默认使用的是 JDK 1.5，本例中我们使用了 JDK 1.8。

③、`<resources>` 描述了各个资源在 Maven 项目中的具体路径。

*  `<directory>`，资源文件的路径，默认位于 `${basedir}/src/main/resources/` 目录下。
 *  `<includes>`，用于指定在构建过程中被处理的资源文件；对应 `<excludes>` 用于省去不被处理的资源文件。

### 05、使用 Maven 对项目进行清理、编译、测试、打包 ###

1）清理：`mvn clean`，该命令会删除 target 目录。可以直接在命令行中执行该命令，只需要切换到项目所在的路径下即可。

![1179389-9063d10d4681d367.png][]

2）编译：`mvn complie`，该命令会编译 src/main/java 目录下的源码。同时，Maven 还会处理在 src/main/resources 目录下的资源文件，确保它们作为编译的一部分。

![1179389-a45ee6a4c6884d87.png][]

不过，很遗憾的是，执行该命令会报错。该命令给出的提示是，查看 \[Help 1\] 给出的地址，我尝试了一下，可以将 `mvn complie` 命令替换为 `mvn compiler:compile` 命令执行，结果如下图所示。

![1179389-308a585f849bfe94.png][]

编译后可以在 target 目录下查看字节码文件。

3）测试：`mvn test`，test 命令在运行时，会执行 compile 命令；而之前我们已经执行过一次 compile 命令，为了确保结果的准确性，可以执行 `mvn clean test` 命令确保测试之前没有残余物，结果如下图所示。

![1179389-5785ea27f3ae11e3.png][]

Maven 会通过 Surefire 插件，使用 pom.xml 文件中的测试提供者（通常是 Junit）运行测试。执行 `test` 命令不仅会运行测试，还会产生报告文件，此时 target 目录下的截图如下：

![1179389-cfb7d35de3bfbbb9.png][]

4）打包：`mvn install`，该命令会按照 pom.xml 文件中 `<packaging>` 指定的方式（本例为 jar）对编译结果打包。同时，还会把打包好的文件放到本地的 Maven 仓库中，以便其他项目把它当做依赖项使用。命令执行结果如下图所示。

![1179389-ef1959635326b395.png][]

查看本地的 Maven 仓库，可以看到刚刚打包好的文件。

![1179389-7d5b50865e508832.png][]

### 06、最后 ###

在 Maven 出现之前，流行的构建工具是 Ant；在 Maven 出现之后，还有一种新兴的构建工具 Gradle，它有意选择了和 Maven 相反的原则，不会强制使用者遵循刻板的构建周期。

总之，Maven 是一款优秀的构建工具，[Java 项目的开发者][Java]很有必要熟练地掌握它。

![1179389-62149a1395564c9f.png][]

[Maven]: https://links.jianshu.com/go?to=http%3A%2F%2Fwww.itwanger.com%2Fjava%2F2019%2F10%2F24%2Fmaven-rumen.html
[https_maven.apache.org_download.cgi]: https://links.jianshu.com/go?to=https%3A%2F%2Fmaven.apache.org%2Fdownload.cgi
[1179389-d0c366dcb2eb9444.png]: /images/20210809/d8f8ee63b6844551afe551172e53236f.png
[1179389-7b91632add097ce2.png]: /images/20210809/5ba72f911a234f6ababedddbcea9d33a.png
[1179389-fbd8bc1ec2a97c72.png]: /images/20210809/22056f03f5f6441aaca6181233da5a8f.png
[1179389-af3f0f112774ac3c.png]: /images/20210809/835fc7156d624cc88c3b3f3e4a790328.png
[1179389-3e4f4ca23c7ca8f3.png]: /images/20210809/60cd77b840f54dc78b4fb5828802dfac.png
[http_mvnrepository.com]: https://links.jianshu.com/go?to=http%3A%2F%2Fmvnrepository.com
[1179389-e94ecc83d460af80.png]: /images/20210809/b4a4a618810b46938efd6dca6837be92.png
[1179389-9063d10d4681d367.png]: /images/20210809/2c516c6266f744bf82ef74539bdfad02.png
[1179389-a45ee6a4c6884d87.png]: /images/20210809/7c70d461e3724a61b870eccc0d3eed87.png
[1179389-308a585f849bfe94.png]: /images/20210809/d1d5ede403e944bf8ee3f17bc5a60ed2.png
[1179389-5785ea27f3ae11e3.png]: /images/20210809/1fe4b13e17e04667a07e2167028b5df3.png
[1179389-cfb7d35de3bfbbb9.png]: /images/20210809/85d43e71a1114aa59a52d0d7fc12bd16.png
[1179389-ef1959635326b395.png]: /images/20210809/c1770899541a447ebe84bbd2e44aecdb.png
[1179389-7d5b50865e508832.png]: /images/20210809/fb4d0d762ceb41a49a49d637015e7375.png
[Java]: https://links.jianshu.com/go?to=http%3A%2F%2Fwww.itwanger.com%2F
[1179389-62149a1395564c9f.png]: /images/20210809/35b6941b28a74e5e8f5d64883c617bd3.png