來源：lmportNew - 唐尤華
鏈接：http://www.importnew.com/30864.html
從零開始用好 Maven：從 Hello World 到日常使用


1. Maven簡介

Apache Maven 是一個軟件項目管理工具。基於項目對象模型（POM）的理念，通過一段核心描述信息來管理項目構建、報告和文檔信息。

Maven 是一個意第緒語（猶太人使用的國際語）單詞，意思是知識的累加器。它最開始是被用來簡化 Jakarta Turbine 項目的構建過程。在 Jakarta Turbine 項目中有幾個不同的項目，雖然它們的Ant構建文件差異很小，但是 jar 包都在 CVS 上。於是想要找到一個標準而又簡單的項目構建方法，既可以清晰地定義出這個項目由什麼構成併發布項目信息，又能在不同項目間共享Jar包。

現在，任何一個基於Java的項目都能使用Maven來構建和管理，使 Java 開發人員的日常工作變得更輕鬆，讓Java項目更容易被理解。

2. Maven使用

2.1 安裝

必備條件： 已安裝JDK

注意事項： Maven 3.3 及更高版本要求 JDK1.7 或者更高版本

2.2 Windows

下載解壓縮

  • 打開下載頁面：http://maven.apache.org/download.cgi
  • 選擇最新的版本，或者到這裏 https://archive.apache.org/dist/maven/maven-3/ 找到你中意的版本
  • 下載 apache-maven-{版本號}-bin.zip
  • 找到合適的目錄：最好無空格和中文，解壓，內容如下


bin\
boot\
conf\
lib\
README.txt
NOTICE
LICENSE


配置環境變量

  • 計算機 > 屬性 > 高級系統設置 > 環境變量 > 系統變量
  • 新建 M2_HOME 變量，內容爲 {解壓路徑}\apache-maven-{版本號}
  • 編輯 Path 變量，在內容結尾加上 ;%M2_HOME%\bin;


2.3 Linux

包管理器安裝

$ sudo apt install maven


下載安裝

  • 下載 apache-maven-{版本號}-bin.tar.gz
  • 配置環境變量 export PATH=/opt/apache-maven-{版本號}/bin:$PATH


2.4 驗證

Windows 打開 Cmd，Linux 運行 Shell，看到下面信息表示安裝成功。

$ mvn -version
Apache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-11T00:41:47+08:00)
Maven home: D:\software\java\apache-maven-3.3.9
Java version: 1.8.0_191, vendor: Oracle Corporation
Java home: c:\Program Files\java\jdk1.8.0_191\jre
Default locale: zh_CN, platform encoding: GBK
OS name: "windows 7", version: "6.1", arch: "amd64", family: "dos"


2.5 設置Maven

Maven通過 settings.xml 進行配置

完整的參數說明可查看

http://maven.apache.org/ref/3.6.0/maven-settings/settings.html


2.5.1 自定義倉庫位置(可選)

Maven 下載的 jar 包默認存儲到 ${user.home}/.m2/repository

編輯 {安裝路徑}\config\settings.xml，在下面增加一行填入自定義位置：

 
{自定義位置}\repository


Linux 查看安裝路徑

$ ls -lsa /usr/share/maven
...
 0 lrwxrwxrwx 1 root root 10 12月 10 2015 conf -> /etc/maven
 
$ ls -lsa /etc/maven
 4 drwxr-xr-x 2 root root 4096 11月 27 11:45 logging
 4 -rw-r--r-- 1 root root 222 11月 19 2015 m2.conf
12 -rw-r--r-- 1 root root 10216 11月 19 2015 settings.xml
 4 -rw-r--r-- 1 root root 3649 11月 19 2015 toolchains.xml


2.5.2 設置國內鏡像(可選)

Maven 默認從中央倉庫 central 下載

改爲國內鏡像速度更快

編輯 {安裝路徑}\config\settings.xml，在 標籤里加入新的鏡像：


 
 alimaven
 central
 aliyun maven
 https://maven.aliyun.com/repository/central


3. 使用

3.1 快速上手

3.1.1 新建示例項目

命令行不是必須的，但這個過程能有助於理解在 IDE 中的操作。

命令行新建項目

Windows 打開 Cmd，Linux 運行 Shell，執行下面指令。

mvn archetype:generate -DgroupId=org.tyh.mvn.quickstart -DartifactId=mvn-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.3 -DinteractiveMode=false


執行成功可以看到下面字樣：

[INFO] BUILD SUCCESS


POM.xml 包含了命令中的信息

org.tyh.mvn.quickstart
mvn-quickstart
1.0-SNAPSHOT
mvn-quickstart


目錄結構

