Maven學習-目錄結構
在前一篇文章中,我們介紹了什麼是Maven,以及如何用Maven來構建我們的專案。不瞭解Maven的童鞋,可以看這裡Maven學習-入門。在這篇文章中,我們將學習Maven的專案的目錄結構相關的內容。
我們知道,Maven約定了一套規則來建立和構建我們的專案。得益於Maven的一些約定,我們只要學習相對很少的命令就可以建立和管理我們的專案。在專案的目錄結構上,Maven有一套約定的通用的目錄結構。
使用一套通用的目錄結構的好處是,可以減少開發人員熟悉不同Maven專案時的認知負擔。在使用相同的目錄結構的情況下,開發人員可以很快的熟悉一個專案。接下來,我們將開始介紹Maven的通用的目錄結構。
通用目錄結構
Maven預設約定了一套目錄結構,在通過Maven建立了專案以後,專案的目錄結構就是以這套目錄結構作為模板建立的。
${basedir} |-- pom.xml |-- src | |-- main | | `-- java | | `-- resources | | `-- filters | `-- test | | `-- java | | `-- resources | | `-- filters | `-- it | `-- assembly | `-- site `-- LICENSE.txt `-- NOTICE.txt `-- README.txt
src/main/java
專案的原始碼所在的目錄src/main/resources
專案的資原始檔所在的目錄src/main/filters
專案的資源過濾檔案所在的目錄src/main/webapp
如果是web專案,則該目錄是web應用原始碼所在的目錄,比如html檔案和web.xml等都在該目錄下。src/test/java
測試程式碼所在的目錄src/test/resources
測試相關的資原始檔所在的目錄src/test/filters
測試相關的資源過濾檔案所在的目錄
上面的目錄結構,我們接觸的比較多,而下面的這些目錄結構,用的相對不是很多:
src/it
整合測試程式碼所在的目錄,主要是供別的外掛使用的。src/assembly
元件(Assembly)描述符所在的目錄src/site
站點檔案LICENSE.txt
專案的許可檔案NOTICE.txt
該專案依賴的庫的注意事項README.txt
專案的readme檔案
在一個Maven專案中,在專案根目錄下,除了包含了上面約定的目錄結構中的部分目錄外,還包含了專案描述檔案,pom.xml檔案。
在根目錄下,主要有兩個目錄,分別是src
和target
目錄,除此之外,還會有一些版本控制系統的元資料檔案,包括git的.gitignore
或者svn的.svn
。如果一個專案時由多個子專案組成的,那麼在該專案的根目錄下,還會包含它的子專案的目錄。子專案的目錄佈局,預設也是和上面列出的目錄結構一致的。
我們在上一篇文章中以及提及了target
目錄,這個目錄只要用於存放專案構建的輸出檔案,比如class檔案以及打包後的包檔案等。
在src
目錄下,包含了專案所有的原始碼和資原始檔,以及其他專案相關的檔案。在該目錄的main
目錄下,包含了構建該專案的artifact(可以理解為時專案的程式部分)所需的程式碼和資源,而test
目錄包含了測試相關的程式碼和資原始檔。
在目錄main
和test
下的子目錄結構,是非常相似的,都包含了兩個子目錄:java
子目錄和resources
子目錄,這兩個目錄分別放了原始碼和資原始檔。不同的是,在main
目錄下的這兩個目錄中放置了專案主程式的程式碼,而在test
目錄下,放置的是測試相關的程式碼和資原始檔。其中java
目錄是程式碼的根目錄,在該目錄下的子目錄,就是Java的包名對應的目錄結構了。
現在,我們再來看Maven的目錄結構,我們應該就可以清晰地知道每個目錄以及其子目錄的用途和存放的檔案具