# Maven入门指南
本指南旨在第一次为使用Maven的人员提供参考，但也打算作为一本包含公共用例的独立参考和解决方案的工具书。对于新用户，建议您按顺序浏览该材料。对于更熟悉Maven的用户，本指南致力于为手头的需求提供一个快速解决方案。现在假设您已经在本地计算机上下载了Maven并安装了Maven。如果您没有这样做，请参考下载和安装说明（ [Download and Installation](http://maven.apache.org/download.html)）。
好的，现在安装了Maven，我们准备好了。在开始我们的示例之前，我们将非常简单地介绍Maven是什么，以及它如何帮助您完成日常工作和与团队成员协作。当然，Maven将为小型项目工作，但是Maven在帮助团队更有效地操作方面表现出色，它允许团队成员将精力集中在项目的涉众需要什么上。您可以将构建基础设施留给Maven！
### Maven是什么？
乍一看，Maven看起来可能有很多东西，但简而言之，Maven是一种尝试将模式应用于项目的构建基础结构，以便通过在使用最佳实践中提供清晰的路径来促进理解和生产力。Maven本质上是一个项目管理和理解工具，因此提供了一种帮助管理的方法：
- 构建
- 文档
- 报告
- 依赖
- SCMs
- 版本
- 发布
如果您想了解更多关于Maven的背景信息，可以查看Maven的哲学（ [The Philosophy of Maven](http://maven.apache.org/background/philosophy-of-maven.html)）和Maven的历史（ [The History of Maven](http://maven.apache.org/background/history-of-maven.html)）。现在，让我们继续讨论用户如何从使用Maven中获益。
### Maven如何使我的开发过程受益？
Maven可以通过使用标准约定和实践来加快开发周期，同时帮助您获得更高的效率，从而为您的构建过程提供好处。
现在我们已经介绍了一些Maven的历史和目的，让我们进入一些实际的例子，让您开始使用Maven！
### 如何配置Maven？
Maven的默认值通常是足够的，但是如果您需要更改缓存位置或使用HTTP代理，则需要创建配置。有关更多信息，请参见配置Maven指南（[Guide to Configuring Maven](http://maven.apache.org/guides/mini/guide-configuring-maven.html)）。
### 如何进行我的第一个Maven项目？
我们将直接跳到创建您的第一个Maven项目！为了创建我们的第一个Maven项目，我们将使用Maven的原型机制。原型（archetype ）被定义为一种原始的模式或模型，所有其他同类的东西都是从这个模式或模型中制造出来的。在Maven中，原型是一个项目的模板，该模板与一些用户输入相结合，生成一个适合用户需求的Maven项目。我们现在将向您展示原型机制是如何工作的，但是如果您想了解更多关于原型的信息，请参考我们对原型的介绍（ [Introduction to Archetypes](http://maven.apache.org/guides/introduction/introduction-to-archetypes.html)）。
继续创建你的第一个项目！为了创建最简单的Maven项目，从命令行执行以下命令：
```
mvn -B archetype:generate \
-DarchetypeGroupId=org.apache.maven.archetypes \
-DgroupId=com.mycompany.app \
-DartifactId=my-app
```
执行此命令后，您将注意到发生了一些事情。首先，您将注意到已经为新项目创建了一个名为my-app的目录，并且这个目录包含一个名为`pom.xml`的文件，该文件应该如下所示：
```xml
4.0.0 com.mycompany.app my-app jar 1.0-SNAPSHOT Maven Quick Start Archetype http://maven.apache.org junit junit 4.11 test -.表单(例如`myapp-1.0.jar`)。
- **packaging** 此元素指示此项目将使用的包类型(例如JAR、WAR、EAR等)。这不仅意味着产生的项目是JAR、WAR或EAR，而且还可以指示要作为构建过程的一部分使用的特定生命周期。(生命周期是我们将在指南中进一步讨论的一个主题。现在，请记住，项目的指定打包可以在定制构建生命周期中发挥作用。)`packaging`的默认值是JAR，因此您不必为大多数项目指定此值。
- **version** 此元素指示项目生成的版本。Maven对帮助您进行版本管理有很大帮助，您经常会看到版本中的`SNAPSHOT`指示符，这表明项目处于开发状态。我们将在本指南中讨论 [snapshots](http://maven.apache.org/guides/getting-started/index.html#What_is_a_SNAPSHOT_version)的使用以及它们是如何工作的。
- **name** 此元素指示用于项目的显示名称。这经常用于Maven生成的文档中。
- **url** 此元素指示在何处可以找到项目的站点。这经常用于Maven生成的文档中。
- **description** 此元素提供了项目的基本说明。这经常用于Maven生成的文档中。
有关在POM中可用的元素的完整参考，请参考我们的POM指南（[POM Reference](http://maven.apache.org/ref/current/maven-model/maven.html)）。现在让我们回到手头的项目。
在生成第一个项目的原型之后，您还会注意到已经创建了以下目录结构：
```
my-app
|-- pom.xml
`-- src
|-- main
| `-- java
| `-- com
| `-- mycompany
| `-- app
| `-- App.java
`-- test
`-- java
`-- com
`-- mycompany
`-- app
`-- AppTest.java
```
如您所见，从原型（archetype）创建的项目有一个POM、一个用于应用程序源的源代码树和一个用于测试源的源代码树。这是Maven项目的标准布局(应用程序源位于`${basedir}/src/main/java`，测试源位于`${basedir}/src/test/java`中，其中${basedir}表示包含`pom.xml`的目录)。
如果要手工创建Maven项目，我们建议使用这个目录结构。这是一个Maven约定，要了解更多有关它的信息，您可以阅读我们对标准目录布局的介绍([Introduction to the Standard Directory Layout](http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html))。
现在我们有了一个POM、一些应用程序源代码和一些您可能需要的测试源代码。
### 如何编译我的应用程序源代码？
通过archetype:generate切换到被创建pom.xml的目录并执行以下命令来编译应用程序源代码：
```
mvn compile
```
在执行此命令时，您应该看到输出如下所示：
```
[INFO] ----------------------------------------------------------------------------
[INFO] Building Maven Quick Start Archetype
[INFO] task-segment: [compile]
[INFO] ----------------------------------------------------------------------------
[INFO] artifact org.apache.maven.plugins:maven-resources-plugin: \
checking for updates from central
...
[INFO] artifact org.apache.maven.plugins:maven-compiler-plugin: \
checking for updates from central
...
[INFO] [resources:resources]
...
[INFO] [compiler:compile]
Compiling 1 source file to /my-app/target/classes
[INFO] ----------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ----------------------------------------------------------------------------
[INFO] Total time: 3 minutes 54 seconds
[INFO] Finished at: Fri Sep 23 15:48:34 GMT-05:00 2005
[INFO] Final Memory: 2M/6M
[INFO] ----------------------------------------------------------------------------
```
当您第一次执行此命令(或任何其他命令)时，Maven将需要下载完成该命令所需的所有插件和相关依赖项。从Maven的干净安装来看，这可能需要相当长的时间(在上面的输出中，花费了将近4分钟)。如果您再次执行该命令，Maven现在将得到它所需的东西，因此它不需要下载任何新的内容，并且能够更快地执行该命令。
从输出中可以看到，编译后的类被放置在`${basedir}/target/classes`中，这是Maven使用的另一个标准约定。因此，如果您是一个敏锐的观察者，您会注意到通过使用标准约定，上面的POM非常小，并且您不必明确地告诉Maven您的源代码在哪里或输出应该去哪里。通过遵循标准的Maven约定，您可以在很小的努力下完成很多事情！作为一个偶然的比较，让我们来看看您在 [Ant](http://ant.apache.org/)中可能需要做些什么来完成同样的 [事情](http://maven.apache.org/ant/build-a1.xml)。
现在，这只是编译一个应用程序源代码树，所显示的Ant脚本与上面显示的POM大小基本相同。但是，我们将看到，我们还可以做更多的只是简单的POM！
### 如何编译测试源代码并运行单元测试？
现在您正在成功地编译您的应用程序的源代码，现在您已经获得了一些您想要编译和执行的单元测试(因为每个程序员总是编写和执行他们的单元测试*轻推眨眼*)。
执行以下命令：
```
mvn test
```
在执行此命令时，您应该看到输出如下所示：
```
[INFO] ----------------------------------------------------------------------------
[INFO] Building Maven Quick Start Archetype
[INFO] task-segment: [test]
[INFO] ----------------------------------------------------------------------------
[INFO] artifact org.apache.maven.plugins:maven-surefire-plugin: \
checking for updates from central
...
[INFO] [resources:resources]
[INFO] [compiler:compile]
[INFO] Nothing to compile - all classes are up to date
[INFO] [resources:testResources]
[INFO] [compiler:testCompile]
Compiling 1 source file to C:\Test\Maven2\test\my-app\target\test-classes
...
[INFO] [surefire:test]
[INFO] Setting reports dir: C:\Test\Maven2\test\my-app\target/surefire-reports
-------------------------------------------------------
T E S T S
-------------------------------------------------------
[surefire] Running com.mycompany.app.AppTest
[surefire] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0 sec
Results :
[surefire] Tests run: 1, Failures: 0, Errors: 0
[INFO] ----------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ----------------------------------------------------------------------------
[INFO] Total time: 15 seconds
[INFO] Finished at: Thu Oct 06 08:12:17 MDT 2005
[INFO] Final Memory: 2M/8M
[INFO] ----------------------------------------------------------------------------
```
一些关于输出的注意事项：
- Maven这次下载更多的依赖项。这些是执行测试所必需的依赖项和插件(它已经拥有编译所需的依赖项，不会再下载它们)。
- 在编译和执行测试之前，Maven编译主代码(所有这些类都是最新的，因为我们自上次编译以来什么都没有改变)。
如果您只想编译测试源代码(但不想执行测试)，可以执行以下操作：
```
mvn test-compile
```
既然您可以编译您的应用程序源代码，编译您的测试，并执行测试，那么您将希望进入下一个逻辑步骤，因此您将询问...
### 如何创建JAR并将其安装在本地存储库中？
创建JAR文件是足够直接的，可以通过执行以下命令来完成：
```
mvn package
```
如果您查看项目的POM，您将注意到`packaging`元素设置为`jar`。Maven知道如何从上面的命令生成一个JAR文件(稍后我们将更多地讨论这一点)。现在您可以在`${basedir}/target`目录中查看一下，您将看到生成的JAR文件。
现在，您需要在本地存储库中安装您生成的项目(JAR文件)(`${user.home}/.m2/repository`是默认位置)。有关存储库的更多信息，您可以参考我们对存储库的介绍（[Introduction to Repositories](http://maven.apache.org/guides/introduction/introduction-to-repositories.html)），但让我们继续安装我们的项目！为此，请执行以下命令：
```
mvn install
```
在执行此命令时，您将看到以下输出：
```
[INFO] ----------------------------------------------------------------------------
[INFO] Building Maven Quick Start Archetype
[INFO] task-segment: [install]
[INFO] ----------------------------------------------------------------------------
[INFO] [resources:resources]
[INFO] [compiler:compile]
Compiling 1 source file to /my-app/target/classes
[INFO] [resources:testResources]
[INFO] [compiler:testCompile]
Compiling 1 source file to /my-app/target/test-classes
[INFO] [surefire:test]
[INFO] Setting reports dir: /my-app/target/surefire-reports
-------------------------------------------------------
T E S T S
-------------------------------------------------------
[surefire] Running com.mycompany.app.AppTest
[surefire] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.001 sec
Results :
[surefire] Tests run: 1, Failures: 0, Errors: 0
[INFO] [jar:jar]
[INFO] Building jar: /my-app/target/my-app-1.0-SNAPSHOT.jar
[INFO] [install:install]
[INFO] Installing /my-app/target/my-app-1.0-SNAPSHOT.jar to \
/com/mycompany/app/my-app/1.0-SNAPSHOT/my-app-1.0-SNAPSHOT.jar
[INFO] ----------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ----------------------------------------------------------------------------
[INFO] Total time: 5 seconds
[INFO] Finished at: Tue Oct 04 13:20:32 GMT-05:00 2005
[INFO] Final Memory: 3M/8M
[INFO] ----------------------------------------------------------------------------
```
注意，强制插件(它执行测试)查找包含在具有特定命名约定的文件中的测试。默认情况下，包括的测试如下：
- `**/*Test.java`
- `**/Test*.java`
- `**/*TestCase.java`
默认情况排除如下：
- `**/Abstract*Test.java`
- `**/Abstract*TestCase.java`
您已经完成了设置、构建、测试、打包和安装典型Maven项目的过程。这可能是项目使用Maven所做的绝大部分工作，如果您已经注意到，到目前为止所能做的一切都是由一个18行文件驱动的，即项目的模型或POM。如果您查看一个典型的Ant构建文件，它提供了与我们迄今为止所实现的功能相同的功能，您会注意到它的大小已经是POM的两倍，而且我们才刚刚开始！您可以从Maven获得更多的功能，而不需要对我们目前的POM进行任何添加。要从我们的示例Ant构建文件（ [build file](http://maven.apache.org/ant/build-a1.xml) ）中获得更多的功能，您必须不断地添加容易出错的内容。
你还能免费得到什么？有大量的Maven插件，即使是像我们上面这样简单的POM，也是可以开箱即用的。我们将在这里特别提到一个，因为它是Maven的一个被高度重视的特性：在没有任何工作的情况下，这个POM有足够的信息为您的项目生成一个网站！您很可能希望自定义Maven站点，但如果时间紧迫，则只需执行以下命令即可提供有关项目的基本信息：
```
mvn site
```
还有许多其他独立的目标也可以执行，例如：
```
mvn clean
```
这将在启动前删除包含所有生成数据的`target`目录，以使其是新的。
### 什么是SNAPSHOT版本？
注意，下面显示的`pom.xml`文件中**version**标记的值有后缀：`-SNAPSHOT`。
```
...
my-app
...
1.0-SNAPSHOT Maven Quick Start Archetype
...
```
`SNAPSHOT`是指开发分支的“最新”代码，并不保证代码是稳定的或不变的。相反，'release' 中的代码(任何没有后缀`SNAPSHOT`的版本值)都是不变的。
换句话说，SNAPSHOT版本是最后的 'release' 版本之前的“开发”版本。SNAPSHOT比它的'release' 版“旧”。
在发布过程中，**x.y-SNAPSHOT**的版本更改为**x.y**。发布过程中还将开发版本增加到 **x.(y+1)-SNAPSHOT**。例如，**1.0-SNAPSHOT**作为1.0版发布，新的开发版本为**1.1-SNAPSHOT**。
### 如何使用插件？
每当您想要自定义Maven项目的构建时，都是通过添加或重新配置插件来完成的。
**注意，对于Maven 1.0用户：**在Maven 1.0中，您应该将一些`preGoal`添加到`maven.xml`中，并将一些条目添加到`project.properties`中。在这里，有点不同。对于本例，我们将配置Java编译器以允许JDK5.0源代码。这就像将其添加到POM中一样简单：
```xml
...
org.apache.maven.plugins maven-compiler-plugin 3.3 1.5 1.5 }`将包含该值的属性引用到您的资源文件中。该属性可以是在pom.xml中定义的值之一、在用户的setings.xml中定义的值、在外部属性文件中定义的属性或系统属性。
若要在复制时让Maven筛选资源，只需在你的`pom.xml`中将资源目录的`filtering`设置为true：
```xml
4.0.0 com.mycompany.app my-app 1.0-SNAPSHOT jar Maven Quick Start Archetype http://maven.apache.org junit junit 4.11 test src/main/resources true 4.0.0 com.mycompany.app my-app 1.0-SNAPSHOT jar Maven Quick Start Archetype http://maven.apache.org junit junit 4.11 test src/main/filters/filter.properties src/main/resources true 4.0.0 com.mycompany.app my-app 1.0-SNAPSHOT jar Maven Quick Start Archetype http://maven.apache.org junit junit 4.11 test src/main/resources true hello 4.0.0 com.mycompany.app my-app 1.0-SNAPSHOT jar Maven Quick Start Archetype http://maven.apache.org junit junit 4.11 test com.mycompany.app my-other-app
...
...
com.mycompany.app my-app 1.0-SNAPSHOT compile log4j log4j 1.1.3 1.1.3 1.2.4 1.2.5 1.2.6 1.2.7 1.2.8 1.2.11 1.2.9 1.2.12 4.0.0 com.mycompany.app my-app 1.0-SNAPSHOT jar Maven Quick Start Archetype http://maven.apache.org junit junit 4.11 test log4j log4j 1.2.12 compile 4.0.0 com.mycompany.app my-app 1.0-SNAPSHOT jar Maven Quick Start Archetype http://maven.apache.org junit junit 4.11 test org.apache.codehaus.plexus plexus-utils 1.0.4 src/main/filters/filters.properties src/main/resources true mycompany-repository MyCompany Repository scp://repository.mycompany.com/repository/maven2
...
mycompany-repository jvanzyl /path/to/identity (default is ~/.ssh/id_dsa)
my_key_passphrase
```
请注意，如果连接到openssh ssh服务器，该服务器的参数“PasswordAuthentication”在sshd_conf中设置为“no”，则每次输入用户名/密码身份验证时都必须键入密码(尽管您可以使用另一个ssh客户机登录，输入用户名和密码)。在这种情况下，您可能希望切换到公钥身份验证。
在`settings.xml`中使用密码时应该小心。有关更多信息，请参见密码加密（[Password Encryption](http://maven.apache.org/guides/mini/guide-encryption.html)）。
### 如何创建文档？
为了让您从Maven的文档系统开始，您可以使用原型机制为现有项目生成一个站点，使用以下命令：
```
mvn archetype:generate \
-DarchetypeGroupId=org.apache.maven.archetypes \
-DarchetypeArtifactId=maven-archetype-site \
-DgroupId=com.mycompany.app \
-DartifactId=my-app-site
```
现在转到指南中去创建一个站点（[Guide to creating a site](http://maven.apache.org/guides/mini/guide-site.html)），学习如何为您的项目创建文档。
### 如何构建其他类型的项目？
注意，生命周期适用于任何项目类型。例如，回到基本目录中，我们可以创建一个简单的web应用程序：
```
mvn archetype:generate \
-DarchetypeGroupId=org.apache.maven.archetypes \
-DarchetypeArtifactId=maven-archetype-webapp \
-DgroupId=com.mycompany.app \
-DartifactId=my-webapp
```
请注意，所有这些都必须在一行上。这将创建一个名为`my-webapp`的目录，其中包含以下项目描述符：
```xml
4.0.0 com.mycompany.app my-webapp 1.0-SNAPSHOT war junit junit 4.11 test my-webapp `元素-这告诉Maven构建为WAR。切换到webapp项目的目录并尝试：
```
mvn package
```
您将看到构建了`target/my-webapp.war`，并且执行了所有正常步骤。
### 如何同时构建多个项目？
Maven内置了处理多个模块的概念。在本节中，我们将展示如何构建上面的WAR，并在一个步骤中包含前面的JAR。
首先，我们需要在其他两个目录中添加一个父`pom.xml`文件，因此它应该如下所示：
```
+- pom.xml
+- my-app
| +- pom.xml
| +- src
| +- main
| +- java
+- my-webapp
| +- pom.xml
| +- src
| +- main
| +- webapp
```
您将要创建的POM文件应该包含以下内容：
```xml
4.0.0 com.mycompany.app app 1.0-SNAPSHOT pom my-app my-webapp com.mycompany.app my-app 1.0-SNAPSHOT `元素添加到子目录中的两个其他`pom.xml`文件中：
```xml
com.mycompany.app app 1.0-SNAPSHOT test `元素-它只是测试所必需的，因此不包括在web应用程序中，因为编译时依赖于`my-app`。
最后一步是包含父定义。这与您可能熟悉的Maven 1.0中的`extend`元素不同：这可以确保POM始终可以被定位，即使通过在存储库中查找该项目，该项目也是独立于其父项目的。
来源：https://www.cnblogs.com/liefsoft/p/11714282.html