實戰(zhàn)講解Maven安裝及基本使用詳解

更新時間：2020年10月06日 13:35:28 作者：莊周de蝴蝶

這篇文章主要介紹了實戰(zhàn)講解Maven安裝及基本使用詳解，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

前言

Apache Maven，是一個跨平臺的軟件項目管理及自動構(gòu)建工具，由Apache軟件基金會所提供。Maven主要服務(wù)于基于Java平臺的項目構(gòu)建、依賴管理和項目信息管理。Maven的目標(biāo)是能夠讓開發(fā)者在最短的時間內(nèi)了解項目開發(fā)工作的完整狀態(tài)，主要包括以下幾個方面：

•簡化項目構(gòu)建過程
•提供一個統(tǒng)一的項目構(gòu)建系統(tǒng)
•通過POM(project object model)提供一個項目的重要信息
•為最佳項目開發(fā)實踐提供一個指導(dǎo)方針

接下來本文就通過Maven的安裝、基本的指令使用和一個實際的小例子來帶你對Maven的使用有一個大體的認(rèn)識。此外，本文的樣例基于JDK1.8和Maven3。

環(huán)境準(zhǔn)備

在安裝Maven之前，首先要確保本地已安裝JDK并配置好了JAVA_HOME環(huán)境變量，可以在cmd通過以下命令進行驗證：

echo %JAVA_HOME%  # 輸出 JAVA_HOME 環(huán)境變量值
java -version    # 輸出 Java 版本信息

如果正常輸出了JDK的安裝路徑及java的版本信息，那么就可以開始進行下一步了，否則，你可能需要先到官網(wǎng)下載一個JDK，并按照下圖所示配置好環(huán)境變量：

安裝Maven

在確認(rèn)本地已安裝好了JDK并配置了環(huán)境變量后，我們就可以開始安裝Maven了，首先找到官網(wǎng)，然后找到安裝包下載即可，本文以 3.6.3 版本為例：

在下載完成后，解壓到本地文件夾即可，以我為例，我解壓在 D 盤：

在解壓完畢后，我們先進行環(huán)境變量的配置，配置一個名為M2_HOME的環(huán)境變量，對應(yīng)值為個人的Maven文件夾位置：

然后在Path系統(tǒng)變量中配置%M2_HOME%\bin即可：

在配置完成并保存后，重新打開cmd，輸入以下命令進行驗證，如果均得到正確信息，便表明已經(jīng)安裝成功：

echo %M2_HOME%  # 輸出 Maven 的安裝位置
mvn -v		 	 # 輸出 Maven 的版本信息

注意

你可能會疑惑為什么我們下載了Maven3卻要配置一個名為M2_HOME的環(huán)境變量，這主要是因為在Maven1時環(huán)境變量配置為MAVEN_HOME，在Maven2時改為了M2_HOME，而在Maven3則繼續(xù)沿用了這個命名，不過在Maven3.5.0以后，官方也舍棄了M2_HOME，因此我們現(xiàn)在其實只需要在Path中配置D:\apache-maven-3.6.3\bin即可，不過本文依舊沿用了M2_HOME。

安裝目錄介紹

在正式講解Maven的使用之前，我們先熟悉一下Maven的安裝目錄中各個文件夾的內(nèi)容及作用（基于Maven3.6.3版本）：

bin

該文件夾下包含了mvn運行的腳本，這些腳本用來配置Java命令，準(zhǔn)備好classpath和相關(guān)的Java系統(tǒng)屬性，然后執(zhí)行Java命令。其中mvn是基于UNIX平臺的shell腳本，mvn.cmd是基于Windows平臺的下的運行腳本。當(dāng)我們在命令行中輸入一條mvn命令時，其實就是在調(diào)用這些腳本。此外該文件夾中還包含了mvnDebug和mvnDebug.cmd這兩個文件，該腳本包含了mvn腳本所有的功能，只是多了一條MAVEN_DEBUG_OPTS的配置，用于調(diào)試Maven。除此之外，該文件夾內(nèi)還包含了m2.conf和mvnyjp文件，其中m2.conf是classworlds的配置文件，而mvnyjp則是為了配合Yourkit profiler的使用，關(guān)于classworlds和Yourkit profiler，本文不做介紹，感興趣可以自行查找資料。

boot

該文件夾下只有一個plexus-classworlds的jar包和其相關(guān)的license文件，plexus-classworlds是一個類加載框架，Maven使用該框架來加載自己的類庫。

conf

該文件下包含了一個我們以后接觸最多的settings.xml文件，主要用于配置代理、鏡像和插件等。

此外還包含了一個toolchains.xml配置文件和一個logging文件夾，其中toolchains.xml主要是為了方便我們指定項目所使用的JDK版本，需要配置maven-toolchains-plugin插件一起使用，而logging文件夾（內(nèi)含一個名為simplelogger.properties的配置文件）則用于配置我們在使用Maven時的日志。

lib

該文件夾下包含了所有Maven在運行時所需要的一些庫文件，這里就不做具體介紹了。

其它

此外還有LICENSE、NOTICE、README.txt用于說明開源協(xié)議和簡單介紹的文件。

