1. 程式人生 > >Maven最佳實踐 劃分模組 配置多模組專案 pom modules

Maven最佳實踐 劃分模組 配置多模組專案 pom modules

原文地址:http://juvenshun.iteye.com/blog/305865

                  http://blog.csdn.net/woxueliuyun/article/details/9170369

“分天下為三十六郡,郡置守,尉,監” —— 《史記·秦始皇本紀》

所有用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

這樣整個專案的框架就清晰了,但隨著專案的進行,你可能會遇到如下問題:

  1. 這個應用可能需要有一個前臺和一個後臺管理端(web或者swing),你發現大部分dao,一些service,和大部分util是在兩個應用中可。這樣的問題,你一週內遇到了好幾次。
  2. pom.xml中的依賴列表越來越長以重用的,但是,由於目前只有一個專案(WAR),你不得不新建一個專案依賴這個WAR,這變得非常的噁心,因為在Maven中配置對WAR的依賴遠不如依賴JAR那樣簡單明瞭,而且你根本不需要org.myorg.app.web。有人修改了dao,提交到svn並且不小心導致build失敗了,你在編寫service的程式碼,發現編譯不過,只能等那人把dao修復了,你才能繼續進行,很多人都在修改,到後來你根本就不清楚哪個依賴是誰需要的,漸漸的,很多不必要的依賴被引入。甚至出現了一個依賴有多個版本存在。
  3. build整個專案的時間越來越長,儘管你只是一直在web層工作,但你不得不build整個專案。
  4. 某個模組,比如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。

用專案層次的劃分替代包層次的劃分能給我們帶來如下好處:

  1. 方便重用,如果你有一個新的swing專案需要用到app-dao和app-service,新增對它們的依賴即可,你不再需要去依賴一個WAR。而有些模組,如app-util,完全可以漸漸進化成公司的一份基礎工具類庫,供所有專案使用。這是模組化最重要的一個目的。
  2. 由於你現在劃分了模組,每個模組的配置都在各自的pom.xml裡,不用再到一個混亂的紛繁複雜的總的POM中尋找自己的配置。
  3. 如果你只是在app-dao上工作,你不再需要build整個專案,只要在app-dao目錄執行mvn命令進行build即可,這樣可以節省時間,尤其是當專案越來越複雜,build越來越耗時後。
  4. 某些模組,如app-util被所有人依賴,但你不想給所有人修改,現在你完全可以從這個專案結構出來,做成另外一個專案,svn只給特定的人訪問,但仍提供jar給別人使用。
  5. 多模組的Maven專案結構支援一些Maven的更有趣的特性(如DepencencyManagement),這留作以後討論。

接下來討論一下POM配置細節,實際上非常簡單,先看app-parent的pom.xml:

Xml程式碼  收藏程式碼
  1. <projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3.     <modelVersion>4.0.0</modelVersion>
  4.     <groupId>org.myorg.myapp</groupId>
  5.     <artifactId>app-parent</artifactId>
  6.     <packaging>pom</packaging>
  7.     <version>1.0-SNAPSHOT</version>
  8.     <modules>
  9.         <module>app-util</module>
  10.         <module>app-dao</module>
  11.         <module>app-service</module>
  12.         <module>app-web</module>
  13.     </modules>
  14. </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。

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

Xml程式碼  收藏程式碼
  1. <projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3.     <parent>
  4.         <artifactId>app-parent</artifactId>
  5.         <groupId>org.myorg.myapp</groupId>
  6.         <version>1.0-SNAPSHOT</version>
  7.     </parent>
  8.     <modelVersion>4.0.0</modelVersion>
  9.     <artifactId>app-util</artifactId>
  10.     <dependencies>
  11.         <dependency>
  12.             <groupId>commons-lang</groupId>
  13.             <artifactId>commons-lang</artifactId>
  14.             <version>2.4</version>
  15.         </dependency>
  16.     </dependencies>
  17. </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:

Xml程式碼  收藏程式碼
  1. <projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3.     <parent>
  4.         <artifactId>app-parent</artifactId>
  5.         <groupId>org.myorg.myapp</groupId>
  6.         <version>1.0-SNAPSHOT</version>
  7.     </parent>
  8.     <modelVersion>4.0.0</modelVersion>
  9.     <artifactId>app-dao</artifactId>
  10.     <dependencies>
  11.         <dependency>
  12.             <groupId>org.myorg.myapp</groupId>
  13.             <artifactId>app-util</artifactId>
  14.             <version>${project.version}</version>
  15.         </dependency>
  16.     </dependencies>
  17. </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:

Xml程式碼  收藏程式碼
  1. <projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3.     <parent>
  4.         <artifactId>app-parent</artifactId>
  5.         <groupId>org.myorg.myapp</groupId>
  6.         <version>1.0-SNAPSHOT</version>
  7.     </parent>
  8.     <modelVersion>4.0.0</modelVersion>
  9.     <artifactId>app-web</artifactId>
  10.     <packaging>war</packaging>
  11.     <dependencies>
  12.         <dependency>
  13.             <groupId>org.myorg.myapp</groupId>
  14.             <artifactId>app-service</artifactId>
  15.             <version>${project.version}</version>
  16.         </dependency>
  17.     </dependencies>
  18. </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變得過於龐大,方便某個模組的構建,而不用每次都構建整個專案,並且使得針對某個模組的特殊控制更為方便。本文同時給出了一個實際的配置樣例,展示瞭如何使用Maven配置多模組專案。

