工具庫之《Maven》

Why Maven

只要還在做Java開發,Maven是繞不過去的一道坎。
盡管官方一再強調它作為一整套項目管理解決方案的定位,但大而全的目標加上復雜的設計,往往讓初見Maven的人皺眉,最后也不過是使用其中的一兩項功能。
一個東西的設計是否簡潔優雅,其實并不由設計者說了算,而在于用戶使用它的方式。當Maven沒有對它的設計和功能做簡化的時候,用戶的使用方式投了票。

在我看來,人們離不開Maven,其實是離不開它這兩個功能[1] 包管理。[2] 項目打包。

本文的內容分為5部分

  1. 厘清Maven 與 IDE (Eclipse / Intellij) 的關系
  2. 介紹一些背景知識,主要是關于Maven項目的創建和配置文件pom.xml
  3. Maven的包管理功能
  4. Maven的項目打包功能
  5. 附錄是關于Maven的安裝和配置,便于每次安裝后快速配置

我希望通過本文,能

  • 厘清Maven的基本概念
  • 掌握Maven最常用的包管理和打包功能
  • 在安裝Maven時能快速的配置好環境

Maven 與 IDE (Eclipse / Intellij) 的關系

Maven是個獨立的工具,安裝之后可以在命令行界面使用。
IDE 需要安裝Maven插件,關聯上已經安裝的Maven之后,才能在IDE中調用Maven的功能。其中Eclipse的Maven插件為m2eclipse。Intellij則默認自帶了Maven插件,直接做相應的關聯配置即可。

后面的例子都會以命令行環境下的Maven命令作說明,重點在于說明Maven工具的功能。具體的IDE插件,只不過是圖形化封裝調用了Maven命令而已。

必要的背景知識

使用Maven首先需創建Maven工程。創建只需一條命令
mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

  • archetype:generate是Maven眾多插件中的一個,這個插件用于創建工程。
  • maven-archetype-quickstart則是說按照這個模版來創建工程。Maven有許多默認的和第三方編寫的模版。
  • artifactId參數指明了工程所在目錄的名字。
  • groupId參數則指定工程所屬的java包。。

比如上述命令執行成功之后,就會在當前目錄生成一個my-app目錄,其目錄結構如Figure 1所示。這個目錄結構也是Maven提倡的所謂良好的工程組織結構,源碼和測試代碼分別在src和test目錄下。


Figure 1. Maven工程目錄結構

目錄下的pom.xml文件是整個工程的配置文件,用Maven做包管理和打包配置都需要修改這個文件。

Maven包管理

當你的工程需要依賴于某個第三方的包時,只需要在pom.xml文件中加入依賴包的配置即可。一般第三方包都會在主頁上給出其依賴配置,比如junit的配置如下:

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>3.8.1</version>
    <scope>test</scope>
</dependency>

將其粘貼到pom.xml中的<dependencies>即完成了包依賴。然后在編譯運行你的項目時Maven會根據配置自動的幫你下載依賴包。同時你也不必關注依賴包是否還依賴了其他的包,Maven會幫你管理好二級依賴。

增加了junit依賴的pom.xml示例如下:

<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>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <packaging>jar</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>my-app</name>
  <url>http://maven.apache.org</url>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

</project>

Maven打包功能

Maven項目的打包很方便。只需要在項目根目錄執行一條命令mvn package即可。
命令背后的原理是,maven將軟件生命周期抽象為許多順序的Phase,其中最常見的階段順序羅列如下:(更全的Phase列表見Maven官方文檔

  • mvn compile : 編譯項目
  • mvn test :運行測試用例
  • mvn package :將編譯后的代碼打包
  • mvn install :將打好的包加入到本地倉庫
  • mvn deploy : 將本地包部署到maven遠程倉庫供更多人使用。

當運行mvn package時,Maven會將package階段前包括package在內的Phase順序執行一次。打好的包默認情況下放在target目錄之下。
使用java命令即可運行
java -cp target/my-app-1.0-SNAPSHOT.jar com.mycompany.app.App
參數cp用于指定main函數所在的類路徑,在本例中是main函數所在類為com.mycompany.app.App。

需要注意,默認情況下mvn package打包時并不會包含依賴的第三方包。假設需要將整個項目連同它的依賴打成一個包,從而可以方便的在任何Java環境下運行,可以使用Shade插件。
具體的使用方法將如下配置加入pom.xml,再次執行mvn package即在target目錄下得到包含了所有依賴的包。

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>2.3</version>
        <configuration>
          <!-- put your configurations here -->
        </configuration>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>shade</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

附錄:Maven的安裝和配置

Maven只是一個工具包,下載之后將解壓后的目錄放到你喜歡的地方,然后做如下操作便可以運行 (Unix系統適用,Windows用戶見官網文檔):

  1. 確保安裝了JDK并設置了環境變量JAVA_HOME,比如
    export JAVA_HOME=/usr/java/jdk1.7.0_51
    Mac OS X則用戶則可以這樣
    export JAVA_HOME=$(/usr/libexec/java_home
  2. 確保JAVA_HOME/bin目錄在你的PATH環境變量中
    export PATH=$JAVA_HOME/bin:$PATH
  3. 設置Maven相關環境變量 (假設Maven解壓在/usr/local/apache-maven/apache-maven-3.2.3)
export M2_HOME=/usr/local/apache-maven/apache-maven-3.2.3
export M2=$M2_HOME/bin
export PATH=$M2:$PATH
  1. 運行mvn -version成功即表示安裝OK。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,362評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,577評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,486評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,852評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,600評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,944評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,944評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,108評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,652評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,385評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,616評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,111評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,798評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,205評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,537評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,334評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,570評論 2 379

推薦閱讀更多精彩內容