分類  >  互聯網 >

Maven入門-概念與範例

tags:    時間:2013-12-27 21:48:38
Maven入門--概念與實例(轉載)

最近由於工作原因在研究、應用Maven,有了一些體會就寫成了此文。本文雖然是Maven2的入門文章,但並不涉 及 Maven的歷史、下載與安裝,這些內容可以到Maven的官方網站上了解。本文主要是關注Maven中的重要概念,並以一個實例來闡述使用Maven的 基本方法。文末有例子代碼下載的鏈接。  


1 關鍵名詞
    Project :任何您想build的事物,Maven都可以認為它們是工程。這些工程被定義為工程對象模型(POM,Poject Object Model)。一個工程可以依賴其它的工程;一個工程也可以由多個子工程構成。
    POM :POM(pom.xml)是Maven的核心文件,它是指示Maven如何工作的元數據文件,類似於Ant中的build.xml文件。POM文件位於每個工程的根目錄中。
    GroupId :groupId是一個工程的在全局中唯一的標識符,一般地,它就是工程名。groupId有利於使用一個完全的包名,將一個工程從其它有類似名稱的工程里區別出來。
    Artifact :artifact 是工程將要產生或需要使用的文件,它可以是jar文件,源文件,二進位文件,war文件,甚至是pom文件。每個artifact都由groupId和 artifactId組合的標識符唯一識別。需要被使用(依賴)的artifact都要放在倉庫(見Repository)中,否則Maven無法找到 (識別)它們。
    Dependency :為了能夠build或運行,一個典型的Java工程會依賴其它的包。在Maven中,這些被依賴的包就被稱為dependency。dependency一般是其它工程的artifact。
    Plug-in :Maven是由插件組織的,它的每一個功能都是由插件提供的。插件提供goal(類似於Ant中的target),並根據在POM中找到的元數據去完成工作。主要的Maven插件要是由Java寫成的,但它也支持用Beanshell或Ant腳本寫成的插件。
    Repository :倉庫用於存放artifact,它可以是本地倉庫,也可以是遠程倉庫。Maven有一個默認的遠程倉庫--central,可以從http://www.ibiblio.org/maven/ 下載其中的artifact。在Windows平台上,本地倉庫的默認地址是User_Home \.m2\repository
    Snapshot :工程中可以(也應該)有一個特殊版本,它的版本號包括SNAPSHOT 字樣。該版本可以告訴Maven,該工程正處於開發階段,會經常更新(但還未發布)。當其它工程使用此類型版本的artifact時,Maven會在倉庫中尋找該artifact的最新版本,並自動下載、使用該最新版。
2 Maven Build Life Cycle
    軟體項目一般都有相似的開發過程:準備,編譯,測試,打包和部署,Maven將上述過程稱為Build Life Cycle。在Maven中,這些生命周期由一系列的短語組成,每個短語對應著一個(或多個)操作;或對應著一個(或多個)goal(類似於Ant中的 target)。
    如編譯源文件的命令mvn compile 中的compile是一個生命周期短語。同時該命令也可以等價於mvn compiler:compile ,其中的compiler是一個插件,它提供了compile(此compile與mvn compile中的compile意義不同 )goal;compiler還可提供另一個goal--testCompile,該goal用於編譯junit測試類。
    在執行某一個生命周期時,Maven會首先執行該生命周期之前的其它周期。如要執行compile,那麼將首先執行validate,generate- source,process-source和generate-resources,最後再執行compile本身。關於Maven中默認的生命周期短語,請見參考資源[6]中的附錄B.3
3 標準目錄布局
    Maven為工程中的源文件,資源文件,配置文件,生成的輸出和文檔都制定了一個標準的目錄結構。Maven鼓勵使用標準目錄布局,這樣就不需要進行額外 的配置,而且有助於各個不同工程之間的聯接。當然,Maven也允許定製個性的目錄布局,這就需要進行更多的配置。關於Maven的標準目錄布局,請見參考資源[6]中的附錄B.1
