您的位置 首页 java

从都到尾一招教你使用Maven构建Java项目

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

你会建立什么

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

你需要什么

1. 约15分钟

2. 最喜欢的文本编辑器或IDE

3. JDK 8或更高版本

如何完成本指南

您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都可以使用工作代码。

设置项目

首先,您需要设置一个Java项目供Maven构建。为了专注于Maven,现在使该项目尽可能简单。在您选择的项目文件夹中创建此结构。

创建目录结构

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

使用 maven 构建Java项目

在src/main/java/hello目录中,您可以创建所需的任何Java类。为了与本指南的其余部分保持一致,请创建以下两个类: HelloWorld .java和Greeter.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文件从 下载。仅需要二进制文件,因此请查找指向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或完全安装它。从[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=”#34; xmlns:xsi=”#34;

xsi:schemaLocation=” #34;>

<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>2.1</version>

< execution s>

<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文件。它包括以下项目配置的详细信息:

  1. <modelVersion>。POM模型版本(始终为4.0.0)。
  2. <groupId>。项目所属的组或组织。通常表示为反向域名。
  3. <artifactId>。要赋予项目的库工件的名称(例如,其JAR或WAR文件的名称)。
  4. <version>。正在构建的项目的版本。
  5. <packaging>。如何打包项目。对于JAR文件打包,默认为“ jar”。使用“ war”进行WAR文件打包。

至此,您已定义了一个最小但功能强大的Maven项目

构建Java代码

Maven现在准备构建项目。您现在可以使用Maven执行几个构建生命周期目标,包括编译项目代码,创建库包(例如JAR文件)并将库安装在本地Maven依赖库中的目标。

要尝试构建,请在命令行中发出以下命令:

mvn compile

这将运行Maven,告诉它执行编译目标。完成后,您应该在target / classes目录中找到已编译的.class文件。

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

mvn 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

如果将值<packaging>从“ jar”更改为“ war”,结果将是目标目录中的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>元素内,依赖关系坐标由三个子元素定义:

  1. <groupId> -依赖关系所属的组或组织。
  2. <artifactId> -所需的库。
  3. <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上面已经显示的步骤(有一个生命周期定义,其中“测试”作为“安装”的一个阶段包含在内)。

这是完成的pom.xml文件:

<?xml version=”1.0″ encoding=”UTF-8″?>

<project xmlns=”#34; xmlns:xsi=”#34;

xsi:schemaLocation=” #34;>

<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>2.1</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项目。

也可以看看

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

文章来源:智云一二三科技

文章标题:从都到尾一招教你使用Maven构建Java项目

文章地址:https://www.zhihuclub.com/190219.shtml

关于作者: 智云科技

热门文章

网站地图