Maven工程创建Java maven的java工程构建

转载

云端筑梦师 2023-06-20 07:03:27

文章标签 Maven工程创建Java java maven Java 文章分类 Java 后端开发

一、环境准备

Java 17 or later

Maven 3.5+

IntelliJ IDEA

二、创建项目

首先，您需要为Maven建立一个Java项目。为了将重点放在Maven上，请使项目尽可能简单。在您选择的项目文件夹中创建此结构。

1、创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如，在unix系统上使用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.只需要二进制文件，所以请查找到apachemaven-{版本}-bin.zip或apachemaven-{版本}-bin.tar.gz的链接。

下载zip文件后，将其解压缩到您的计算机上。然后配置好Maven开发环境变量。

要测试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 Initializer下载的项目包含了包装器。它显示为项目顶层的脚本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 文件打包。

此时，您已经定义了一个最小但功能强大的 Maven 项目。

四、构建 Java 代码

Maven现在已准备好构建该项目。现在，您可以使用 Maven 执行多个构建生命周期目标，包括编译项目代码、创建库包（如 JAR 文件）以及在本地 Maven 依赖项存储库中安装库的目标。

要试用构建，请在命令行中发出以下命令：

mvn compile

这将运行 Maven，告诉它执行编译目标。完成后，您应该在目标/类目录中找到已编译的.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

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

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＞元素中，依赖坐标由三个子元素定义：