------------------------------------------------------------------------------------------------------------------------------------------

Super POM(project object model)

Maven內建了一個預設的POM(不在專案中,因此不可見),每一個project都會繼承自這個預設的POM,因此叫Super POM。除非在專案的配置(POM)中顯式的修改,否則使用預設的配置。不同的Maven版本,預設的POM也不一樣,遇到問題則需要自己檢查。

最小的POM

一個project就是一個artifact,project的全稱為: <groupId>:<artifactId>:<version>。

在Maven1中是project.xml,Maven2改成了pom.xml。在Maven1中還有一個maven.xml用於包含可以執行的目標,在Maven2已經配置到了pom.xml中。

  1. <projectxmlnsprojectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.    <modelVersion>4.0.0</modelVersion>
  4.    <groupId>com.ebay.raptor.samples</groupId>
  5.    <artifactId>SamplesParent</artifactId>
  6.    <version>1.1.0-SNAPSHOT</version>
  7. </project>

artifact可以是任何東西,包括JAR, WAR,POM, EBA檔案等。group只是artifact的名稱空間,有點類似於java的包。如果專案還處在開發階段,在版本後會有一個"SNAPSHOT",Maven只允許snapshot artifact被更新,release版本是不能更新的。

modelVersion很重要,因為不同的model,POM的格式是不一樣的。

以上幾個節點構成了一個最小的POM,這些是POM必須擁有的資訊。

繼承

如果我們需要把一個artifact放到另一個artifact中,就需要設定繼承關係,這個繼承關係是由子的module來維護的,因此會在module的pom中有一個parent節點。

  1. <project>
  2.  <parent>
  3.    <groupId>com.mycompany.app</groupId>
  4.    <artifactId>my-app</artifactId>
  5.    <version>1</version>
  6.   </parent>
  7.  <modelVersion>4.0.0</modelVersion>
  8.  <groupId>com.mycompany.app</groupId>
  9.  <artifactId>my-module</artifactId>
  10.  <version>1</version>
  11. </project>

剛才上面講的是目錄結構是如下的時候:

|-- my-module
|   `-- pom.xml
 `-- pom.xml

如果目錄結構是下面的樣子,

