Maven+Java入门程序

Maven+Java入门程序

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

创建什么功能？

我们将学习如何创建一个提供时间的应用程序，然后使用Maven构建它。

需要什么？

  • 大约15分钟的时间
  • 最喜欢的文本编辑器或IDE
  • JDK8或更高版本

如何完成本指南

像大多数Spring入门教程一样，可以从头开始并完成每个步骤，也可以绕过已熟悉的基本设置步骤。无论哪种方式，最后需要编写代码。

设置项目

首先，我们需要为Maven创建一个Java项目。要将重点放在Maven上，并尽可能简化项目。 在选择的项目文件夹中创建此结构。

创建目录结构

在您选择的项目目录中，创建以下子目录结构; 例如，在*nix系统上使用 mkdir -p src/ main/java/hello(在Windows系统上，请自己创建这个目录结构，在本示例创建的目录是:D:\worksp\springws\firstapp):

└── 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可以在 http://maven.apache.org/download.cgi 或 http://mirrors.hust.edu.cn/apache/maven/ 下载为zip文件。只使用二进制文件，所以请查看apache-maven-{version}-bin.zip或apache-maven-{version}bin.tar.gz的链接。

下载完压缩文件后，将其解压缩到您的计算机上。 然后将bin文件夹添加到环境变量路径中。

注意:如果了解如何安装Maven，请参考: http://www.zyiz.net/maven/maven_environment_setup.html

要测试Maven安装，请从命令行运行mvn:

mvn -v

如果一切顺利，应该看到一些关于Maven安装的信息。它看起来类似于(但可能略有不同)以下输出内容:

C:\Users\Administrator>mvn -v
Apache Maven 3.5.3 (3383c37e1f9e9b3bc3df5050c29c8aff9f295297; 2018-02-25T03:49:0
5+08:00)
Maven home: D:\software\apache-maven-3.5.3\bin\..
Java version: 1.8.0_65, vendor: Oracle Corporation
Java home: D:\Program Files\Java\jdk1.8.0_65\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

恭喜！ 你现在已经成功地安装了Maven。

定义一个简单的Maven构建

既然已经安装了Maven，需要创建一个Maven项目定义。 Maven项目使用名为pom.xml的XML文件进行定义。 除此之外，该文件还提供项目的名称，版本和它在外部库上的依赖关系。

在项目的根目录下创建一个名为pom.xml的文件(即将其放在src文件夹同级)并为其提供以下内容:

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

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

由于不想直接分发或处理.class文件，那么可运行包目标:

mvn package

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

如果您已将<packaging>的值从“jar”更改为“war”，则结果将是目标目录中的WAR文件而不是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时间库的一个依赖项。 在<dependency>元素中，依赖关系坐标由三个子元素定义:

  • <groupId> - 依赖项所属的组或组织。
  • <artifactId> - 需要的类库。
  • <version> - 需要的库的特定版本。

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

  • provided - 编译项目代码所需的依赖项，但运行时由运行代码的容器(例如Java Servlet API)提供。
  • test - 用于编译和运行测试的依赖项，但不是构建或运行项目运行时代码所必需的。

现在，如果运行mvn compile或mvn包，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安装步骤，因为我们已经在上面展示过了(有一个生命周期定义，其中“test”包含在“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>

    <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来开发，不使用特定的插件。

编译结果如下 -

运行测试结果如下 -

运行输出结果 - 

D:\worksp\springws\firstapp>java -jar target/gs-maven-0.1.0.jar
The current local time is: 09:52:01.046
Hello world!

D:\worksp\springws\firstapp>

可以看到，程序已经输出当前时间。


目录
Maven+Java入门程序