使用 Maven 构建 Java 项目

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

您将构建的内容

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

你需要什么约15分钟最喜欢的文本编辑器或 IDEJDK 8或以后如何完成本指南

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

要从头开始,请继续设置项目.

要跳过基础知识,请执行以下操作:

下载?并解压缩本指南的源存储库,或使用吉特:git clonehttps://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

在该目录中,您可以创建所需的任何 Java 类。要与本指南的其余部分保持一致,请创建以下两个类:和 。??src/main/java/hello????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-mavenJava version: 1.8.0_152, vendor: Azul Systems, Inc.Java home: /home/dsyer/.sdkman/candidates/java/8u152-zulu/jreDefault locale: en_GB, platform encoding: UTF-8OS name: “linux”, version: “4.15.0-36-generic”, arch: “amd64”, family: “unix”

祝贺!您现在已安装 Maven。

信息:您可能想考虑使用Maven 包装器使您的开发人员免受正确版本的Maven的影响,或者根本不需要安装它。从以下位置下载的项目Spring Initializr包括包装器。它显示为项目顶层的脚本,您可以代替 .??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>

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

??<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,告诉它执行编译目标。完成后,您应该在目标/类目录中找到已编译的.class文件。

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

mvn package

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

要执行 JAR 文件运行,请执行以下操作:

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

如果已将 的值从“jar”更改为“war”,则结果将是目标目录中的 WAR 文件,而不是 JAR 文件。??<packaging>??

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()); }}

这里使用 Joda Time 的类来获取和打印当前时间。??HelloWorld????LocalTime??

如果现在运行以生成项目,则生成将失败,因为尚未在生成中将 Joda Time 声明为编译依赖项。您可以通过向pom添加以下行来解决此问题.xml(在元素内):??mvn compile????<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文件夹中)。此外,还可以指定一个元素来指定以下范围之一:??compile????<scope>??

??provided??编译项目代码所需的依赖项,但将在运行时由运行代码的容器(例如,Java Servlet API)提供。??test??- 用于编译和运行测试的依赖项,但生成或运行项目的运行时代码不需要的依赖项。

现在,如果您运行 or ,Maven 应该从 Maven Central 存储库解析 Joda Time 依赖项,并且构建将成功。??mvn compile????mvn package??

编写测试

首先在测试范围内将 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??

??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 阴影插件为了简单方便地使JAR文件可执行。本指南的重点是开始使用Maven,而不是使用此特定插件。

总结

祝贺!您已经创建了一个简单而有效的 Maven 项目定义,用于构建 Java 项目。

就是去做你害怕的事,直到你获得成功的经验。

使用 Maven 构建 Java 项目

相关文章:

你感兴趣的文章:

标签云: