Why Maven
只要還在做Java開發,Maven是繞不過去的一道坎。
盡管官方一再強調它作為一整套項目管理解決方案的定位,但大而全的目標加上復雜的設計,往往讓初見Maven的人皺眉,最后也不過是使用其中的一兩項功能。
一個東西的設計是否簡潔優雅,其實并不由設計者說了算,而在于用戶使用它的方式。當Maven沒有對它的設計和功能做簡化的時候,用戶的使用方式投了票。
在我看來,人們離不開Maven,其實是離不開它這兩個功能[1] 包管理。[2] 項目打包。
本文的內容分為5部分
- 厘清Maven 與 IDE (Eclipse / Intellij) 的關系
- 介紹一些背景知識,主要是關于Maven項目的創建和配置文件pom.xml
- Maven的包管理功能
- Maven的項目打包功能
- 附錄是關于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目錄下。
目錄下的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用戶見官網文檔):
- 確保安裝了JDK并設置了環境變量JAVA_HOME,比如
export JAVA_HOME=/usr/java/jdk1.7.0_51
Mac OS X則用戶則可以這樣
export JAVA_HOME=$(/usr/libexec/java_home
- 確保JAVA_HOME/bin目錄在你的PATH環境變量中
export PATH=$JAVA_HOME/bin:$PATH
- 設置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
- 運行mvn -version成功即表示安裝OK。