實戰(zhàn)演練

下面我們就開始通過一個實際小案例來說明Maven的基本使用，為了加深對Maven中配置文件和基本指令的學(xué)習(xí)，我們就不使用IDEA等集成Maven的IDE了，直接使用VS CODE來進行接下來案例的講解。

首先，我們先創(chuàng)建一個名為maven的文件夾，然后通過VS CODE打開，新建一個名為pom.xml的文件夾，并在其中輸入以下內(nèi)容：

<?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/xsd/maven-4.0.0.xsd">

  <modelVersion>4.0.0</modelVersion>
  <groupId>com.butterfly.maven</groupId>
  <artifactId>demo</artifactId>
  <version>1.0-SNAPSHOT</version>
  <!-- 可選 -->
  <name>a demo maven project</name> 
  
</project>

下面對該文件中的內(nèi)容進行簡單介紹：

文件的第一行是XML頭，就像HTML中也有<!DOCTYPE html>頭為了告訴標(biāo)準(zhǔn)通用標(biāo)記語言解析器如何解析文檔一般，在XML這里主要是為了指定文檔的版本和編碼方式。緊接著是project，主要聲明了一些POM相關(guān)的命名空間和xsd元素，可以方便我們在使用IDE時編輯XML文檔。在project這個根元素下還有四個同級的元素，下面再一一介紹：

modelVersion：制定了當(dāng)前POM模型的版本，對于Maven2和Maven3來說，這個值固定為 4.0.0。
groupId：定義了項目屬于哪個組，一般都是對應(yīng)公司或組織的域名反寫并加上項目名，例如公司域名為abc.com，項目名為demo，那么groupId就是com.abc.demo。
artifactId：定義了在當(dāng)前Maven項目中的唯一的ID，當(dāng)項目包含多個子項目時，我們就需要特別注意命名方式。
version：指定了當(dāng)前項目的版本，SNAPSHOT意思是快照，即代表當(dāng)前項目屬于不穩(wěn)定的版本。
name：聲明了一個讓用戶更容易理解的項目名稱，改元素屬于可選項。

然后，我們就開始正式編寫項目的主代碼，我們首先按照Maven規(guī)范，在maven文件夾下創(chuàng)建一個src/main/java目錄，然后在該目錄下再根據(jù)我們在XML中groupId和artifactId的命名，創(chuàng)建文件：com/butterfly/maven/demo/Sum.java，并寫入以下內(nèi)容：

package com.butterfly.maven.demo;

public class Sum {

  private static int sum(int[] arr) {
    int sum = 0;
    for (int val : arr) {
      sum += val;
    }
    return sum;
  }

  public static void main(String[] args) {
    System.out.println(sum(new int[]{1, 3, 5, 7, 9}));
  }

}

然后在項目的根目錄下執(zhí)行mvn clean compile命令進行編譯，可以得到以下輸出（第一次執(zhí)行會下載很多插件依賴，下面輸出中省略了這些下載輸出）：

[INFO] Scanning for projects...
[INFO]
[INFO] ----------------------< com.butterfly.maven:demo >----------------------
[INFO] Building a demo maven project 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ demo ---
[INFO] Deleting D:\Temp\maven\target
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ demo ---
[INFO] skip non existing resourceDirectory D:\Temp\maven\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ demo ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to D:\Temp\maven\target\classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.975 s
[INFO] Finished at: 2020-10-02T21:27:55+08:00
[INFO] ------------------------------------------------------------------------

其中clean用于告訴Maven清理輸出目錄target/，compile告訴Maven編譯項目主代碼，從上面的輸出中也可以看出Maven首先執(zhí)行了maven-clean-plugin:2.5:clean進行刪除了target目錄，然后執(zhí)行了maven-resources-plugin:2.6:resources，由于項目中不存在resources文件，因此跳過了，最后執(zhí)行了maven-compiler-plugin:3.1:compile對主代碼進行編譯，并將編譯的結(jié)果放到target/classes目錄下，如下圖所示：

接下來，我們再編寫測試的代碼，首先我們依舊按照Maven規(guī)范，在src/目錄下繼續(xù)創(chuàng)建test/java目錄，然后在編寫正式的測試代碼之前，讓我們先引入JUnit的依賴，我們需要將pom.xml進行如下修改：

<!-- 添加在 project 根元素下 -->
<dependencies>
	<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13</version>
    <scope>test</scope>
	</dependency>
</dependencies>

然后我們就可以編寫我們的測試代碼了，我們在src/test/java/目錄下，創(chuàng)建demo/SumTest.java文件，并寫入以下內(nèi)容：

package demo;

import org.junit.Test;
import static com.butterfly.maven.demo.Sum.sum;
import static org.junit.Assert.assertEquals;

public class SumTest {

  @Test
  public void testSum() {
    assertEquals(10, sum(new int[]{1, 2, 3, 4}));
  }

}

然后我們在根目錄下開啟終端，并運行mvn clean test指令（第一次運行同樣會下載一些插件，這里也省略了這些下載輸出），可以在終端中得到以下信息：

