mavn工程為什麼要分模塊？

2021-04-06 22:39:52 佚名

所有用Maven管理的真實的項目都應該是分模塊的，每個模塊都對應著一個pom.xml。它們之間通過繼承和聚合（也稱作多模塊，multi- module）相互關聯。那麼，為什麼要這麼做呢？我們明明在開發一個項目，劃分模塊後，導入Eclipse變成了N個項目，這會帶來複雜度，給開發帶來不便。

為了解釋原因，假設有這樣一個項目，很常見的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：

Xml代碼

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
4.0.0
org.myorg.myapp
app-parent
pom
1.0-SNAPSHOT
app-util
app-dao
app-service
app-web

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。

這就是一個父模塊大概需要的配置，接下來看一下子模塊符合配置繼承父模塊。、

Xml代碼

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
app-parent
org.myorg.myapp

1.0-SNAPSHOT
4.0.0
app-util
commons-lang
commons-lang
2.4

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：

Xml代碼

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
app-parent
org.myorg.myapp
1.0-SNAPSHOT
4.0.0
app-dao
org.myorg.myapp
app-util
${project.version}

該配置和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：

Xml代碼

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
app-parent
org.myorg.myapp
1.0-SNAPSHOT
4.0.0
app-web
war
org.myorg.myapp
app-service
${project.version}

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]