4 Maven的優點
    [1]build邏輯可以被重用。在Ant中可能需要多次重複地寫相同的語句,但由於POM的繼承性,可以復用其它的POM文件中的語句。這樣既可以寫出清晰的build語句,又可以構造出層次關係良好的build工程。
    [2]不必關注build工作的實現細節。我們只需要使用一些build生命周期短語就可以達到我們的目標,而不必管Maven是如何做到這些的。如,只需要告訴Maven要安裝(install),那麼它自然就會驗證,編譯,打包,及安裝。
    [3]Maven會遞歸載入工程依賴的artifact所依賴的其它artifact,而不用顯示的將這些artifact全部寫到dependency中。
    [4]如果完全使用Maven的標準目錄布局,那麼可以極大地減少配置細節。
5 實例
5.1 構想
    由於只是闡述Maven的基本使用方法,所以本文將要設計的實例,只是一個簡單的Maven demo。該實例包含兩個工程:普通應用程序工程(app)和Web應用工程(webapp)。app工程提供一個簡單的Java類;webapp工程只 包含一個Servlet,並將使用app中的Java類。
    該Demo的目標是能夠正確地將webapp製成war包,以供部署時使用。要能夠正確製作war,自然首先就必須要能夠正確的編譯源代碼,且要將App模塊製成jar包。本文創建的工程所在的目錄是
D:\maven\demo
5.2 App工程
    可以使用Maven的archetype插件來創建新工程,命令如下:
   
D:\maven\demo>mvn archetype:create -DgroupId=ce.demo.mvn -DartifactId=app
該工程的groupId是ce.demo.mvn,那麼該工程的源文件將放在Java包ce.demo.mvn中。artifactId是app,那麼該工程根目錄的名稱將為app。
    當第一次執行該命令時,Maven會從central倉庫中下載一些文件。這些文件包含插件archetype,以及它所依賴的其它包。該命令執行完畢后,在目錄D:\maven\demo下會出現如下目錄布局:

app
|-- pom.xml
`-- src
    |-- main
    |   `-- java
    |       `-- ce
    |           `-- demo
    |               `-- mvn
    |                   `-- App.java
    `-- test
        `-- java
            `-- ce
                `-- demo
                    `-- mvn
                        `-- AppTest.java


因本文暫時不涉及JUnit測試,故請將目錄app\src\test 目錄刪除。然後再修改App.java文件,其完全內容如下:

package  ce.demo.mvn;
public   class  App  {
    
public  String getStr(String str)  {
        
return  str;
    }

}



其實,如果我們能夠清楚地知道Maven的標準目錄布局,就可以不使用archetype插件來創建工程原型;如果我們要定製個性的目錄布局,那麼就更沒有必要使用archetype插件了。
5.3 WebApp工程
    我們仍然如創建app工程一樣使用archetype插件來創建webapp工程,命令如下:
    D:\maven\demo>mvn archetype:create -DgroupId=ce.demo.mvn -DartifactId=webapp -DarchetypeArtifactId=maven-archetype-webapp
    第一次運行此命令時,也會從central倉庫中下載一些與Web應用相關的artifact(如javax.servlet)。此命令與創建app的命 令的不同之處是,多設置了一個屬性archetypeArtifacttId,該屬性的值為maven-archetype-webapp。即告訴 Maven,將要創建的工程是一個Web應用工程。創建app工程時沒有使用該屬性值,是由於archetype默認創建的是應用程序工程。同樣的,執行 完該命令之後,會出現如下標準目錄布局:

webapp
|-- pom.xml
`-- src
    `-- main
        `-- webapp
           
| -- index.jsp
            |-- WEB-INF
                `-- web.xml


    根據5.1節的構想,webapp工程將只包含一個Servlet,所以我們不需要index.jsp文件,請將其刪除。此時大家可以發現,目前的目錄布 局中並沒有放Servlet,即Java源文件的地方。根據參考資源[6]中的附錄B.1,以及app工程中Java源文件的布局,可以知道 Servlet(它仍然是一個Java類文件)仍然是放在webapp\src\main\java 目錄中,請新建該目錄。此處的Servlet是一個簡單HelloServlet,其完整代碼如下:

package  hello;

import  java.io.IOException;
import  java.io.PrintWriter;
import  javax.servlet.ServletException;
import  javax.servlet.http.HttpServlet;
import  javax.servlet.http.HttpServletRequest;
import  javax.servlet.http.HttpServletResponse;

