Posted on 2007-03-21 20:55
Jaunt 閱讀(597)
評論(0) 編輯 收藏 所屬分類:
軟件工藝
?
1. 類文件的放置要求:
分包的原則是首先按層劃分,其次是按模塊劃分:
① com.yinhe.common????? 放置本應用的公共類
(例如:GlobalNames.java、DBConnection.java等);
② com.yinhe.util????????? 放置可以被其它web應用重復利用的公共類文件
(例如:編碼過濾器EncodeFilter.java、
安全過濾器SavetyFilter.java、
字符過濾器 WordFilter.java、
html語言過濾器HtmlToString.java、
GBK轉碼類 GBKToString.java等);
③ com.yinhe.login.web???? 放置在視圖層(jsp)中用到的JavaBean值對象
(例如:UserInfVO.java);
④ com.yinhe.login.control? ? 放置控制類和ActionForm
(例如:Struts中的 LoginAction.java、UserForm.java);
⑤ com.yinhe.login.dto????? 放置在業務邏輯層中用到的JavaBean數據傳輸對象
(例如:UserInfDTO.java);
⑥ com.yinhe.login.modle??? 放置業務操作實體類(例如:UserDAO.java);
⑦ com.yinhe.login.pojo???? 放置JavaBean持久對象(例如:User.java);
⑧ conf?????????????????? 放置工程配制文件
(例如:ApplicationResources.properties、global.properties)
?? conf.spring???????????? 放置Spring配制文件(例如:applicationContext.xml等)
?? conf.hibernate?????????? 放置Hibernate配制文件(例如:hibernate.cfg.xml等)
?
⑨ WEB-INF\conf? ???????? 放置struts屬性配置文件
2. jsp文件的放置要求:
① 所有受保護的(過直接路徑不允許訪問的頁面)放在admins下面,
admins下面的left.jsp放置菜單,top.jsp放置logo,main.jsp為主工作區,
wellcome.jsp為默認的首頁(登錄成功之后的顯示頁面);
② 默認的訪問首頁命名為: index.jsp;
3. 樣式文件的放置要求:
① 按照模塊劃分放置在/css/模塊名;公用的樣式放在common.css下面;
4. 圖片文件的放置要求(非上傳文件):
① 按照模塊劃分放置在/images/模塊名;
5. 腳本文件的放置要求:
① 按照模塊劃分放置在/js/模塊名;公用的樣式放在common.js下面;
6. 上傳文件的放置要求:
① 圖片文件放在upload/pic/模塊名/文件;
② 非圖片文件放在upload/other/文件;
7. 命名要求:
① 所有jsp文件一律小寫;
② 所有靜態文件的后綴名一律以.htm結尾;
③ 所有類文件都必須嚴格區分大小寫,
接口必須以I開頭,實現類以Imp結尾 (例如IUser.java , UserImp.java),
如果是ActionForm必須以Form結尾(UserForm.java);
控制類必須以Action結尾(UserAction.java);
視圖類必須以VO結尾(UserVO.java);
所有操作數據庫的業務類必須以DAO結尾(UserDao.java);
所有數據傳輸對象必須以DTO結尾(UserDTO);
④ 所有的包一律小寫,分包的原則是首先按層分其次是按模塊劃分;
?包名的第一及多為com或者org;
⑤ 所有java文件中的變量按照java的要求命名,常量一律全大寫;
⑥ 數據庫命名:
?表名和java的實體類名對應而且全部大寫(例如 USER 表對應 UserDAO.java);
?
⑦ 存儲過程的命名:
傳入參數以p_開頭(例如p_user),局部變量以v_開頭(例如 v_intCount),
存儲過程的名稱以p_開頭(例如 p_add),
觸發器以t_開頭(例如 t_update),視圖以v_開頭(v_list_user),
所有參數的命名按照前面的原則:
主鍵以PK_開頭,外鍵以FK_開頭,唯一鍵用UN_開頭,
檢查約束用CHK_開頭,默認值用DEF_開頭,
每個表都必須有一個物理ID(自動產生),其命名為ID;
同時還應該有一個邏輯ID,其命名為"表名_"+ID(例如 USER_ID);
?⑧ 所有的java源文件和數據庫的數據對象必須有注釋,必須嚴格按照相應的規則注釋,不要為了寫注釋而寫注釋,java的注釋必須能自動形成JavaDOC文檔;
8. 關于提交代碼的規定:
?① 每天上班前必須和CVS同步,每天下班前必須提交自己的代碼和文檔(代碼必須在本地被編譯通過);
?② 當本地文件和CVS產生沖突的時候不要強行覆蓋,必須找出沖突的原因,消除沖突后再提交,千萬不要把別人的代碼給盲目的覆蓋了;
?③ 如果發現jsp文件發生了改變,如果是二進制的比較方式,可能因為增加了換行和回車或者空格而產生沖突,這時可不考慮沖突的問題;
9. 其它事宜:
① 加強溝通,形成高效+創新+強戰斗力的團隊!
② 服從分配,按時保質保量完成任務~!
?