使用Maven構(gòu)建Java項(xiàng)目

mushang 發(fā)布于2019-08-16 14:44 / 909人閱讀

摘要：要從頭開始，請(qǐng)繼續(xù)使用構(gòu)建。現(xiàn)在您已經(jīng)準(zhǔn)備好使用構(gòu)建項(xiàng)目，下一步是安裝。項(xiàng)目使用名為的文件定義。項(xiàng)目所屬的組或組織。默認(rèn)情況下，所有依賴項(xiàng)都作為依賴項(xiàng)確定范圍。概要恭喜您已經(jīng)為構(gòu)建項(xiàng)目創(chuàng)建了一個(gè)簡(jiǎn)單而有效的項(xiàng)目定義。

本指南將指導(dǎo)您使用Maven構(gòu)建一個(gè)簡(jiǎn)單的Java項(xiàng)目。

你要構(gòu)建什么

您將創(chuàng)建一個(gè)提供一天中時(shí)間的應(yīng)用程序，然后使用Maven構(gòu)建它。

你需要什么

大約15分鐘

最喜歡的文本編輯器或IDE

JDK 8或更高版本

如何完成本指南

與大多數(shù)Spring入門指南一樣，您可以從頭開始并完成每個(gè)步驟，或者您可以繞過您已熟悉的基本設(shè)置步驟。無論哪種方式，您最終都會(huì)使用工作代碼。

要從頭開始，請(qǐng)繼續(xù)使用Gradle構(gòu)建。

要跳過基礎(chǔ)知識(shí)，請(qǐng)執(zhí)行以下操作：

下載并解壓縮本指南的源存儲(chǔ)庫(kù)，或使用Git克隆它：

git clone https://github.com/spring-guides/gs-maven.git

進(jìn)入gs-maven/initial

跳到最開始。

完成后，可以根據(jù)gs-maven/complete中的代碼檢查結(jié)果。

設(shè)置項(xiàng)目

首先，您需要為Maven設(shè)置一個(gè)Java項(xiàng)目來構(gòu)建。為了保持對(duì)Maven的關(guān)注，現(xiàn)在讓項(xiàng)目盡可能簡(jiǎn)單。在您選擇的項(xiàng)目文件夾中創(chuàng)建此結(jié)構(gòu)。

創(chuàng)建目錄結(jié)構(gòu)

在您選擇的項(xiàng)目目錄中，創(chuàng)建以下子目錄結(jié)構(gòu);例如，在*nix系統(tǒng)上使用mkdir -p src/main/java/hello:

└── src
    └── main
        └── java
            └── hello

在src/main/java/hello目錄中，您可以創(chuàng)建所需的任何Java類。為了與本指南的其余部分保持一致，請(qǐng)創(chuàng)建以下兩個(gè)類：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!";
    }
}

現(xiàn)在您已經(jīng)準(zhǔn)備好使用Maven構(gòu)建項(xiàng)目，下一步是安裝Maven。

Maven可以在http://maven.apache.org/download.cgi下載為zip文件。只需要二進(jìn)制文件，因此請(qǐng)查找指向apache-maven-{version}-bin.zip或apache-maven-{version}-bin.tar.gz的鏈接。

下載zip文件后，將其解壓縮到您的計(jì)算機(jī)上。然后將bin文件夾添加到路徑中。

要測(cè)試Maven安裝，請(qǐng)從命令行運(yùn)行mvn：

mvn -v

如果一切順利，您應(yīng)該會(huì)看到有關(guān)Maven安裝的一些信息。它看起來類似于（盡管可能略有不同）以下內(nèi)容：

Apache Maven 3.0.5 (r01de14724cdef164cd33c7c8c2fe155faf9602da; 2013-02-19 07:51:28-0600)
Maven home: /usr/share/maven
Java version: 1.7.0_09, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.7.0_09.jdk/Contents/Home/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.8.3", arch: "x86_64", family: "mac"

恭喜！你現(xiàn)在安裝了Maven。

定義一個(gè)簡(jiǎn)單的Maven pom

現(xiàn)在已經(jīng)安裝了Maven，您需要?jiǎng)?chuàng)建一個(gè)Maven項(xiàng)目定義。Maven項(xiàng)目使用名為pom.xml的XML文件定義。除此之外，該文件還提供了項(xiàng)目在外部庫(kù)上的名稱，版本和依賴關(guān)系。

在項(xiàng)目的根目錄下創(chuàng)建一個(gè)名為pom.xml的文件（即將其放在src文件夾旁邊），并為其提供以下內(nèi)容：



    4.0.0

    org.springframework
    gs-maven
    jar
    0.1.0

    
        1.8
        1.8
    

    
        
            
                org.apache.maven.plugins
                maven-shade-plugin
                2.1
                
                    
                        package
                        
                            shade
                        
                        
                            
                                
                                    hello.HelloWorld

除了可選**元素之外，這是構(gòu)建Java項(xiàng)目所必需的最簡(jiǎn)單的pom.xml文件。它包括項(xiàng)目配置的以下詳細(xì)信息：

**。POM模型版本（總是4.0.0）。

**。項(xiàng)目所屬的組或組織。通常表示為反向域名。

**。要賦予項(xiàng)目庫(kù)工件的名稱（例如，其JAR或WAR文件的名稱）。

**。正在構(gòu)建的項(xiàng)目的版本。

** - 如何打包項(xiàng)目。對(duì)于JAR文件打包，默認(rèn)為“jar”。使用“war”進(jìn)行WAR文件打包。

在選擇版本控制方案時(shí)，Spring建議采用語(yǔ)義版本控制方法。

此時(shí)，您已定義了一個(gè)最小但功能強(qiáng)大的Maven項(xiàng)目。

構(gòu)建Java代碼