import  ce.demo.mvn.App;   //  引用app工程中的App類

public   class  HelloServlet  extends  HttpServlet  {
    
private   static   final   long  serialVersionUID  =   - 3696470690560528247L ;
    
public   void  doGet(HttpServletRequest request, HttpServletResponse response)
            
throws  ServletException, IOException  {
        App app 
=   new  App();
        String str 
=  app.getStr( " CE Maven Demo " );
        PrintWriter out 
=  response.getWriter();
        out.print(
" <html><body> " );
        out.print(
" <h1> "   +  str);
        out.print(
" </body></html> " );
    }

}


5.4 POM文件
    大家可以發現,在前面新建工程時,我們並沒有提到各個工程中的pom.xml文件。現在將要討論這個問題。我們先看看app工程中的POM文件,其完整內容如下:

< project >
  
< modelVersion > 4.0.0 </ modelVersion >
  
< groupId > ce.demo.mvn </ groupId >
  
< artifactId > app </ artifactId >
  
< packaging > jar </ packaging >
  
< version > 1.0 </ version >
  
< name > CE Maven Demo -- App </ name >
</ project >


    大家可以發現此我帖出來的內容與實際由archetype插件生成的POM文件的內容有些不同,但基本上是一致的。只是為了使文件中的語句更清晰,此處刪 除了一些冗餘的內容,並修改了該工程的version和name的值,以與此例子的背景來符合。在目前情況下modelVersion值將被固定為 4.0.0,這也是Maven2唯一能夠識別的model版本。groupId,artifactId的值與創建工程時使用的命令中的相關屬性值是一致 的。packaging的值由工程的類型決定,如應用程序工程的packaging值為jar,Web應用工程的packaging值為war。上述情況 也可以從webapp的POM文件中看出,下面將看看這個pom的完整內容。

< project >
  
< modelVersion > 4.0.0 </ modelVersion >
  
< groupId > ce.demo.mvn </ groupId >
  
< artifactId > webapp </ artifactId >
  
< packaging > war </ packaging >
  
< version > 1.0 </ version >
  
< name > CE Maven Demo -- WebApp </ name >
  
  
< dependencies >
      
< dependency >
          
< groupId > ce.demo.mvn </ groupId >
          
< artifactId > app </ artifactId >
          
< version > 1.0 </ version >
      
</ dependency >
    
< dependency >
        
< groupId > javax.servlet </ groupId >
        
< artifactId > servlet-api </ artifactId >
        
< version > 2.4 </ version >
        
< scope > provided </ scope >
    
</ dependency >  
  
</ dependencies >
</ project >


    比較app與webapp中的POM,除前面已經提過的packaging的差別外,我們還可以發現webapp中的POM多了dependencies 項。由於webapp需要用到app工程中的類(見HelloServlet源代碼),它還需要javax.servlet包(因為該包並不默認存在於 jsdk中)。故,我們必須要將它們聲明到依賴關係中。
5.5 執行
    上述兩個工程創建完畢后,就需要執行一些命令來看看會有什麼結果出現。我們首先進入app目錄,並執行命令mvn compile ,然後會在該目錄下發現新生成的目錄target\classes,即編譯后的class文件(包括它的包目錄)就放在了這裡。再執行命令mvn package,在目錄target中就會生成app-1.0.jar文件。該文件的全名由如下形式確定:artifactId-version.packaging 。根據第2章的敘述可以知道,執行命令mvn package 時,將首先將產生執行命令mvn compile 之後的結果,故如果要打包,那麼只需要執行mvn package 即可。
    在app工程中執行完之後,就需要進入webapp工程了。進入webapp目錄,此次將只執行mvn package 命令(隱示地跳過了compile過程)。此次命令的執行並不成功,會出現如下問題:

