一、項目結構
這里和其他項目區別不大,我將模板抽離出來,更容易分析和理解:
解釋一下:js主要包括extends(引入第三方的js)、module(項目模塊自己的js)、lib(引用包,這里也可以繼續拆分),module中包含具體的模塊中的js。common.js是核心命名空間的js.
二、common.js
解釋一下,Globals作為全局命名空間,各個模塊均可以在此命名空間里定義域(如果有不明白的可以自學下命名空間,這個文件寫死就行,也不用具體理解)。
華東web項目工程規范
基於Java開發平台開發業務系統,建議使用maven作為構建工具,以方便不同組件和依賴包的管理。客戶現場開發的情況,訪問Maven倉庫確實困難的,可事先將依賴關系以Release的方式下載到一個集中的目錄,然后使用Ant對工程進行構建。
程序目錄結構應遵從maven默認約定(即使采用ANT構建),以統一規范,簡化構建配置。一個典型的JavaEE應用(對應公司某產品、或某個項目的程序),目錄結構如下:
大型項目應划分多個工程(project,模塊),每個工程的目錄結構也同樣遵從相同約定。
各目錄的內容/用途如下:
目錄 |
用途 |
src/main/java |
Application /Library 的java源代碼(再分package) |
src/main/flex |
增加:flex源碼,包含mxml定義、assets和as腳本 |
src/main/resources |
Application/Library 的資源文件,如多字符集boundle,位圖,配置文件等(單獨建立conf等子目錄) |
src/main/resources/conf |
增加:准備封到JAR包中的配置文件(默認包下conf/目錄) |
src/main/filters |
【暫不用】Resource filter files |
src/main/assembly |
【暫不用】Assembly descriptors |
src/main/config |
【暫不用】maven配置文件 |
src/main/webapps |
Web 應用的網頁,WEB-INF目錄等所在,詳見本表下方說明 |
|
|
src/test/java |
單元測試的源代碼 |
src/test/resources |
測試使用的資源文件,如集成測試腳本等 |
src/test/resources/conf |
增加:測試用例需要的配置文件 |
src/test/filters |
【暫不用】Test resource filter files |
src/site |
【暫不用】Site |
|
|
target |
maven編譯目錄,包含中間過程文件和最終的工件(如jar) |
|
|
pom.xml |
Maven工程的配置文件,以此控制maven構建行為 |
LICENSE.txt |
產品/本工程的版權信息文件 |
README.txt |
產品/本工程的說明文件 |
為規范war包結構,對src\main\webapp目錄做如下約定:
目錄 |
存放內容 |
css |
存放.css格式文件(可再分目錄) |
skins |
存放皮膚文件(按主題划分的framework的位圖) |
images |
存放圖片,按產品、功能模塊划分子目錄 |
js |
JavaScript文件(對象、函數庫) |
include |
存放被包含的JS文件片段【注:JSP文件互相不要包含,通過模板/組件/標簽庫/BEAN實現重用】 |
resources |
存放JSF組件、相關資源等 |
templates |
模板文件存放地,按類別划分子目錄 |
pages |
網頁目錄(靜態和動態網頁,除index.jsp),按產品、功能模塊划分子目錄 |
webapp下其他目錄 |
解釋為模塊名,認為其中全部為網頁,可再分子目錄 |
META-INF |
存放清單文件、services等配置信息 |
WEB-INF |
網站配置文件目錄,存放WEB.XML等配置信息 |
WEB-INF/classes |
未打包的項目編譯代碼,禁止手工修改。 |
WEB-INF/conf |
存放struts,spring,hibernate,JSF等的配置文件 |
WEB-INF/lib |
存放第三方JAR包,使用MAVEN構建時此目錄禁止手動放入文件! |
WEB-INF/pages |
高安全性的網頁目錄,如登錄信息維護等 |
WEB-INF/tld |
JSP標簽庫定義文件存放目錄 |