使用Maven构建Java Spring项目（官方文档译文）

最新推荐文章于 2025-03-06 11:44:53 发布

2301_79678418

最新推荐文章于 2025-03-06 11:44:53 发布

阅读量144

点赞数

文章标签： java maven spring

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

一、您将构建什么

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

二、前期准备

大约15分钟
喜爱的文本编辑器或IDE
Java 17或更高版本
Maven 3.5+
您也可以直接将代码导入IDE：
- Spring工具套件（STS）
- IntelliJ IDEA
- VSCode

三、如何完成本指南

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

要从头开始，请转到“设置项目”。
要跳过基础知识，请执行以下操作：

下载并解压缩本指南的源存储库，或使用Git进行克隆：

git clone https://github.com/spring-guides/gs-maven.git

进入到gs-maven/initial
跳到[初始]。

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

四、设置项目

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

4.1 创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如，在*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可作为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包装器来隔离您的开发人员，使他们不必拥有正确版本的Maven，或者根本不必安装它。从SpringInitializer下载的项目包含了包装器。它显示为项目顶层的脚本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，告诉它执行编译目标。完成后，您应该在target/classes目录中找到已编译的.class文件。
由于您不太可能希望直接分发或使用.class文件，因此您可能希望运行包目标：

man package

包的目标是编译Java代码，运行任何测试，最后将代码打包到目标目录中的JAR文件中。JAR文件的名称将基于项目的＜artifactId＞和＜version＞。例如，给定之前的最小pom.xml文件，JAR文件将命名为gs-maven-0.1.0.JAR。
要执行JAR文件，请运行：

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

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

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

man install

安装目标将编译、测试和打包项目的代码，然后将其复制到本地依赖关系存储库中，以便其他项目将其作为依赖关系引用。
说到依赖关系，现在是时候在Maven构建中声明依赖关系了。

七、声明依赖项

简单的Hello World示例是完全独立的，不依赖于任何其他库。然而，大多数应用程序都依赖于外部库来处理常见和复杂的功能。
例如，假设除了说“Hello World！”之外，您还希望应用程序打印当前日期和时间。虽然您可以使用本机Java库中的日期和时间功能，但使用Joda time库可以使事情变得更有趣。
首先，将HelloWorld.java更改为如下所示：

➡️src/main/java/hello/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＞-所需库的特定版本。

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

provide - 编译项目代码所需的依赖项，但将在运行时由运行代码的容器（例如，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步骤，正如我们上面已经展示的那样（有一个生命周期定义，其中“测试”作为“安装”中的一个阶段）。
以下是完整的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>