使用 Maven 构建 Java 项目 - springboot guide中文文档

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

你要建造什么

你将创建一个提供当前时间的应用程序，并使用 Maven 进行构建。

所需内容

大约 15 分钟
一个常用的文本编辑器或 IDE
Java 17 或以上版本
Maven 3.5+
你也可以直接将代码导入到你的 IDE 中：

如何完成本指南

和大多数 Spring 入门指南一样，你可以从零开始并完成每一步，也可以跳过已熟悉的基本设置步骤。不管选择哪种方式，你最终都能获得可运行的代码。

要从零开始，请继续前往设置项目。

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

下载并解压此指南的源代码仓库，或者使用Git进行克隆：git clone https://github.com/spring-guides/gs-maven.git
进入 gs-maven/initial 目录
跳到[初始]。

完成之后，你可以将你的结果与 gs-maven/complete 中的代码进行对比。

设置项目

首先，你需要为 Maven 构建设置一个 Java 项目。为了专注于 Maven，可以先将项目保持得尽可能简单。请在你选择的项目文件夹中创建如下结构。

创建目录结构

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

└── 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 可以在 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 安装的一些信息。这些信息与以下内容类似（但可能会有一些差异）：

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。

INFO: 考虑使用Maven wrapper来隔离开发人员，使其不必担心 Maven 版本问题，甚至无需安装 Maven。从Spring Initializr下载的项目已经包含了该 wrapper。它会以 mvnw 脚本的形式出现在项目的顶层目录中，并且你可以用它来代替 mvn。

定义一个简单的Maven构建

现在 Maven 已经安装完成，你需要创建一个 Maven 项目定义。Maven 项目通过一个名为 pom.xml 的 XML 文件来定义，其中包含项目的名称、版本以及对外部库的依赖等信息。

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

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 中央仓库解析 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，而不是详细介绍此特定插件。

摘要

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

参见

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

使用 Gradle 构建 Java 项目