Maven學習-目錄結構

jopen 9年前發布 | 14K 次閱讀 Maven 項目構建

 

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的目錄結構,我們應該就可以清晰地知道每個目錄以及其子目錄的用途和存放的文件具體做什么的了。

參考

http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

 本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!