Maven現(xiàn)在已準(zhǔn)備好構(gòu)建該項(xiàng)目。您現(xiàn)在可以使用Maven執(zhí)行多個(gè)構(gòu)建生命周期目標(biāo)，包括編譯項(xiàng)目代碼的目標(biāo)，創(chuàng)建庫(kù)包（例如JAR文件），以及在本地Maven依賴庫(kù)中安裝庫(kù)。

要嘗試構(gòu)建，請(qǐng)?jiān)诿钚兄邪l(fā)出以下命令：

mvn compile

這將運(yùn)行Maven，告訴它執(zhí)行編譯目標(biāo)。完成后，您應(yīng)該在target/classes目錄中找到已編譯的.class文件。

由于您不太可能希望直接分發(fā)或使用.class文件，因此您可能希望改為運(yùn)行package：

mvn package

package將編譯Java代碼，運(yùn)行任何測(cè)試，并通過包裝內(nèi)的一個(gè)JAR文件中的代碼終止上升的目標(biāo)目錄。JAR文件的名稱將基于項(xiàng)目和。例如，給定之前的最小pom.xml文件，JAR文件將命名為gs-maven-0.1.0.jar。

如果您已將“jar” 的值更改為“war”，則結(jié)果將是目標(biāo)目錄中的WAR文件而不是JAR文件。

Maven還在本地計(jì)算機(jī)上維護(hù)了一個(gè)依賴存儲(chǔ)庫(kù)（通常位于主目錄中的.m2/repository目錄中），以便快速訪問項(xiàng)目依賴項(xiàng)。如果您想將項(xiàng)目的JAR文件安裝到該本地存儲(chǔ)庫(kù)，那么您應(yīng)該調(diào)用install目標(biāo)：

mvn install

install將編譯，測(cè)試和打包項(xiàng)目的代碼，然后將其復(fù)制到本地依賴性庫(kù)，準(zhǔn)備好另一個(gè)項(xiàng)目中引用它作為一個(gè)依賴。

說到依賴關(guān)系，現(xiàn)在是時(shí)候在Maven構(gòu)建中聲明依賴關(guān)系了。

聲明依賴關(guān)系

簡(jiǎn)單的Hello World示例是完全獨(dú)立的，不依賴于任何其他庫(kù)。但是，大多數(shù)應(yīng)用程序依賴外部庫(kù)來處理常見和復(fù)雜的功能。

例如，假設(shè)除了說“Hello World！”之外，您還希望應(yīng)用程序打印當(dāng)前日期和時(shí)間。雖然您可以使用本機(jī)Java庫(kù)中的日期和時(shí)間工具，但您可以使用Joda Time庫(kù)使事情變得更有趣。

首先，將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類來獲取和打印當(dāng)前時(shí)間。

如果您現(xiàn)在要運(yùn)行mvn compile以構(gòu)建項(xiàng)目，則構(gòu)建將失敗，因?yàn)槟丛跇?gòu)建中將Joda Time聲明為編譯依賴項(xiàng)。您可以通過將以下行添加到pom.xml（在元素內(nèi)）來解決此問題：


        
            joda-time
            joda-time
            2.9.2

這個(gè)XML塊聲明了項(xiàng)目的依賴項(xiàng)列表。具體來說，它聲明了Joda Time庫(kù)的單一依賴項(xiàng)。在元素內(nèi)，依賴關(guān)系坐標(biāo)由三個(gè)子元素定義：

** - 依賴項(xiàng)所屬的組或組織。

** - 所需的庫(kù)。

** - 所需庫(kù)的特定版本。

默認(rèn)情況下，所有依賴項(xiàng)都作為compile依賴項(xiàng)確定范圍。也就是說，它們應(yīng)該在編譯時(shí)可用（如果您正在構(gòu)建WAR文件，包括在WAR的/WEB-INF/libs文件夾中）。此外，您可以指定一個(gè)元素以指定以下范圍之一：

provided - 編譯項(xiàng)目代碼所需的依賴關(guān)系，但是將在運(yùn)行時(shí)由運(yùn)行代碼的容器（例如，Java Servlet API）提供。

test - 用于編譯和運(yùn)行測(cè)試的依賴關(guān)系，但不是構(gòu)建或運(yùn)行項(xiàng)目的運(yùn)行時(shí)代碼所必需的依賴關(guān)系。

現(xiàn)在，如果您運(yùn)行mvn compile或mvn package，Maven應(yīng)該從Maven Central存儲(chǔ)庫(kù)解析Joda Time依賴關(guān)系，并且構(gòu)建將成功。

寫一個(gè)測(cè)試

首先在測(cè)試范圍中將JUnit添加為pom.xml的依賴項(xiàng)：


    junit
    junit
    4.12
    test

然后創(chuàng)建一個(gè)這樣的測(cè)試用例：

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使用一個(gè)名為“surefire”的插件來運(yùn)行單元測(cè)試。此插件的默認(rèn)配置src/test/java使用名稱匹配編譯并運(yùn)行所有*Test類。您可以在命令行上運(yùn)行測(cè)試

mvn test

或者只使用mvn install上面已經(jīng)顯示的步驟（有一個(gè)生命周期定義，其中“test”作為“安裝”中的一個(gè)階段包含在內(nèi)）。

這是完成的pom.xml文件：



    4.0.0

    org.springframework
    gs-maven
    jar
    0.1.0

    
        1.8
        1.8
    

    
        
        
            joda-time
            joda-time
            2.9.2
        
        
        
        
            junit
            junit
            4.12
            test
        
        
    

    
        
            
                org.apache.maven.plugins
                maven-shade-plugin
                2.1
                
                    
                        package
                        
                            shade
                        
                        
                            
                                
                                    hello.HelloWorld