在前一篇文章中,我們介紹了什么是Maven,以及如何用Maven來構(gòu)建我們的項(xiàng)目。不了解Maven的童鞋,可以看這里Maven學(xué)習(xí)-入門。在這篇文章中,我們將學(xué)習(xí)Maven的項(xiàng)目的目錄結(jié)構(gòu)相關(guān)的內(nèi)容。
我們知道,Maven約定了一套規(guī)則來創(chuàng)建和構(gòu)建我們的項(xiàng)目。得益于Maven的一些約定,我們只要學(xué)習(xí)相對(duì)很少的命令就可以創(chuàng)建和管理我們的項(xiàng)目。在項(xiàng)目的目錄結(jié)構(gòu)上,Maven有一套約定的通用的目錄結(jié)構(gòu)。
使用一套通用的目錄結(jié)構(gòu)的好處是,可以減少開發(fā)人員熟悉不同Maven項(xiàng)目時(shí)的認(rèn)知負(fù)擔(dān)。在使用相同的目錄結(jié)構(gòu)的情況下,開發(fā)人員可以很快的熟悉一個(gè)項(xiàng)目。接下來,我們將開始介紹Maven的通用的目錄結(jié)構(gòu)。
通用目錄結(jié)構(gòu)
Maven默認(rèn)約定了一套目錄結(jié)構(gòu),在通過Maven創(chuàng)建了項(xiàng)目以后,項(xiàng)目的目錄結(jié)構(gòu)就是以這套目錄結(jié)構(gòu)作為模板創(chuàng)建的。
${basedir}
|-- pom.xml
|-- src
| |-- main
| | `-- java
| | `-- resources
| | `-- filters
| `-- test
| | `-- java
| | `-- resources
| | `-- filters
| `-- it
| `-- assembly
| `-- site
`-- LICENSE.txt
`-- NOTICE.txt
`-- README.txt
src/main/java 項(xiàng)目的源代碼所在的目錄
src/main/resources 項(xiàng)目的資源文件所在的目錄
src/main/filters 項(xiàng)目的資源過濾文件所在的目錄
src/main/webapp 如果是web項(xiàng)目,則該目錄是web應(yīng)用源代碼所在的目錄,比如html文件和web.xml等都在該目錄下。
src/test/java 測(cè)試代碼所在的目錄
src/test/resources 測(cè)試相關(guān)的資源文件所在的目錄
src/test/filters 測(cè)試相關(guān)的資源過濾文件所在的目錄
上面的目錄結(jié)構(gòu),我們接觸的比較多,而下面的這些目錄結(jié)構(gòu),用的相對(duì)不是很多:
src/it 集成測(cè)試代碼所在的目錄,主要是供別的插件使用的。
src/assembly 組件(Assembly)描述符所在的目錄
src/site 站點(diǎn)文件
LICENSE.txt 項(xiàng)目的許可文件
NOTICE.txt 該項(xiàng)目依賴的庫(kù)的注意事項(xiàng)
README.txt 項(xiàng)目的readme文件
在一個(gè)Maven項(xiàng)目中,在項(xiàng)目根目錄下,除了包含了上面約定的目錄結(jié)構(gòu)中的部分目錄外,還包含了項(xiàng)目描述文件,pom.xml文件。
在根目錄下,主要有兩個(gè)目錄,分別是src 和target 目錄,除此之外,還會(huì)有一些版本控制系統(tǒng)的元數(shù)據(jù)文件,包括git的.gitignore 或者svn的.svn 。如果一個(gè)項(xiàng)目時(shí)由多個(gè)子項(xiàng)目組成的,那么在該項(xiàng)目的根目錄下,還會(huì)包含它的子項(xiàng)目的目錄。子項(xiàng)目的目錄布局,默認(rèn)也是和上面列出的目錄結(jié)構(gòu)一致的。
我們?cè)谏弦黄恼轮幸约疤峒傲?code>target目錄,這個(gè)目錄只要用于存放項(xiàng)目構(gòu)建的輸出文件,比如class文件以及打包后的包文件等。
在src 目錄下,包含了項(xiàng)目所有的源代碼和資源文件,以及其他項(xiàng)目相關(guān)的文件。在該目錄的main 目錄下,包含了構(gòu)建該項(xiàng)目的artifact(可以理解為時(shí)項(xiàng)目的程序部分)所需的代碼和資源,而test 目錄包含了測(cè)試相關(guān)的代碼和資源文件。
在目錄main 和test 下的子目錄結(jié)構(gòu),是非常相似的,都包含了兩個(gè)子目錄:java 子目錄和resources 子目錄,這兩個(gè)目錄分別放了源代碼和資源文件。不同的是,在main 目錄下的這兩個(gè)目錄中放置了項(xiàng)目主程序的代碼,而在test 目錄下,放置的是測(cè)試相關(guān)的代碼和資源文件。其中java 目錄是代碼的根目錄,在該目錄下的子目錄,就是Java的包名對(duì)應(yīng)的目錄結(jié)構(gòu)了。
現(xiàn)在,我們?cè)賮砜碝aven的目錄結(jié)構(gòu),我們應(yīng)該就可以清晰地知道每個(gè)目錄以及其子目錄的用途和存放的文件具體做什么的了。
參考
http://maven./guides/introduction/introduction-to-the-standard-directory-layout.html
|