|-- my-module
|   `-- pom.xml
 `-- parent
     `-- pom.xml
則需要在parent中新增relativePath節點:
  1. <project>
  2.  <parent>
  3.    <groupId>com.mycompany.app</groupId>
  4.    <artifactId>my-app</artifactId>
  5.    <version>1</version>
  6.    <relativePath>../parent/pom.xml</relativePath>
  7.  </parent>
  8.  <modelVersion>4.0.0</modelVersion>
  9.  <artifactId>my-module</artifactId>
  10. </project>

整合(aggregation)

和繼承有點類似,但是父子關係是由父的POM來維護的。方法是在POM中新增modules節點:

  1. <project>
  2.  <modelVersion>4.0.0</modelVersion>
  3.  <groupId>com.mycompany.app</groupId>
  4.  <artifactId>my-app</artifactId>
  5.  <version>1</version>
  6.  <packaging>pom</packaging>
  7.  <modules>
  8.    <module>my-module</module>
  9.  </modules>
  10. </project>

節點module其實是目錄名稱,因此如果module不在app中,而是與app平級,則可以寫成這樣:

  1. <modules>
  2.   <module>../my-module</module>
  3. </modules>

專案插值與變數

整個POM相當於一個物件,子節點就是一個個屬性,因此可以直接訪問:

  1. <version>${project.version}</version>

另外,還有幾個特殊的變數:

project.basedir

當前專案所在的目錄

project.baseUri

當前專案所在的目錄,只不過用 URI的格式表示. 從Maven 2.1.0開始

maven.build.timestamp

Build的開始時間.從Maven 2.1.0-M1開始

在project也可以自定義自己的變數,方法是在properties中新增屬性:

  1. <properties>
  2.   <mavenVersion>2.1</mavenVersion>
  3. </properties>
歡迎關注我的微信公眾號-搜尋 “前端琅琊閣“ 即可

相關推薦

Maven最佳實踐 劃分模組 配置模組專案 pom modules

原文地址:http://juvenshun.iteye.com/blog/305865                  http://blog.csdn.net/woxueliuyun/article/details/9170369“分天下為三十六郡,郡置守,尉,監” —— 《史記·秦始皇本紀》所有用Mav

Maven最佳實踐 劃分模組 配置模組專案 pom modules

原文地址:http://juvenshun.iteye.com/blog/305865                  http://blog.csdn.net/woxueliuyun/article/details/9170369“分天下為三十六郡,郡置守,尉,監” ——

Maven和Eclipse整合和構建模組Maven專案

最近在工作中越來越經常的用到了Maven作為專案管理和Jar包管理和構建的工具,感覺Maven的確是很好用的。而且要將Maven的功能最大發揮出來,多模組是一個很好的整合例子。 一個Maven專案包括一個MavenProject和多個MavenModule 下面用一個

Android最佳實踐之性能 - 線程

ndt andro 單位 多線程 same Coding amount other err 在單獨線程執行代碼 參考地址:http://developer.andr

Maven最佳實踐-distributionManagement

mvn install 會將專案生成的構件安裝到本地Maven倉庫,mvn deploy 用來將專案生成的構件分發到遠端Maven倉庫。本地Maven倉庫的構件只能供當前使用者使用,在分發到遠端Maven倉庫之後,所有能訪問該倉庫的使用者都能使用你的構件。 我們需要配置POM的distributionMa

Maven最佳實踐:版本管理 SNAPSHOT

什麼是版本管理 首先,這裡說的版本管理(version management)不是指版本控制(version control),但是本文假設你擁有基本的版本控制的知識,瞭解subversion的基本用法。版本管理中說得版本是指構件(artifact)的版本,而非原始碼的版本(如subversion中常見的

第2.1.2章 WEB系統最佳實踐Spring檔案配置之spring-common.xml

spring-common.xml主要是對spring的通用性配置。 注意spring框架在前,springmvc誕生在後,所以下面的配置需要將Controller排除在外. <context:component-scan base-package

vue-cli配置頁面專案

背景:vue-cli版本3.0   省略初始化專案;預設的App.vue和index.html檔案可以刪掉 頁面結構如上圖,新加的home可以不要,注意下面的檔案路徑就行   接下來修改配置檔案: 1、修改build/utils.js /* 這裡是新

Nginx同一個域名配置專案

使用Nginx要在同一個域名下配置多個專案有兩種方式: nginx按不同的目錄分發給不同的專案 啟用二級域名,不同的專案分配不同的二級域名 1.nginx按不同的目錄分發給不同的專案: server { listen 80; server_nam

Nginx配置專案放在不同的tomcat中,共享同一個埠

一、準備兩個tomcat以及Nginx安裝包 1.1分別命名為tomcat1,tomcat2。 1.2在兩個tomcat的webapps下面分別新建個專案 server1,server2. 二、配置Ngnix的配置檔案 http { include

create-react-app配置入口專案開發

1. 使用create-react-app腳手架搭建react專案 新建專案資料夾,install create-react-app npm install -g create-react-app 進入到專案資料夾中: create-react-app ap

Tomcat 利用server.xml配置專案部署

tomcat的conf目錄下的server.xml配置檔案進行web專案的對映部署,把不在webApp目錄的專案部署執行起來 這樣只需要指定編譯後的目錄和tomcat部署的目錄相同 <Host

Tomcat8.5 配置專案的方法

一、 需要的環境  :自行安裝好 Tomcat 8.5  。 以及兩個以上java的 web專案,打包成war包。 二 、把war包放在 webapps 目錄下面 , 如下(根據自己路徑來放置) E:\wamp\Tomcat 8.5\webapps 三、開啟配置

DRUID配置資料來源專案

/** * @Title: DruidStatViewServlet.java * @Package org.spring.springboot.servlet * @Description: TODO(用一句話描述該檔案做什麼) * @author peng

Maven實戰》讀書筆記--(1)使用intellij idea搭建並配置maven模組專案

本文使用intellij idea搭建Maven3多模組專案,並進行配置相關配置,以實現專案的構建打包。 專案結構 multi-module-project是我們的專案名稱,其中包含多個模組: mmp-dal模組:資料訪問層,提供對原始資料(主要指資料庫)的操作

模組下的maven jetty外掛配置

1. 首先你要學會單模組的jetty外掛配置.         網上都是老的 maven-jetty-plugin       http://www.cnblogs.com/fnng/archive/2011/12/16/2290587.html     但是有些

springboot maven模組構建最簡化配置

一直在本地執行的多模組專案需要放到伺服器上,於是開始打包;以前沒有接觸過多模組的專案,碰到了一些坑,下面給正確的配置發出來:整個專案分為三個模組:common,core,web;core依賴common,web依賴common和core;在common和core(被依賴的mo

Springboot整合dubbo構建maven模組專案(一)- 專案建立和pom.xml中jar包配置

       以前一直用Spring作為容器構建專案,但是看到Spring官網一直在推Springboot,最重要的是Springboot確實避免自己尋找多個jar包(大多數情況下,可能自己都不記得該引入哪些jar包)和jar包之間衝突的問題,同時省掉了在整合其他框架時候

Maven模組專案動態打包(SpringMVC資料來源動態配置

開發工具:Intellij IDEA。 專案框架:SpringMvc 技術:Maven Profile 專案目錄: manager是聚合工程,剩下的manager-*是模組,其中manager-web打包方式是war。 動態釋出配置在manager-web中進行,不涉及其

Maven實驗總結一:模組部署與pom.xml配置的注意事項

1,父模組的<packaging>必須為pom 2,<packaging>的預設值為jar 3,父模組要在pom裡新增如下配置,來“組織”子模組;<module&