└── src
└── main
└── java
└── hello
使用 Maven 构建 Java 项目
本指南将指导你使用 Maven 构建一个简单的 Java 项目。
你将构建的内容
你将创建一个提供时间信息的应用程序，然后使用 Maven 构建它。
你需要准备的内容
-
大约 15 分钟
-
你最喜欢的文本编辑器或 IDE
-
Java 17 或更高版本
-
你还可以直接将代码导入你的 IDE
如何完成本指南
设置项目
首先需要设置一个 Java 项目，以便 Maven 构建。为了专注于 Maven，现在尽可能简化项目。在选定的项目文件夹中创建此结构。
创建目录结构
在选定的项目目录中，创建以下子目录结构；例如，在 *nix 系统上使用 mkdir -p src/main/java/hello
在 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 可作为 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 Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00:00) Maven home: /home/dsyer/Programs/apache-maven Java version: 1.8.0_152, vendor: Azul Systems, Inc. Java home: /home/dsyer/.sdkman/candidates/java/8u152-zulu/jre Default locale: en_GB, platform encoding: UTF-8 OS name: "linux", version: "4.15.0-36-generic", arch: "amd64", family: "unix"
恭喜！你现在已安装 Maven。
信息：你可能需要考虑使用 Maven wrapper，以保护你的开发者免受拥有正确版本的 Maven 或完全安装 Maven 的影响。从 Spring Initializr 下载的项目包含该 wrapper。它显示为项目顶层的脚本 mvnw，你可以用它来代替 mvn。
定义简单的 Maven 构建
安装 Maven 后，需要创建一个 Maven 项目定义。Maven 项目使用名为 pom.xml 的 XML 文件进行定义。此文件除其他内容外，还提供项目的名称、版本以及对外部库的依赖关系。
在项目的根目录（即将其放在 src 文件夹旁边）创建一个名为 pom.xml 的文件，并赋予其以下内容
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework</groupId>
<artifactId>gs-maven</artifactId>
<packaging>jar</packaging>
<version>0.1.0</version>
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.2.4</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>hello.HelloWorld</mainClass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>除了可选的 <packaging> 元素外，这是构建 Java 项目所需的尽可能简单的 pom.xml 文件。它包括以下项目配置详细信息
-
<modelVersion>。POM 模型版本（始终为 4.0.0）。 -
<groupId>。项目所属的组或组织。通常表示为反向域名。 -
<artifactId>。项目库工件的名称（例如，其 JAR 或 WAR 文件的名称）。 -
<version>。正在构建的项目的版本。 -
<packaging>- 项目的打包方式。对于 JAR 文件打包，默认为“jar”。对于 WAR 文件打包，使用“war”。
| 在选择版本控制方案时，Spring 推荐 语义版本控制 方法。 |
此时，您已定义了一个最小但有用的 Maven 项目。
构建 Java 代码
Maven 现已准备好构建项目。您现在可以使用 Maven 执行多个构建生命周期目标，包括编译项目代码、创建库包（例如 JAR 文件）以及将库安装在本地 Maven 依赖项存储库中的目标。
要尝试构建，请在命令行中发出以下命令
mvn compile
这将运行 Maven，并告诉它执行 compile 目标。完成后，您应该会在 target/classes 目录中找到已编译的 .class 文件。
由于您不太可能直接分发或使用 .class 文件，因此您可能希望改而运行 package 目标
mvn package
package 目标将编译您的 Java 代码，运行所有测试，并最终将代码打包到 target 目录中的 JAR 文件中。JAR 文件的名称将基于项目的 <artifactId> 和 <version>。例如，给定之前的最小 pom.xml 文件，JAR 文件将被命名为 gs-maven-0.1.0.jar。
要执行 JAR 文件，请运行
java -jar target/gs-maven-0.1.0.jar
如果您已将 <packaging> 的值从“jar”更改为“war”，则结果将是 target 目录中的 WAR 文件，而不是 JAR 文件。 |
Maven 还维护本地计算机上的依赖项存储库（通常在主目录中的 .m2/repository 目录中），以便快速访问项目依赖项。如果您希望将项目的 JAR 文件安装到该本地存储库，则应调用 install 目标
mvn install
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（在 <project> 元素内）来修复此问题
<dependencies>
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>2.9.2</version>
</dependency>
</dependencies>此 XML 块声明项目的一系列依赖项。具体来说，它声明 Joda Time 库的单个依赖项。在 <dependency> 元素内，依赖项坐标由三个子元素定义
-
<groupId>- 依赖项所属的组或组织。 -
<artifactId>- 所需的库。 -
<version>- 所需库的特定版本。
默认情况下，所有依赖项的范围均为 compile 依赖项。也就是说，它们应该在编译时可用（如果您正在构建 WAR 文件，则包括在 WAR 的 /WEB-INF/libs 文件夹中）。此外，您可以指定 <scope> 元素来指定以下范围之一
-
provided- 编译项目代码所需的依赖项，但将在运行时由运行代码的容器（例如 Java Servlet API）提供。 -
test- 用于编译和运行测试的依赖项，但不需要构建或运行项目的运行时代码。
现在，如果您运行 mvn compile 或 mvn package，Maven 应从 Maven Central 存储库解析 Joda Time 依赖项，并且构建将成功。
编写测试
首先将 JUnit 添加为 pom.xml 中的依赖项，在测试范围中
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>然后创建如下测试用例
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 test
或者仅使用 mvn install 步骤，如上文所示（其中有一个生命周期定义，其中“test”作为“install”中的一个阶段包含在内）。
以下是已完成的 pom.xml 文件
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework</groupId>
<artifactId>gs-maven</artifactId>
<packaging>jar</packaging>
<version>0.1.0</version>
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
<!-- tag::joda[] -->
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>2.9.2</version>
</dependency>
<!-- end::joda[] -->
<!-- tag::junit[] -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!-- end::junit[] -->
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.2.4</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>hello.HelloWorld</mainClass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>| 已完成的 pom.xml 文件使用 Maven Shade 插件，以便轻松地使 JAR 文件可执行。本指南的重点是开始使用 Maven，而不是使用此特定插件。 |
摘要
恭喜！您已为构建 Java 项目创建了一个简单但有效的 Maven 项目定义。