D:\maven\demo\webapp>mvn package
……
Downloading: http://repo1.maven.org/maven2/ce/demo/mvn/app/
1.0 /app- 1.0 .pom
[ INFO ]  ------------------------------------
[ ERROR ]  BUILD ERROR
[ INFO ]  ------------------------------------
[ INFO ]  Error building POM (may not be this project's POM).
Project ID: ce.demo.mvn:app
Reason: Error getting POM for 'ce.demo.mvn:app' from the repository: Error transferring file
  ce.demo.mvn:app:pom:
1.0
from the specified remote repositories:
  central (http://repo1.maven.org/maven2)
……


    由加粗的內容可知,Maven正試圖從central倉庫下載app工程的artifact,但central倉庫肯定不會有這個artifact,其結 果只能是執行失敗!由第1章artifact名詞的解釋可知,被依賴的artifact必須存在於倉庫(遠程或本地)中,但目前webapp所依賴的 app必不存在於倉庫中,所以執行只能失敗。
    解決這個問題有兩種方法:[1]將app-1.0.jar安裝到倉庫中,使它成為一個artifact;[2]構建一個更高層次的工程,使app和webapp成為這個工程的子工程,然後從這個更高層次工程中執行命令。
    第一種方法比較簡單( http://www.blogjava.net/jiangshachina/admin/EditPosts.aspx中的第一個主題 ),此處將詳細討論第2種方法(見5.6節)。
5.6 更高層次工程
    我們可以將app和webapp的上一級目錄demo作為這兩個工程的更高層次一個工程。為了使demo目錄成為一個demo工程,只需要在這個目錄下添加一個pom.xml文件,該文件內容如下:

< project >
    
< modelVersion > 4.0.0 </ modelVersion >
    
< groupId > ce.demo </ groupId >
    
< artifactId > mvn-demo </ artifactId >
    
< packaging > pom </ packaging >
    
< version > 1.0 </ version >
    
< name > CE Maven Demo </ name >
    
    
< modules >
        
< module > app </ module >
        
< module > webapp </ module >
    
</ modules >
</ project >


    與app和webapp中的POM相比,demo的POM使用了modules項,modules用於聲明本工程的子工程,module中的值對應於子工程的artifact名。而且該POM的packaging類型為pom。
    有了demo工程后,我們只需要在demo目錄下執行相關命令就可以了。通過如下命令即可驗證:
    [1]mvn clean – 消除工程(包括所有子工程)中產生的所有輸出。這本文的實例中,實際上是刪除target目錄。由於之前的操作只有app工程產生了target目錄,而webapp並沒有,所以將只會刪除app工程中的target目錄。
    [2]mvn package – 將工程製作成相應的包,app工程是作成jar包(app-1.0.jar),webapp工程是作成war包(webapp-1.0.war)。打開webapp-1.0.war包,可以發現app-1.0.jar被放到了WEB-INF的lib目錄中。
6 小結
    通過以上的敘述與實例,應該可以對Maven有一個粗略的認識了。使用Maven關鍵是要弄清楚如何寫pom.xml文件,就如同使用Ant要會寫 build.xml文件一樣。在POM中可以寫入Ant的task腳本,也可以直接調用Ant的build.xml文件(推薦),所以Maven也可以完 成Ant的絕大多數工作(但不必安裝Ant)。
    利用好Maven的繼承特性及子工程的關係,可以很好地簡化POM文件,並構建層次結構良好的工程,有利於工程的維護。
7 參考資源
[1]Maven官方網站. http://maven.apache.org
[2]Maven POM文件參考結構. http://maven.apache.org/ref/current/maven-model/maven.html
[3]Super POM. http://maven.apache.org/guides/introduction/introduction-to-the-pom.html
[4]Maven主要插件的列表. http://maven.apache.org/plugins
[5]Maven基本使用指南. http://maven.apache.org/guides/index.html
[6]Better Build with Maven. http://www.mergere.com/m2book_download.jsp -- 強烈推薦
[7]介紹Maven2. http://www.javaworld.com/javaworld/jw-12-2005 /jw-1205-maven_p.html
[8]揭秘Maven2 POM. http://www.javaworld.com/javaworld/jw-05-2006/jw-0529-maven.html
[9]Maven讓事情變得簡單. http://www-128.ibm.com/developerworks/cn/java/j-maven
[10]Maven文檔集. http://docs.codehaus.org/display/MAVENUSER/Home
[11]有效利用Maven2的站點生成功能. http://www.matrix.org.cn/resource/article/44/44491_Maven2.html
文中例子程序下載:http://www.blogjava.net/files/jiangshachina/maven.rar

推薦閱讀文章

Bookmark the permalink ,來源:互聯網