使用Maven构建Java项目

翻译地址:https://spring.io/guides/gs/maven/

使用Maven构建Java项目

你将会构建什么

你将会在很短的时间使用Maven构建一个应用程序

你将需要什么

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

建立项目

首先,你需要为Maven建立一个Java项目。为了保持对Maven的关注,使现在的项目尽可能简单。

创建目录结构

在您选择的项目目录中,创建以下子目录结构;例如,在* 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项目定义。 Maven项目是使用名为pom.xml的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 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.springframework</groupId>
    <artifactId>gs-maven</artifactId>
    <packaging>jar</packaging>
    <version>0.1.0</version>

    <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>

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

  • <modelVersion>:POM model version (always 4.0.0).
  • <groupId>:项目所属的组或组织。通常表示为反向域名。
  • <artifactId>:要给予项目的库工件的名称(例如,其JAR或WAR文件的名称)。
  • <version>:正在构建的项目版本。
  • <packaging>: 如何包装项目。对于JAR文件打包,默认为“jar”。对WAR文件打包使用“war”。

编译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。

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.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依赖项,并且构建将成功。

写测试

首先在测试范围中<scope>test</scope>添加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 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.springframework</groupId>
    <artifactId>gs-maven</artifactId>
    <packaging>jar</packaging>
    <version>0.1.0</version>

    <dependencies>
        <!-- tag::joda[] -->
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <version>2.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 Plugin,以方便使JAR文件可执行。本指南的重点是开始使用Maven,而不是使用这个特定的插件

猜你喜欢

转载自blog.csdn.net/yanlovehan/article/details/61421506