使用 Maven 构建 Java 项目

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

您将构建什么

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

你需要什么

• 约15分钟
• 最喜欢的文本编辑器或 IDE
• JDK 8或更高版本

如何完成本指南

像大多数 Spring入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到工作代码。

要从头开始，请继续设置项目。

要跳过基础知识，请执行以下操作：

• 下载并解压缩本指南的源存储库，或使用Git克隆它：git clone https://github.com/spring-guides/gs-maven.git
• 光盘进入gs-maven/initial
• 跳到[initial]。

完成后，您可以对照中的代码检查结果​​gs-maven/complete​​。

设置项目

首先，您需要为 Maven 构建一个 Java 项目。为了保持对 Maven 的关注，现在让项目尽可能简单。在您选择的项目文件夹中创建此结构。

创建目录结构

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

└── 源
    └── 主要
        └── java
            └── 你好

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

​​src/main/java/hello/HelloWorld.java​​

package hello;

public class HelloWorld {
  public static void main(String[] args) {
    Greeter greeter = new Greeter();
    System.out.println(greeter.sayHello());
  }
}复制

​​src/main/java/hello/Greeter.java​​

package hello;

public class Greeter {
  public String sayHello() {
    return "Hello world!";
  }
}复制

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

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

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

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

mvn -v

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

阿帕奇 Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00:00)
Maven 主页：/home/dsyer/Programs/apache-maven
Java 版本：1.8.0_152，供应商：Azul Systems, Inc.
Java 主页：/home/dsyer/.sdkman/candidates/java/8u152-zulu/jre
默认语言环境：en_GB，平台编码：UTF-8
操作系统名称：“linux”，版本：“4.15.0-36-generic”，arch：“amd64”，系列：“unix”

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

信息：您可能想考虑使用Maven 包装器来使您的开发人员免受使用正确版本的 Maven 或完全安装它的影响。从Spring Initializr下载的项目包含包装器。​​mvnw​​它在项目的顶层显示为一个脚本，您可以代替​​mvn​​.

定义一个简单的 Maven 构建

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

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

​​pom.xml​​

    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    4.0.0

    org.springframework
    gs-maven
    jar
    0.1.0

    
        1.8
        1.8
    

    
        
            
                org.apache.maven.plugins
                maven-shade-plugin
                3.2.4
                
                    
                        package
                        
                            shade
                        
                        
                            
                                                                    implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    hello.HelloWorld
                                
                            
                        
                    
                
            
        
    
复制

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

• ​​​​. POM 模型版本（始终为 4.0.0）。
• ​​​​. 项目所属的组或组织。通常表示为倒置域名。
• ​​​​. 为项目的库工件指定的名称（例如，其 JAR 或 WAR 文件的名称）。
• ​​​​. 正在构建的项目的版本。
• ​​​​- 项目应如何打包。JAR 文件打包默认为“jar”。使用“war”进行 WAR 文件打包。

在选择版本控制方案时，Spring 推荐语义版本控制方法。

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

构建 Java 代码

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

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

mvn 编译

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

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

mvn包

包目标将编译您的 Java 代码，运行任何测试，并通过将代码打包到目标目录中的 JAR 文件中来完成。JAR 文件的名称将基于项目的​​​​和​​​​. 例如，给定之前的最小pom.xml文件，JAR 文件将命名为gs-maven-0.1.0.jar。

要执行 JAR 文件，请运行：

java -jar 目标/gs-maven-0.1.0.jar

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

Maven 还在本地机器上维护了一个依赖库（通常在主目录中的.m2/repository目录中），以便快速访问项目依赖项。如果您想将项目的 JAR 文件安装到该本地存储库，那么您应该调用​​install​​目标：

mvn 安装

install目标将编译、测试和打包您项目的代码，然后将其复制到本地依赖库中，以便另一个项目将其作为依赖项引用。

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

声明依赖

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

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

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

​​src/main/java/hello/HelloWorld.java​​

package hello;

import org.joda.time.LocalTime;

public class HelloWorld {
  public static void main(String[] args) {
    LocalTime currentTime = new LocalTime();
    System.out.println("The current local time is: " + currentTime);
    Greeter greeter = new Greeter();
    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​​or ​​mvn package​​，Maven 应该从 Maven 中央存储库中解析 Joda Time 依赖项，并且构建将成功。

编写测试

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

junitjunit4.12test
复制

然后创建一个这样的测试用例：

​​src/test/java/hello/GreeterTest.java​​

package hello;

import static org.hamcrest.CoreMatchers.containsString;
import static org.junit.Assert.*;

import org.junit.Test;

public class GreeterTest {
  
  private Greeter greeter = new Greeter();

  @Test
  public void greeterSaysHello() {
    assertThat(greeter.sayHello(), containsString("Hello"));
  }

}复制

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

mvn 测试

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

这是完成的​​pom.xml​​文件：

​​pom.xml​​

4.0.0
  
  org.springframeworkgs-mavenjar0.1.0

  1.81.8

  joda-timejoda-time2.9.2junitjunit4.12test

  org.apache.maven.pluginsmaven-shade-plugin3.2.4packageshadehello.HelloWorld

 完成的pom.xml文件使用Maven Shade Plugin来简化 JAR 文件的可执行性。本指南的重点是开始使用 Maven，而不是使用这个特定的插件。

概括

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