使用Maven构建Java项目

本指南将引导您使用Maven构建一个简单的Java项目。

你会建立什么

您将创建一个提供一天中时间的应用程序，然后使用Maven进行构建。

你需要什么

约15分钟

最喜欢的文本编辑器或IDE

JDK 8或更高版本

如何完成本指南

您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都可以使用工作代码。

设置项目

首先，您需要设置一个Java项目供Maven构建。为了专注于Maven，现在使该项目尽可能简单。在您选择的项目文件夹中创建此结构。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如，mkdir -p src/main/java/hello在* nix系统上：

在src/main/java/hello目录中，您可以创建所需的任何Java类。为了与本指南的其余部分保持一致，请创建以下两个类：HelloWorld.java和Greeter.java。

src/main/java/hello/HelloWorld.java

package hello;publicclassHelloWorld{publicstaticvoidmain(String[] args){        Greeter greeter =newGreeter();        System.out.println(greeter.sayHello());    }}

src/main/java/hello/Greeter.java

packagehello;publicclassGreeter{publicStringsayHello(){return"Hello world!";    }}

现在您已经准备好使用Maven构建项目，下一步就是安装Maven。

Maven可作为zip文件从https://maven.apache.org/download.cgi 下载。仅需要二进制文件，因此请查找指向apache-maven- {version} -bin.zip或apache-maven- {version} -bin.tar.gz的链接。

下载完zip文件后，将其解压缩到计算机上。然后将bin文件夹添加到您的路径。

要测试Maven安装，请从命令行运行mvn：

mvn-v

如果一切顺利，应该向您提供有关Maven安装的一些信息。它看起来与以下内容相似（尽管可能略有不同）：

Apache Maven3.3.9(bb52d8502b132ec0a5a3f4c09453c07478323dc5;2015-11-10T16:41:47+00:00)Maven home:/home/dsyer/Programs/apache-mavenJava version:1.8.0_152,vendor: Azul Systems, Inc.Java home:/home/dsyer/.sdkman/candidates/java/8u152-zulu/jreDefault locale: en_GB, platform encoding: UTF-8OS name:"linux",version:"4.15.0-36-generic",arch:"amd64",family:"unix"

恭喜你！您现在已经安装了Maven。

信息：您可能想考虑使用Maven包装器使开发人员避免拥有正确版本的Maven或完全安装它。从Spring Initializr下载的项目都包含包装器。它以脚本的形式显示mvnw在项目的顶层，代替mvn。

定义一个简单的Maven构建

现在已经安装了Maven，您需要创建一个Maven项目定义。Maven项目是使用名为pom.xml的XML文件定义的。除其他外，该文件提供了项目的名称，版本以及它对外部库的依赖关系。

在项目的根目录下创建一个名为pom.xml的文件（即，将其放在src文件夹旁边），并提供以下内容:

pom.xml

.

4.0.0org.springframeworkgs-mavenjar0.1.01.81.8org.apache.maven.pluginsmaven-shade-plugin2.1packageshadehello.HelloWorld

除可选元素外，这是构建Java项目所需的最简单的pom.xml文件。它包括以下项目配置的详细信息：

。POM模型版本（始终为4.0.0）。

。项目所属的组或组织。通常表示为反向域名。

。要赋予项目的库工件的名称（例如，其JAR或WAR文件的名称）。

。正在构建的项目的版本。

。如何打包项目。对于JAR文件打包，默认为“ jar”。使用“ war”进行WAR文件打包。

至此，您已定义了一个最小但功能强大的Maven项目

构建Java代码

Maven现在准备构建项目。您现在可以使用Maven执行几个构建生命周期目标，包括编译项目代码，创建库包（例如JAR文件）并将库安装在本地Maven依赖库中的目标。

要尝试构建，请在命令行中发出以下命令：

mvncompile

这将运行Maven，告诉它执行编译目标。完成后，您应该在target / classes目录中找到已编译的.class文件。

由于您不太可能希望直接分发或使用.class文件，因此您可能需要运行程序包目标：

mvnpackage

该包装目标将编译Java代码，运行任何测试，并通过在内部的JAR文件将代码打包了完成目标目录。JAR文件的名称将基于项目的和。例如，给定以前的最小pom.xml文件，则JAR文件将命名为gs-maven-0.1.0.jar。