quickstart 項目的結構如下：

  • 項目源碼：src/main/java
  • Web 項目源碼：src/main/webapp
  • 測試源碼：src/test/java
  • Maven 項目結構(Project Object Model POM)：pom.xml


注意： 配置文件，如 log4j.properties 需要新建 src\main\resources 目錄。這樣編譯時會打包到生成的 jar 中。

mvn-quickstart
│ pom.xml
│ 
└─src
 ├─main
 │ └─java
 │ └─org
 │ └─tyh
 │ └─mvn
 │ └─quickstart
 │ App.java
 │ 
 └─test
 └─java
 └─org
 └─tyh
 └─mvn
 └─quickstart
 AppTest.java


提示： 生成目錄結構，Windows 在 Cmd 中輸入 tree /f，Linux 安裝 tree 程序後可直接輸入 tree。

有關目錄結構完整介紹可以查看

http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html


3.1.2 構建項目

Windows 打開 Cmd，Linux 運行 Shell，執行下面指令。

mvn package


執行成功可以看到下面字樣：

[INFO] BUILD SUCCESS


查看生成結果，在項目中新增了 target 目錄，裏面主要關注以下文件：

  • class 文件：target\classes\org\tyh\mvn\quickstart\App.class
  • test-classes 文件：target\test-classes\org\tyh\mvn\quickstart\AppTest.class
  • jar 文件：target\mvn-quickstart-1.0-SNAPSHOT.jar


mvn-quickstart
│ pom.xml
│ 
└─target
 │ mvn-quickstart-1.0-SNAPSHOT.jar
 │ 
 ├─classes
 │ └─org
 │ └─tyh
 │ └─mvn
 │ └─quickstart
 │ App.class
 │ 
 ├─generated-sources
 │ └─annotations
 ├─generated-test-sources
 │ └─test-annotations
 ├─maven-archiver
 │ pom.properties
 │ 
 ├─maven-status
 │ └─maven-compiler-plugin
 │ ├─compile
 │ │ └─default-compile
 │ │ createdFiles.lst
 │ │ inputFiles.lst
 │ │ 
 │ └─testCompile
 │ └─default-testCompile
 │ createdFiles.lst
 │ inputFiles.lst
 │ 
 ├─surefire-reports
 │ org.tyh.mvn.quickstart.AppTest.txt
 │ TEST-org.tyh.mvn.quickstart.AppTest.xml
 │ 
 └─test-classes
 └─org
 └─tyh
 └─mvn
 └─quickstart
 AppTest.class


3.1.3 運行

Windows 打開 Cmd，Linux 運行 Shell，執行下面指令。

java -cp target/mvn-quickstart-1.0-SNAPSHOT.jar org.tyh.mvn.quickstart.AppHello World!


執行測試：

mvn test


執行成功可以看到下面的結果：

