使用多模塊的Maven配置,可以幫助項目劃分模塊,鼓勵重用,防止POM變得過于龐大,方便某個模塊的構建,而不用每次都構建整個項目,并且使得針對某個模塊的特殊控制更為方便
假設有這樣一個項目,很常見的Java Web應用。在這個應用中,我們分了幾層:
Dao層負責數據庫交互,封裝了Hibernate交互的類。
Service層處理業務邏輯,放一些Service接口和實現相關的Bean。
Web層負責與客戶端交互,主要有一些Structs的Action類。
對應的,在一個項目中,我們會看到一些包名:
org.myorg.app.dao org.myorg.app.service org.myorg.app.web org.myorg.app.util
這樣整個項目的框架就清晰了,但隨著項目的進行,你可能會遇到如下問題:
這個應用可能需要有一個前臺和一個后臺管理端(web或者swing),你發現大部分dao,一些service,和大部分util是在兩個應用中都可用。這樣的問題,你一周內遇到了好幾次。
pom.xml中的依賴列表越來越長以重用的,但是,由于目前只有一個項目(WAR),你不得不新建一個項目依賴這個WAR,這變得非常的惡心,因為在Maven中配置對WAR的依賴遠不如依賴JAR那樣簡單明了,而且你根本不需要org.myorg.app.web。有人修改了dao,提交到svn并且不小心導致build失敗了,你在編寫service的代碼,發現編譯不過,只能等那人把dao修復了,你才能繼續進行,很多人都在修改,到后來你根本就不清楚哪個依賴是誰需要的,漸漸的,很多不必要的依賴被引入。甚至出現了一個依賴有多個版本存在。
build整個項目的時間越來越長,盡管你只是一直在web層工作,但你不得不build整個項目。
某個模塊,比如util,你只想讓一些經驗豐富的人來維護,可是,現在這種情況,每個開發者都能修改,這導致關鍵模塊的代碼質量不能達到你的要求。
我們會發現,其實這里實際上沒有遵守一個設計模式原則:“高內聚,低耦合”。雖然我們通過包名劃分了層次,并且你還會說,這些包的依賴都是單向的,沒有包的環依賴。這很好,但還不夠,因為就構建層次來說,所有東西都被耦合在一起了。因此我們需要使用Maven劃分模塊。
一個簡單的Maven模塊結構是這樣的:
---- app-parent |-- pom.xml (pom) | |-- app-util | |-- pom.xml (jar) | |-- app-dao | |-- pom.xml (jar) | |-- app-service | |-- pom.xml (jar) | |-- app-web |-- pom.xml (war)
上述簡單示意圖中,有一個父項目(app-parent)聚合很多子項目(app-util, app-dao, app-service, app-web)。每個項目,不管是父子,都含有一個pom.xml文件。而且要注意的是,小括號中標出了每個項目的打包類型。父項目是pom,也只能是pom。子項目有jar,或者war。根據它包含的內容具體考慮。
這些模塊的依賴關系如下:
app-dao --> app-util
app-service --> app-dao
app-web --> app-service
注意依賴的傳遞性(大部分情況是傳遞的,除非你配置了特殊的依賴scope),app-dao依賴于app-util,app-service依賴于app-dao,于是app-service也依賴于app-util。同理,app-web依賴于app-dao,app-util。
用項目層次的劃分替代包層次的劃分能給我們帶來如下好處:
方便重用,如果你有一個新的swing項目需要用到app-dao和app-service,添加對它們的依賴即可,你不再需要去依賴一個WAR。而有些模塊,如app-util,完全可以漸漸進化成公司的一份基礎工具類庫,供所有項目使用。這是模塊化最重要的一個目的。
由于你現在劃分了模塊,每個模塊的配置都在各自的pom.xml里,不用再到一個混亂的紛繁復雜的總的POM中尋找自己的配置。
如果你只是在app-dao上工作,你不再需要build整個項目,只要在app-dao目錄運行mvn命令進行build即可,這樣可以節省時間,尤其是當項目越來越復雜,build越來越耗時后。
某些模塊,如app-util被所有人依賴,但你不想給所有人修改,現在你完全可以從這個項目結構出來,做成另外一個項目,svn只給特定的人訪問,但仍提供jar給別人使用。
多模塊的Maven項目結構支持一些Maven的更有趣的特性(如DepencencyManagement),這留作以后討論。
接下來討論一下POM配置細節,實際上非常簡單,先看app-parent的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>org.myorg.myapp</groupId> <artifactId>app-parent</artifactId> <packaging>pom</packaging> <version>1.0-SNAPSHOT</version> <modules> <module>app-util</module> <module>app-dao</module> <module>app-service</module> <module>app-web</module> </modules> </project>
Maven的坐標GAV(groupId, artifactId, version)在這里進行配置,這些都是必須的。特殊的地方在于,這里的packaging為pom。所有帶有子模塊的項目的packaging都為pom。packaging如果不進行配置,它的默認值是jar,代表Maven會將項目打成一個jar包。
該配置重要的地方在于modules,例子中包含的子模塊有app-util, app-dao, app-service, app-war。在Maven build app-parent的時候,它會根據子模塊的相互依賴關系整理一個build順序,然后依次build。
這就是一個父模塊大概需要的配置,接下來看一下子模塊符合配置繼承父模塊。
app-util模塊:
<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"> <parent> <artifactId>app-parent</artifactId> <groupId>org.myorg.myapp</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>app-util</artifactId> <dependencies> <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> <version>2.4</version> </dependency> </dependencies> </project>
app-util模塊繼承了app-parent父模塊,因此這個POM的一開始就聲明了對app-parent的引用,該引用是通過Maven坐標GAV實現的。而關于項目app-util本身,它卻沒有聲明完整GAV,這里我們只看到了artifactId。這個POM并沒有錯,groupId和version默認從父模塊繼承了。實際上子模塊從父模塊繼承一切東西,包括依賴,插件配置等等。
此外app-util配置了一個對于commons-lang的簡單依賴,這是最簡單的依賴配置形式。大部分情況,也是通過GAV引用的。
再看一下app-dao,它也是繼承于app-parent,同時依賴于app-util:
<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"> <parent> <artifactId>app-parent</artifactId> <groupId>org.myorg.myapp</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>app-dao</artifactId> <dependencies> <dependency> <groupId>org.myorg.myapp</groupId> <artifactId>app-util</artifactId> <version>${project.version}</version> </dependency> </dependencies> </project>
該配置和app-util的配置幾乎沒什么差別,不同的地方在于,依賴變化了,app-dao依賴于app-util。這里要注意的是version的值為${project.version},這個值是一個屬性引用,指向了POM的project/version的值,也就是這個POM對應的version。由于app-dao的version繼承于app-parent,因此它的值就是1.0-SNAPSHOT。而app-util也繼承了這個值,因此在所有這些項目中,我們做到了保持版本一致。
這里還需要注意的是,app-dao依賴于app-util,而app-util又依賴于commons-lang,根據傳遞性,app-dao也擁有了對于commons-lang的依賴。
app-service我們跳過不談,它依賴于app-dao。我們最后看一下app-web:
<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"> <parent> <artifactId>app-parent</artifactId> <groupId>org.myorg.myapp</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>app-web</artifactId> <packaging>war</packaging> <dependencies> <dependency> <groupId>org.myorg.myapp</groupId> <artifactId>app-service</artifactId> <version>${project.version}</version> </dependency> </dependencies> </project>
app-web依賴于app-service,因此配置了對其的依賴。
由于app-web是我們最終要部署的應用,因此它的packaging是war。為此,你需要有一個目錄src/main/webapp。并在這個目錄下擁有web應用需要的文件,如/WEB-INF/web.xml。沒有web.xml,Maven會報告build失敗,此外你可能還會有這樣一些子目錄:/js, /img, /css ... 。
看看Maven是如何build整個項目的,我們在 app-parent 根目錄中運行 mvn clean install ,輸出的末尾會有大致這樣的內容:
...
...
[INFO] [war:war]
[INFO] Packaging webapp
[INFO] Assembling webapp[app-web] in [/home/juven/workspaces/ws-others/myapp/app-web/target/app-web-1.0-SNAPSHOT]
[INFO] Processing war project
[INFO] Webapp assembled in[50 msecs]
[INFO] Building war: /home/juven/workspaces/ws-others/myapp/app-web/target/app-web-1.0-SNAPSHOT.war
[INFO] [install:install]
[INFO] Installing /home/juven/workspaces/ws-others/myapp/app-web/target/app-web-1.0-SNAPSHOT.war to /home/juven/.m2/repository/org/myorg/myapp/app-web/1.0-SNAPSHOT/app-web-1.0-SNAPSHOT.war
[INFO]
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] ------------------------------------------------------------------------
[INFO] app-parent ............................................ SUCCESS [1.191s]
[INFO] app-util .............................................. SUCCESS [1.274s]
[INFO] app-dao ............................................... SUCCESS [0.583s]
[INFO] app-service ........................................... SUCCESS [0.593s]
[INFO] app-web ............................................... SUCCESS [0.976s]
[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4 seconds
[INFO] Finished at: Sat Dec 27 08:20:18 PST 2008
[INFO] Final Memory: 3M/17M
[INFO] ------------------------------------------------------------------------
注意Reactor Summary,整個項目根據我們希望的順序進行build。Maven根據我們的依賴配置,智能的安排了順序,app-util, app-dao, app-service, app-web。
最后,你可以在 app-web/target 目錄下找到文件 app-web-1.0-SNAPSHOT.war ,打開這個war包,在 /WEB-INF/lib 目錄看到了 commons-lang-2.4.jar,以及對應的app-util, app-dao, app-service 的jar包。Maven自動幫你處理了打包的事情,并且根據你的依賴配置幫你引入了相應的jar文件。
使用多模塊的Maven配置,可以幫助項目劃分模塊,鼓勵重用,防止POM變得過于龐大,方便某個模塊的構建,而不用每次都構建整個項目,并且使得針對某個模塊的特殊控制更為方便