要执行JAR文件，请运行：

java-jar target / gs-maven-0.1.0.jar

如果将值从“ jar”更改为“ war”，结果将是目标目录中的WAR文件而不是JAR文件。

Maven还维护本地计算机上的依赖项存储库（通常在主目录中的.m2 / repository目录中），以快速访问项目依赖项。如果要将项目的JAR文件安装到该本地存储库，则应调用install目标：

mvninstall

在安装目标将编译，测试和打包项目的代码，然后将其复制到本地依赖性库，准备好另一个项目中引用它作为一个依赖。

说到依赖，现在是时候在Maven构建中声明依赖了。

声明依赖

简单的Hello World示例完全是独立的，并且不依赖于任何其他库。但是，大多数应用程序都依赖于外部库来处理常见和复杂的功能。

例如，假设除了说“ Hello World！”外，您还希望应用程序打印当前日期和时间。虽然可以使用本机Java库中的日期和时间工具，但可以使用Joda Time库使事情变得更有趣。

首先，将HelloWorld.java更改如下：

src/main/java/hello/HelloWorld.java

.

package hello;import org.joda.time.LocalTime;publicclassHelloWorld{publicstaticvoidmain(String[] args){        LocalTime currentTime =newLocalTime();        System.out.println("The current local time is: "+ currentTime);        Greeter greeter =newGreeter();        System.out.println(greeter.sayHello());    }}

这里HelloWorld使用Joda Time的LocalTime类来获取并打印当前时间。

如果您现在要运行mvn compile以构建项目，则构建将失败，因为您尚未在构建中将Joda Time声明为编译依赖项。您可以通过将以下行添加到pom.xml（在元素内）来解决此问题：

joda-timejoda-time2.9.2

XML块声明了项目的依赖项列表。具体来说，它为Joda Time库声明了一个依赖关系。在元素内，依赖关系坐标由三个子元素定义：

-依赖关系所属的组或组织。

-所需的库。

-所需的特定版本的库。

默认情况下，所有依赖项的作用域都作为compile依赖项。也就是说，它们应该在编译时可用（如果您正在构建WAR文件，包括在WAR的/ WEB-INF / libs文件夹中）。此外，您可以指定一个元素来指​​定以下范围之一：

provided -编译项目代码所需的依赖关系，但将在运行时由运行代码的容器（例如Java Servlet API）提供。

test -用于编译和运行测试的依赖关系，但对于构​​建或运行项目的运行时代码不是必需的。

现在，如果您运行mvn compile或mvn package，则Maven应该从Maven Central存储库中解决Joda Time依赖关系，并且构建将成功

编写测试

首先在测试范围内将JUnit作为对pom.xml的依赖项添加：

junitjunit4.12test

然后创建一个如下的测试用例：

src/test/java/hello/GreeterTest.java

.

packagehello;importstaticorg.hamcrest.CoreMatchers.containsString;importstaticorg.junit.Assert.*;importorg.junit.Test;publicclassGreeterTest{privateGreeter greeter =newGreeter();@TestpublicvoidgreeterSaysHello(){        assertThat(greeter.sayHello(), containsString("Hello"));    }}

Maven使用一个名为“ surefire”的插件来运行单元测试。此插件的默认配置将编译并运行src/test/java名称匹配的所有类*Test。您可以像这样在命令行上运行测试

MVN测试

或只使用mvn install上面已经显示的步骤（有一个生命周期定义，其中“测试”作为“安装”的一个阶段包含在内）。

这是完成的pom.xml文件：

4.0.0org.springframeworkgs-mavenjar0.1.01.81.8joda-timejoda-time2.9.2junitjunit4.12testorg.apache.maven.pluginsmaven-shade-plugin2.1packageshadehello.HelloWorld

完整的pom.xml文件正在使用Maven Shade插件，以使JAR文件具有可执行性。本指南的重点是开始使用Maven，而不是使用此特定插件。

摘要

恭喜你！您已经创建了一个简单而有效的Maven项目定义来构建Java项目。

也可以看看

以下指南也可能会有所帮助：

使用Gradle构建Java项目