[INFO] Scanning for projects...
[INFO] 
[INFO] ----------------------< com.butterfly.maven:demo >----------------------
[INFO] Building a demo maven project 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ demo ---
[INFO] Deleting D:\Temp\maven\target
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ demo ---
[INFO] skip non existing resourceDirectory D:\Temp\maven\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ demo ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to D:\Temp\maven\target\classes
[INFO] 
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ demo ---
[INFO] skip non existing resourceDirectory D:\Temp\maven\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ demo ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to D:\Temp\maven\target\test-classes
[INFO] 
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ demo ---
[INFO] Surefire report directory: D:\Temp\maven\target\surefire-reports

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running demo.SumTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.091 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.166 s
[INFO] Finished at: 2020-10-02T22:17:30+08:00
[INFO] ------------------------------------------------------------------------

根據(jù)輸出可以發(fā)現(xiàn)，執(zhí)行mvn clean test同樣也執(zhí)行了mvn clean compile中的clean、resources、compile這三個指定，不同的是，這里還多了對測試包中進行的三個操作，分別是testResources、testCompile和test，隨后打印了執(zhí)行單元測試后的輸出，可以發(fā)現(xiàn)執(zhí)行了一個測試（即為我們建立的testSum測試方法），并且沒有失敗的測試。

注意

對于不同版本的Maven，在第一次執(zhí)行上述操作的時候，可能會有關(guān)于JDK版本方面的報錯，提示我們編譯版本過低，這時就需要在pom.xml中添加如下配置：

<!-- 添加在 project 根元素下 -->
<build>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-compiler-plugin</artifactId>
			<configuration>
				<source>1.8</source>
				<target>1.8</target>
			</configuration>
		</plugin>
	</plugins>
</build>

此外，由于Maven在安裝依賴時，默認(rèn)是從國外網(wǎng)址下載，因此為了加快下載速度，我們需要配置國內(nèi)的鏡像，這時我們就需要對settings.xml文件進行修改，這里建議在修改之前做一個備份。打開settings.xml后，通過查找找到mirrors標(biāo)簽，然后在內(nèi)部添加如下配置即可：

<mirror>
	<id>alimaven</id>
	<name>aliyun maven</name>
	<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
	<mirrorOf>central</mirrorOf>    
</mirror>

還有一點需要注意的是，所有的依賴包默認(rèn)下載的位置是~/.m2/repository，這里的~代表的個人的用戶目錄，對我而言就是對應(yīng)C:/Users/zjw/.m2/repository。因此，如果不想將jar包放在 C 盤，就需要和mirrors同級，然后加入以下配置：

<localRepository>D:/jar</localRepository>

這樣，所有的依賴都會保存在D:/jar目錄下了。

打包及運行

在Maven里，我們只要通過mvn clean package命令就可以對項目進行打包了（默認(rèn)打包類型為jar），我們在cmd中輸入以上指令，可以得到下面的輸出（省略了和以上指令中相同的前幾個輸出）：

[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ demo ---
[INFO] Building jar: D:\Temp\maven\target\demo-1.0-SNAPSHOT.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

執(zhí)行完畢后，我們就可以在target/目錄下發(fā)現(xiàn)我們生成的jar包了。此外，如果我們想要像引用其它jar包一樣，在其它的項目中引入我們自己的jar包也是可以的，但是如果每次都要將jar包一個一個地復(fù)制到其他項目中是非常麻煩的，但是通過Maven，我們只需要一個mvn clean install命令就可以將當(dāng)前項目的jar包安裝到本地倉庫：

可以發(fā)現(xiàn)和mvn clean package相比，又多了如下幾行輸出：

[INFO] --- maven-install-plugin:2.4:install (default-install) @ demo ---
[INFO] Installing D:\Temp\maven\target\demo-1.0-SNAPSHOT.jar to D:\jar\com\butterfly\maven\demo\1.0-SNAPSHOT\demo-1.0-SNAPSHOT.jar
[INFO] Installing D:\Temp\maven\pom.xml to D:\jar\com\butterfly\maven\demo\1.0-SNAPSHOT\demo-1.0-SNAPSHOT.pom

按照信息，我們可以知道，我們生成的jar包被保存在了D:/jar/com/butterfly/maven/demo/1.0-SNAPSHOT/目錄下，我們可以打開文件資源管理器進行驗證：

這樣，我們就可以在其它項目中，通過以下配置來引用我們自己的jar包了：

<dependency>
  <groupId>com.butterfly.maven</groupId>
  <artifactId>demo</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

不過，到目前為止，我們?nèi)匀粵]有運行主代碼中的main函數(shù)部分，由于默認(rèn)生成的jar包中缺少manifest配置，因此上文生成的jar包并沒有辦法直接運行，為了生成能夠執(zhí)行的jar包，我們還需要在pom.xml加入以下配置：

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-shade-plugin</artifactId>
	<version>1.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>com.butterfly.maven.demo.Sum</mainClass>
          </transformer>
        </transformers>
      </configuration>
		</execution>
	</executions>
</plugin>

再次執(zhí)行mvn clean install命令，可以發(fā)現(xiàn)target/目錄下有兩個jar包：