0. 前言
Jason Van Zyl,在 Java 十大風(fēng)云人物排行榜上或許會(huì)看到他,。
這兄弟是干嘛的,?
他就是 Maven 的創(chuàng)始人,人們都尊稱他為“Maven 他爹”。
毋庸置疑,,Jason 也是一個(gè)禿頂。James Gosling,、Rod Johnson,、Gavin King,你們可以告訴我為什么嗎,?
您曾經(jīng)是否會(huì)遇到這些問題:
-
我們要開發(fā)一個(gè) Java 項(xiàng)目,,為了保證編譯通過,我們會(huì)到處去尋找 jar 包,。當(dāng)編譯通過了,,在運(yùn)行的時(shí)候,卻發(fā)現(xiàn) ClassNotFoundException,,我操,!還差 jar 包啊,?再去找找吧,。
-
每個(gè) Java 項(xiàng)目的目錄結(jié)構(gòu)都沒有一個(gè)統(tǒng)一的標(biāo)準(zhǔn),配置文件到處都是,,單元測(cè)試代碼到底應(yīng)該放在哪里,,沒有一個(gè)權(quán)威的規(guī)范。
-
可使用 Ant 做為項(xiàng)目構(gòu)建工具,,它可以自動(dòng)化地完成編譯,、測(cè)試、打包等任務(wù),,確實(shí)為我們省了不少事兒,,但編寫 Ant 的 XML 腳本絕非是一件輕松的事情。
有了 Maven,,以上這一切都不再是問題了,。
Jason 就是 Java 開發(fā)規(guī)范的“救世主”!他給我們帶來了一種全新的項(xiàng)目構(gòu)建方式,,讓我們的開發(fā)工作更加高效,。
不僅如此,Jason 還是一名“野心家”,,他不僅希望每個(gè) Java 開發(fā)者都能使用他定義的規(guī)范,,還要我們都從他家里去獲取 jar 包(他家就是 Maven 中央倉庫),我們只需告訴他,,我們想要的 jar 包具體在什么位置即可(這個(gè)位置就是 Maven 坐標(biāo)),。
看來 Jason 要做的是兩件事情:
-
統(tǒng)一開發(fā)規(guī)范與工具
-
統(tǒng)一管理 jar 包
這兩件事情他都做到了,而且還做了更多的事情。
工欲善其事,,必先利其器,。咱們也來玩玩 Maven 這貨吧!先得去下載一個(gè),。
1. 安裝 Maven
Maven 是 Apache 基金會(huì)的頂級(jí)項(xiàng)目,,一般情況下,被 Apache 看中的都不會(huì)是爛貨,。
我們可以從 http://maven./ 下載 Maven 開發(fā)包,,其實(shí)就是一個(gè)壓縮包,下載完畢后,,解壓一下,,配置一下環(huán)境變量就可以用了。真是超簡(jiǎn)單,!
假設(shè)我們剛剛下載了一個(gè) apache-maven-3.1.1-bin.zip 文件,,現(xiàn)在將其解壓到 D:/SDK 目錄下 。我們不妨將解壓后的目錄重命名為 Maven,,這樣Maven 的根目錄就是 D:/SDK/Maven 了,。
有兩個(gè)環(huán)境變量可以配置:
以上 M2_HOME 是必須要配置的,如果想讓 Maven 跑得更快點(diǎn),,可以根據(jù)自己的情況來設(shè)置 MAVEN_OPTS,。
現(xiàn)在我們可以打開 cmd,輸入:
mvn -v
我想您一定會(huì)看到一些信息,,恭喜您,,Maven 安裝成功!
在使用 Maven 之前,,很有必要了解一下 Maven 到底是怎樣管理 jar 包的,,這就是 Maven 倉庫要干的活了。
2. 了解 Maven 倉庫
使用 Maven 給我們帶來的最直接的幫助,,就是 jar 包得到了統(tǒng)一管理,,那么這些 jar 包存放在哪里呢?它們就在您的 本地倉庫 中,,位于 C:\Users\用戶名\.m2 目錄下(當(dāng)然也可以修改這個(gè)默認(rèn)地址),。
實(shí)際上可將本地倉庫理解“緩存”,因?yàn)轫?xiàng)目首先會(huì)從本地倉庫中獲取 jar 包,,當(dāng)無法獲取指定 jar 包的時(shí)候,,本地倉庫會(huì)從 遠(yuǎn)程倉庫(或 中央倉庫) 中下載 jar 包,并放入本地倉庫中以備將來使用,。這個(gè)遠(yuǎn)程倉庫是 Maven 官方提供的,,可通過 http://search./ 來訪問。這樣一來,本地倉庫會(huì)隨著項(xiàng)目的積累越來越大,。通過下面這張圖可以清晰地表達(dá)項(xiàng)目,、本地倉庫、遠(yuǎn)程倉庫之間的關(guān)系,。
這個(gè)結(jié)構(gòu)是否與 Git 的本地倉庫與遠(yuǎn)程倉庫有異曲同工之妙呢,?
既然 Maven 安裝了,那么本地倉庫也就有了,,下面我們就一起來創(chuàng)建一個(gè) Maven 項(xiàng)目吧。
3. 創(chuàng)建 Maven 項(xiàng)目
我們不妨創(chuàng)建一個(gè) Java Web 項(xiàng)目,,只需在 cmd 中輸入:
mvn archetype:generate
隨后 Maven 將下載 Archetype 插件及其所有的依賴插件,,這些插件其實(shí)都是 jar 包,它們存放在您的 Maven 本地倉庫中,。
在 cmd 中,,您會(huì)看到幾百個(gè) Archetype(原型),可將它理解為項(xiàng)目模板,,您得從中選擇一個(gè),。
我們的目標(biāo)是創(chuàng)建 Java Web 項(xiàng)目,所以您可以選擇 maven-archetype-webapp(可以在 cmd 中進(jìn)行模糊搜索),,隨后 Maven 會(huì)與您進(jìn)行一些對(duì)話,,Maven 想知道以下信息:
-
項(xiàng)目 Archetype Version(原型版本號(hào))是什么?—— 可選擇 1.0 版本
-
項(xiàng)目 groupId(組織名) 是什么,?—— 可輸入 com.smart
-
項(xiàng)目 artifactId(構(gòu)件名)是什么,?—— 可輸入 smart-demo
-
項(xiàng)目 version(版本號(hào))是什么?—— 可輸入 1.0
-
項(xiàng)目 package(包名)是什么,?—— 可輸入 com.smart.demo
以上這種方式稱為 Interactive Mode(交互模式),。
如果您是一位高效人士,或許覺得這樣的交互過于繁瑣,,那么您也可以嘗試僅使用一條命名,,來完成同樣的事情:
mvn archetype:generate -DinteractiveMode=false -DarchetypeArtifactId=maven-archetype-webapp -DgroupId=com.smart -DartifactId=smart-demo -Dversion=1.0
以上這種方式成為 Batch Mode(批處理模式)。
當(dāng)然,,還有第三種選擇,,使用 IDE 來創(chuàng)建 Maven 項(xiàng)目,您可以使用 Eclipse,、NetBeans,、IDEA 來創(chuàng)建 Maven 項(xiàng)目,操作過程應(yīng)該是非常簡(jiǎn)單的,。
您也可以使用 IDEA 直接打開一個(gè) Maven 項(xiàng)目,,只需要 File -> Open -> 選擇 pom.xml,那么下面您就可以在 IDEA 中開發(fā) Maven 項(xiàng)目了,貼一張圖片吧:
其實(shí)這個(gè)目錄結(jié)構(gòu)還不太完備,,我們需要手工添加幾個(gè)目錄上去,,最終的目錄結(jié)構(gòu)看起來是這樣的:
我們手工創(chuàng)建了三個(gè)目錄:
-
src/main/java
-
src/test/java
-
src/test/resources
為什么自動(dòng)生成的目錄不完備?確實(shí)挺無語的,,我們就不要去糾結(jié)了,。不過有必要稍微解釋一下這個(gè) Maven 目錄規(guī)范:
-
main 目錄下是項(xiàng)目的主要代碼,test 目錄下存放測(cè)試相關(guān)的代碼,。
-
編譯輸出后的代碼會(huì)放在target 目錄下(該目錄與 src 目錄在同一級(jí)別下,,這里沒有顯示出來)。
-
java 目錄下存放 Java 代碼,,resources 目錄下存放配置文件,。
-
webapp 目錄下存放 Web 應(yīng)用相關(guān)代碼。
-
pom.xml 是 Maven 項(xiàng)目的配置文件,。
其中 pom.xml 稱為 Project Object Model(項(xiàng)目對(duì)象模型),,它用于描述整個(gè) Maven 項(xiàng)目,所以也稱為 Maven 描述文件,。
可見 pom.xml 才是理解 Maven 的關(guān)鍵點(diǎn),,很有必要看看它到底長(zhǎng)什么樣。
4. 理解 pom.xml
當(dāng)您打開自動(dòng)生成的 pom.xml,,或許會(huì)感覺到可讀性不太好,,有必要做一下格式化,經(jīng)過整理后是這樣的:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | < project xmlns = "http://maven./POM/4.0.0"
xmlns:xsi = "http://www./2001/XMLSchema-instance"
xsi:schemaLocation="http://maven./POM/4.0.0
http://maven./maven-v4_0_0.xsd">
< modelVersion >4.0.0</ modelVersion >
< groupId >com.smart</ groupId >
< artifactId >smart-demo</ artifactId >
< version >1.0</ version >
< packaging >war</ packaging >
< name >smart-demo Maven Webapp</ name >
< url >http://maven.</ url >
< dependencies >
< dependency >
< groupId >junit</ groupId >
< artifactId >junit</ artifactId >
< version >3.8.1</ version >
< scope >test</ scope >
</ dependency >
</ dependencies >
< build >
< finalName >smart-demo</ finalName >
</ build >
</ project >
|
從上往下簡(jiǎn)要說明一下:
-
modelVersion:這個(gè)是 POM 的版本號(hào),,現(xiàn)在都是 4.0.0 的,,必須得有,但不需要修改,。
-
groupId,、artifactId、version:分別表示 Maven 項(xiàng)目的組織名,、構(gòu)件名,、版本號(hào),它們?nèi)齻€(gè)合起來就是 Maven 坐標(biāo),,根據(jù)這個(gè)坐標(biāo)可以在 Maven 倉庫中對(duì)應(yīng)唯一的 Maven 構(gòu)件,。
-
packaging:表示該項(xiàng)目的打包方式,war 表示打包為 war 文件,,默認(rèn)為 jar,,表示打包為 jar 文件。
-
name,、url:表示該項(xiàng)目的名稱與 URL 地址,,意義不大,,可以省略。
-
dependencies:定義該項(xiàng)目的依賴關(guān)系,,其中每一個(gè) dependency 對(duì)應(yīng)一個(gè) Maven 項(xiàng)目,,可見 Maven 坐標(biāo)再次出現(xiàn),還多了一個(gè) scope,,表示作用域(下面會(huì)描述),。
-
build:表示與構(gòu)建相關(guān)的配置,這里的 finalName 表示最終構(gòu)建后的名稱 smart-demo.war,,這里的 finalName 還可以使用另一種方式來定義(下面會(huì)描述),。
如果用樹形圖來表達(dá) pom.xml,那么會(huì)更加清晰:
可見,,除了項(xiàng)目的基本信息(Maven 坐標(biāo),、打包方式等)以外,每個(gè) pom.xml 都應(yīng)該包括:
-
Lifecycle(生命周期)
-
Plugins(插件)
-
Dependencies(依賴)
Lifecycle 是項(xiàng)目構(gòu)建的生命周期,,它包括 9 個(gè) Phase(階段)。
大家知道,,Maven 是一個(gè)核心加上多個(gè)插件的架構(gòu),,而這些插件提供了一系列非常重要的功能,這些插件會(huì)在許多階段里發(fā)揮重要作用,。
階段 |
插件 |
作用 |
clean
|
clean |
清理自動(dòng)生成的文件,,也就是 target 目錄
|
validate
|
由 Maven 核心負(fù)責(zé) |
驗(yàn)證 Maven 描述文件是否有效
|
compile
|
compiler、resources |
編譯 Java 源碼
|
test
|
compiler,、surefire,、resources |
運(yùn)行測(cè)試代碼
|
package
|
war |
項(xiàng)目打包,就是生成構(gòu)件包,,也就是打 war 包
|
verify
|
由 Maven 核心負(fù)責(zé)
|
驗(yàn)證構(gòu)件包是否有效
|
install
|
install |
將構(gòu)件包安裝到本地倉庫
|
site
|
site |
生成項(xiàng)目站點(diǎn),,就是一堆靜態(tài)網(wǎng)頁文件,包括 JavaDoc
|
deploy
|
deploy |
將構(gòu)件包部署到遠(yuǎn)程倉庫
|
以上表格中所出現(xiàn)的插件名稱實(shí)際上是插件的別名(或稱為前綴),,比如:compiler 實(shí)際上是 org.apache.maven.plugins:maven-compiler-plugin:2.3.2,,這個(gè)才是 Maven 插件的完全名稱。
每個(gè)插件又包括了一些列的 Goal(目標(biāo)),,以 compiler 插件為例,,它包括以下目標(biāo):
-
compiler:help:用于顯示 compiler 插件的使用幫助。
-
compiler:compile:用于編譯 main 目錄下的 Java 代碼,。
-
compiler:testCompile:用于編譯 test 目錄下的 Java 代碼,。
可見,插件目標(biāo)才是具體干活的人,,一個(gè)插件包括了一個(gè)多個(gè)目標(biāo),,一個(gè)階段可由零個(gè)或多個(gè)插件來提供支持,。
我們可以在 pom.xml 中定義一些列的項(xiàng)目依賴(構(gòu)件包),每個(gè)構(gòu)件包都會(huì)有一個(gè) Scope(作用域),,它表示該構(gòu)件包在什么時(shí)候起作用,,包括以下五種:
-
compile:默認(rèn)作用域,在編譯,、測(cè)試,、運(yùn)行時(shí)有效
-
test:對(duì)于測(cè)試時(shí)有效
-
runtime:對(duì)于測(cè)試、運(yùn)行時(shí)有效
-
provided:對(duì)于編譯,、測(cè)試時(shí)有效,,但在運(yùn)行時(shí)無效
-
system:與 provided 類似,但依賴于系統(tǒng)資源
可用一張矩陣表格來表示:
作用域 |
編譯時(shí)有效 |
測(cè)試時(shí)有效 |
運(yùn)行時(shí)有效 |
示例 |
compile |
√
|
√
|
√
|
smart-framework.jar |
test |
|
√
|
|
junit.jar
|
runtime |
|
√
|
√
|
mysql-connector-java.jar
|
provided |
√
|
√
|
|
servlet-api.jar
|
system |
√
|
√
|
|
JDK 的 rt.jar
|
如果您想開發(fā)一個(gè) Smart 應(yīng)用,,可參考如下 p om.xml:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | < project xmlns = "http://maven./POM/4.0.0"
xmlns:xsi = "http://www./2001/XMLSchema-instance"
xsi:schemaLocation="http://maven./POM/4.0.0
http://maven./xsd/maven-4.0.0.xsd">
< modelVersion >4.0.0</ modelVersion >
< properties >
< project.build.sourceEncoding >UTF-8</ project.build.sourceEncoding >
< smart.version >1.0</ smart.version >
</ properties >
< groupId >com.smart</ groupId >
< artifactId >smart-demo</ artifactId >
< version >1.0</ version >
< packaging >war</ packaging >
< dependencies >
<!-- JUnit -->
< dependency >
< groupId >junit</ groupId >
< artifactId >junit</ artifactId >
< version >4.11</ version >
< scope >test</ scope >
</ dependency >
<!-- MySQL -->
< dependency >
< groupId >mysql</ groupId >
< artifactId >mysql-connector-java</ artifactId >
< version >5.1.25</ version >
< scope >runtime</ scope >
</ dependency >
<!-- Servlet -->
< dependency >
< groupId >javax.servlet</ groupId >
< artifactId >javax.servlet-api</ artifactId >
< version >3.0.1</ version >
< scope >provided</ scope >
</ dependency >
<!-- JSTL -->
< dependency >
< groupId >javax.servlet</ groupId >
< artifactId >jstl</ artifactId >
< version >1.2</ version >
< scope >runtime</ scope >
</ dependency >
<!-- Smart -->
< dependency >
< groupId >com.smart</ groupId >
< artifactId >smart-framework</ artifactId >
< version >${smart.version}</ version >
</ dependency >
</ dependencies >
< build >
< plugins >
<!-- Compile -->
< plugin >
< groupId >org.apache.maven.plugins</ groupId >
< artifactId >maven-compiler-plugin</ artifactId >
< version >2.5.1</ version >
< configuration >
< source >1.6</ source >
< target >1.6</ target >
</ configuration >
</ plugin >
<!-- Test -->
< plugin >
< groupId >org.apache.maven.plugins</ groupId >
< artifactId >maven-surefire-plugin</ artifactId >
< version >2.15</ version >
< configuration >
< skipTests >true</ skipTests >
</ configuration >
</ plugin >
<!-- War -->
< plugin >
< groupId >org.apache.maven.plugins</ groupId >
< artifactId >maven-war-plugin</ artifactId >
< version >2.4</ version >
< configuration >
< warName >${project.artifactId}</ warName >
</ configuration >
</ plugin >
<!-- Tomcat -->
< plugin >
< groupId >org.apache.tomcat.maven</ groupId >
< artifactId >tomcat7-maven-plugin</ artifactId >
< version >2.2</ version >
</ plugin >
</ plugins >
</ build >
</ project >
|
以上 pom.xml 大致解釋一下:
-
我們可使用 properties 來定義一些配置屬性,,例如:project.build.sourceEncoding(項(xiàng)目構(gòu)建源碼編碼方式),可設(shè)置為 UTF-8,,可防止中文亂碼,。也可定義相關(guān)構(gòu)件包版本號(hào),例如:smart.version,,便于日后統(tǒng)一升級(jí),。
-
建議使用最新版本的 JUnit,通過 Archetype 自動(dòng)生成的 JUnit 太老了(3.8.1),,可改為最新版(4.11),。
-
因?yàn)闆]必要使用 MySQL 客戶端的 API,它僅僅在運(yùn)行時(shí)有效,,所以我們將 MySQL 構(gòu)件包的作用域設(shè)置為 runtime,。
-
因?yàn)槲覀冎幌朐诖a中使用 Servlet API,而不想將它所對(duì)應(yīng)的 jar 包放入 WEB-INF 的 lib 目錄下,,所以我們可設(shè)置 Servlet 構(gòu)件包的作用域?yàn)?nbsp;provided,。
-
為了保證在 JDK 1.6 運(yùn)行,我們可配置 maven-compiler-plugin 插件,,設(shè)置輸入源碼為 1.6,,編譯輸出的字節(jié)碼也為 1.6。
-
如果想跳過測(cè)試,,可配置 maven-surefire-plugin 插件,,將 skipTests 設(shè)置為 true。
-
如果想配置生成的 war 包為 artifactId,,可修改 maven-war-plugin 插件,,將 warName 修改為 ${project.artifactId},這樣就無需再配置 finalName 了,。
-
如果想通過 Maven 將應(yīng)用部署到 Tomcat 中,,可使用 tomcat7-maven-plugin 插件,,可使用 mvn tomcat7:run-war 命令來運(yùn)行 war 包。
5. 使用 Maven 命令
前面我們已經(jīng)使用了幾個(gè) Maven 命令,,例如:mvn archetype:generate,,mvn tomcat7:run-war 等。其實(shí),,可使用兩種不同的方式來執(zhí)行 Maven 命令:
方式一:mvn <插件>:<目標(biāo)> [參數(shù)]
方式二:mvn <階段>
現(xiàn)在我們接觸到的都是第一種方式,,而第二種方式才是我們?nèi)粘V惺褂米铑l繁的,例如:
-
mvn clean:清空輸出目錄(即 target 目錄)
-
mvn compile:編譯源代碼
-
mvn package:生成構(gòu)件包(一般為 jar 包或 war 包)
-
mvn install:將構(gòu)件包安裝到本地倉庫
-
mvn deploy:將構(gòu)件包部署到遠(yuǎn)程倉庫
6. 后記
Maven 使 Java 開發(fā)更加規(guī)范化與自動(dòng)化,,其實(shí) Maven 那點(diǎn)事遠(yuǎn)遠(yuǎn)不止這些,,如果您掌握了以上這些基礎(chǔ)知識(shí),再去學(xué)習(xí) Maven 的高級(jí)特性,,我想一定會(huì)是一件非常輕松的事情,。
來自:http://my.oschina.net/huangyong/blog/194583
|