天天看點

簡單的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.<project xmlns="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.<project xmlns="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.<project xmlns="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.<project xmlns="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 ... 。