[Spring官方教程] - 用Maven构建Java项目

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

你要建造的东西

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

你需要的东西

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

设置项目

首先,你需要设置一个Java项目,让Maven进行构建。为使注意力集中在Maven上,目前要使项目尽可能简单。在您选择的项目文件夹中创建以下结构。

###创建目录结构

在你选择的项目目录下,创建以下子目录结构;例如,在*nix系统上用mkdir -p src/main/java/hello

└── src
    └── main
        └── java
            └── hello

src/main/java/hello目录下,你可以创建任何你想要的Java类。为了与本指南的其他部分保持一致,创建这两个类:HelloWorld.javaGreeter.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可以在 Maven – Download Apache Maven ,以压缩文件的形式下载。只有二进制文件是必需的,所以要寻找apache-maven- {版本} -bin.zip或apache-maven- {版本} -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 wrapper来保护您的开发人员,使其不需要安装正确版本的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>元素外,这是最简单的pom.xml文件,是构建一个Java项目所必需的。它包括项目配置的以下细节。

  • <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文件,你可能想运行打包目标。

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

安装目标将编译、测试和打包你的项目代码,然后将其复制到本地依赖库中,准备让其他项目将其作为依赖项引用。

说到依赖性,现在是时候在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> - 需要的库的具体版本。

默认情况下,所有的依赖关系都是作为 "编译 "依赖的范围。也就是说,它们应该在编译时可用(如果你正在构建一个WAR文件,包括在WAR的*/WEB-INF/libs*文件夹中)。此外,你可以指定一个<scope>元素来指定以下范围之一。

  • provided - 编译项目代码时需要的依赖,但运行代码的容器将在运行时提供这些依赖(例如,Java Servlet API)。
  • test - 用于编译和运行测试的依赖项,但在构建或运行项目的运行时代码时并不需要。

现在,如果你运行mvn compilemvn package,Maven应从Maven Central仓库解析Joda Time的依赖关系,构建就会成功。

写一个测试

首先,在你的pom.xml中,在测试范围内将JUnit作为一个依赖项加入。

<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 Plugin,以简单方便地使JAR文件可执行。本指南的重点是开始使用Maven,而不是使用这个特定插件。

总结

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

另见

下面的指南也可能会有帮助。

想写一个新的指南或对现有的指南做出贡献?请查看我们的贡献指南


原文:Getting Started | Building Java Projects with Maven