閑扯Maven項目代碼組織形式
1. 代碼組織形式
- 1.1 平鋪
- 1.2 父子結(jié)構(gòu)
2. 打包問題
- 2.1 繼承
- 2.2 聚合
3. 小結(jié)
因為最近有小伙伴問到了,所以我想和大家隨便扯扯 Maven 項目中代碼的組織形式這個問題。
其實也不是啥大問題,但是如果不懂的話,就像霧里看花,始終不能看的明明白白,懂了就像一層窗戶紙,捅破就好了。
所以我們就簡單扯幾句。
1. 代碼組織形式
首先來說說代碼組織形式。
一般來說,就兩種比較常見的形式:
- 平鋪
- 父子結(jié)構(gòu)
這兩種形式松哥在不同的項目中都有遇到過,所以我們就不說孰優(yōu)孰劣,單純來說這兩種方案。
1.1 平鋪
平鋪的代碼類似下面這樣:
- ├── parent
- │ ├── pom.xml
- │ └── src
- │ ├── main
- │ │ ├── java
- │ │ └── resources
- │ └── test
- │ └── java
- ├── vhr-dao
- │ ├── pom.xml
- │ ├── src
- │ │ ├── main
- │ │ │ ├── java
- │ │ │ └── resources
- │ │ └── test
- │ │ └── java
- └── vhr-service
- ├── pom.xml
- ├── src
- │ ├── main
- │ │ ├── java
- │ │ └── resources
- │ └── test
- │ └── java
如下圖:
可以看到,在這種結(jié)構(gòu)下,parent 父工程和各個子工程從代碼組織形式上來看都是平級的,都處于同一個目錄下。
不過仔細(xì)查看 pom.xml 文件,還是能夠清晰的看到這三個 module 的父子關(guān)系的:
parent:
- <?xml version="1.0" encoding="UTF-8"?>
- <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/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <groupId>org.javaboy</groupId>
- <artifactId>parent</artifactId>
- <packaging>pom</packaging>
- <version>1.0-SNAPSHOT</version>
- <modules>
- <module>../vhr-dao</module>
- <module>../vhr-service</module>
- </modules>
- </project>
可以看到,在指定 module 時,由于 vhr-dao 和 vhr-service 和 parent 的 pom.xml 不在同一個目錄下,所以這里使用了相對路徑,相對路徑的參考依據(jù)是 parent 的 pom.xml 文件位置。
vhr-dao:
- <?xml version="1.0" encoding="UTF-8"?>
- <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/xsd/maven-4.0.0.xsd">
- <parent>
- <artifactId>parent</artifactId>
- <groupId>org.javaboy</groupId>
- <version>1.0-SNAPSHOT</version>
- <relativePath>../parent/pom.xml</relativePath>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>vhr-dao</artifactId>
- </project>
可以看到,relativePath 節(jié)點中,通過相對路徑指定了 parent 的 pom.xml 文件位置,這個相對路徑的參考依據(jù)是子模塊的 pom.xml 文件。
vhr-service:
- <?xml version="1.0" encoding="UTF-8"?>
- <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/xsd/maven-4.0.0.xsd">
- <parent>
- <artifactId>parent</artifactId>
- <groupId>org.javaboy</groupId>
- <version>1.0-SNAPSHOT</version>
- <relativePath>../parent/pom.xml</relativePath>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>vhr-service</artifactId>
- </project>
這個和 vhr-dao 的差不多,不贅述。
1.2 父子結(jié)構(gòu)
父子結(jié)構(gòu)則類似于下面這樣:
- ├── maven_parent
- │ ├── pom.xml
- │ ├── vhr-dao
- │ │ ├── pom.xml
- │ │ └── src
- │ │ ├── main
- │ │ │ ├── java
- │ │ │ └── resources
- │ │ └── test
- │ │ └── java
- │ └── vhr-service
- │ ├── pom.xml
- │ └── src
- │ ├── main
- │ │ ├── java
- │ │ └── resources
- │ └── test
- │ └── java
如下圖:
這種父子結(jié)構(gòu)的看起來就非常的層次分明了,parent 和各個 module 一眼就能看出來,我們從 GitHub 上下載的很多開源項目如 Shiro,都是這種結(jié)構(gòu)。
不過文件夾的層級并不能說明任何問題,關(guān)鍵還是要看 pom.xml 中的定義,接下來我們就來看看 parent 的 pom.xml 和各個子模塊的 pom.xml 有何異同。
maven_parent:
- <?xml version="1.0" encoding="UTF-8"?>
- <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/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <groupId>org.javaboy</groupId>
- <artifactId>maven_parent</artifactId>
- <packaging>pom</packaging>
- <version>1.0-SNAPSHOT</version>
- <modules>
- <module>vhr-dao</module>
- <module>vhr-service</module>
- </modules>
- </project>
和前面不同的是,這里聲明 modules 不需要相對路徑了(其實還是相對路徑,只是不需要 ../ 了),因為各個子模塊和 parent 的 pom.xml 文件處于同一目錄下。
vhr-dao:
- <?xml version="1.0" encoding="UTF-8"?>
- <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/xsd/maven-4.0.0.xsd">
- <parent>
- <artifactId>maven_parent</artifactId>
- <groupId>org.javaboy</groupId>
- <version>1.0-SNAPSHOT</version>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>vhr-dao</artifactId>
- </project>
這里也不需要通過 relativePath 節(jié)點去指定 parent 的 pom.xml 文件位置了,因為 parent 的 pom.xml 和各個子模塊處于同一目錄下。
vhr-service:
- <?xml version="1.0" encoding="UTF-8"?>
- <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/xsd/maven-4.0.0.xsd">
- <parent>
- <artifactId>maven_parent</artifactId>
- <groupId>org.javaboy</groupId>
- <version>1.0-SNAPSHOT</version>
- </parent>
- <modelVersion>4.0.0</modelVersion>
- <artifactId>vhr-service</artifactId>
- </project>
2. 打包問題
2.1 繼承
有的時候,單純只是想通過 parent 來統(tǒng)一管理不同的項目的依賴,并非一個聚合項目。
這個時候只需要去掉 parent 的 pom.xml 中的 modules 節(jié)點及其中的內(nèi)容即可,這樣就不是聚合工程了,各個子模塊也可以獨立打包。
2.2 聚合
當(dāng)然很多情況我們是聚合工程。
聚合工程的話,一般松哥是建議大家從 parent 處統(tǒng)一進(jìn)行打包:
這樣可以確保打包到的是最新的代碼。
當(dāng)然還有另外一種操作流程:
- 首先將 parent 安裝到本地倉庫。
- 然后分別將 model、dao 以及 service 等模塊安裝到本地倉庫。
- 最后 web 模塊就可以獨立打包了。
如果使用這種操作流程,需要注意一點,就是每個模塊代碼更新之后,要及時安裝到本地倉庫,否則當(dāng) web 模塊獨立打包時,用到的其他模塊就不是最新的代碼。
3. 小結(jié)
好啦,幾個 Maven 中的小問題,窗戶紙捅破了就豁然開朗啦~
本文轉(zhuǎn)載自微信公眾號「江南一點雨」,可以通過以下二維碼關(guān)注。轉(zhuǎn)載本文請聯(lián)系江南一點雨生公眾號。