[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
[INFO] Running org.tyh.mvn.quickstart.AppTest
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.133 s - in org.tyh.mvn.quickstart.AppTest
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0


3.2 新增依賴

3.2.1 搜索Maven

爲項目添加一個依賴，比如 Apache Commons Lang 和 Slf4j 日誌。

搜索

搜索時可採用高級搜索，g:{groupId} a:{artifactId}。例如 g:log4j a:log4j 就會列出 log4j 的最新版本。

  • Maven central 倉庫：https://search.maven.org/
  • Aliyun 鏡像倉庫：http://maven.aliyun.com/mvn/search
  • 其他搜索倉庫
  • https://repository.apache.org
  • https://mvnrepository.com


注意： 類似 slf4j 這樣依賴其他實現的包，需要查看官方文檔，確認需要配合使用的 jar 包。否則會出 現編譯通過，運行報錯 的情況。

3.2.2 加入依賴項


 
 junit
 junit
 4.11
 test
 
 
 
 
 
 org.slf4j
 slf4j-log4j12
 1.8.0-beta2
 
 
 
 
 org.apache.commons
 commons-lang3
 3.8.1


3.2.3 驗證

修改 App 類，加入 Log 和 測試代碼：

package org.tyh.mvn.quickstart;
 
import org.apache.commons.lang3.ArrayUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
/**
 * ArrayUtils Demo
 *
 */
public class App 
{
 public static void main( String[] args )
 {
 Logger logger = LoggerFactory.getLogger(App.class);
 
 float[] farr = {1.1f, 1.2f, 1.3f};
 logger.info(ArrayUtils.toString(farr));
 
 farr = ArrayUtils.removeElements(farr, 1.1f);
 logger.info(ArrayUtils.toString(farr));
 }
}


執行程序之前，要找到依賴的 jar 文件所在的目錄。默認是在 {用戶主目錄}/.m2/ 目錄 下，利用 dependency:copy 插件 可以拷貝到 target\dependency 目錄：

mvn dependency:copy-dependencies


查看結果：

├─dependency
│ commons-lang3-3.8.1.jar
│ hamcrest-core-1.3.jar
│ junit-4.11.jar
│ log4j-1.2.17.jar
│ slf4j-api-1.8.0-beta2.jar
│ slf4j-log4j12-1.8.0-beta2.jar


在命令行運行時，用 -cp 加入依賴的 jar 所在目錄：

java -cp .;dependency/*;mvn-quickstart-1.0-SNAPSHOT.jar org.tyh.mvn.quickstart.App


注意： 編譯前需要加入 log4j.properties 到 src\main\resources 目錄。下面是一個 Windows 下的 log4j.properties。

# Root logger option
log4j.rootLogger=INFO, file, stdout
 
# Direct log messages to a log file
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=C:\\temp\\logging.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
 
# Direct log messages to stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n


3.3 IDE中使用

3.3.1 Eclipse

新建項目

1. 新建 Maven 項目

  • File > New > Project
  • 選擇 Maven Project (目錄報錯及解決辦法*)
  • （可選）項目類型 maven-archetype-simple 或其他類型
  • 輸入 Group Id, Artifact Id, Name，Finish


2. 添加依賴

  • pom.xml 右鍵菜單 > Maven > Add Dependency
  • 在輸入框中輸入，比如 slf4j 會自動列出匹配結果，OK
  • 加入新的依賴保存文件，會在 Maven Dependencies 中列出 jar 及路徑，並添加到項目的 classpath 中


3. 編碼

  • 編寫 Java 代碼，調試


4. 構建

  • 項目 右鍵菜單 > Run As > Maven build
  • 第一次運行會提示輸入 Maven build 的目標：Goal 裏填寫 package 進行構建 （支持的常用命令可以在這裏找到 Maven in 5 Minutes：Maven Phases）


導入項目

  • File > Import
  • 選擇 Maven > Existing Maven Project
  • 選擇項目 pom.xml 目錄，Projects: 下面勾選 target
  • 點擊完成


3.3.2 Idea

1. 新建 Maven 項目

  • File > New > Project
  • 選擇 Maven
  • （可選）項目類型 maven-archetype-simple 或其他類型
  • 輸入 Group Id, Artifact Id
  • 輸入項目名稱，Finish


2. 添加依賴

  • pom.xml 手動添加依賴信息
  • 加入新的依賴保存文件，會在 External Libraries 中列出 jar 及路徑，並添加到項目的 classpath 中


3. 編碼

  • 編寫 Java 代碼，調試


4. 構建

  • pom.xml 右鍵菜單 > Build module’module name’
  • Maven build 會提示警告：Warning:java: 源值1.5已過時, 將在未來所有發行版中刪除：可加入配置項解決


4. 常見問題與辦法

4.1 如何設置編譯支持的 JDK 版本？

全局指定

下面的腳本指定編譯版本兼容 JDK 1.7


 ...
 
 1.7
 1.7
 
 ...


指定插件

在不改變全局兼容性的情況下，可以在插件中指定。例如，下面的腳本指定了 maven-compiler-plugin 編譯的版本兼容 JDK 1.7。


 ...
 
 ...
 
 
 org.apache.maven.plugins
 maven-compiler-plugin
 3.3
 
 1.7
 1.7
 
 
 
 ...
 
 ...


4.2 如何指定自己的目錄結構？

可以通過設置 節點下 , 參數指定。

4.3 在 pom 文件中配置了依賴，編譯時還會報錯。

下載的 jar 文件可能有問題。

  • 檢查 maven 倉庫地址，在搜索條件中檢查 groupId 和 artifactId 是否正確。
  • mvn clean 清理文件。
  • mvn package 重新編譯。


4.4 [WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!

POM 文件中沒有指定編譯時編碼格式，可加入下面屬性指定爲 UTF-8。


 UTF-8


類似的問題： [WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent!

4.5 Invalid project description. … overlaps the workspace …

Eclipse 新建 Maven 項目時，可能會報告此錯誤。解決辦法兩種：

  1. 選擇 workspace 以外的目錄作爲項目目錄；
  2. 新建 Java Project，然後轉爲 Maven 項目：右鍵菜單 Config -> Convert to Maven Project


4.6 Warning:java: 源值1.5已過時, 將在未來所有發行版中刪除

Idea 在 Maven Build 時發出警告，在 pom.xml 中加入以下內容：


 src
 
 
 maven-compiler-plugin
 3.8.0
 
 1.8
 1.8

相關文章