熱點推薦:
您现在的位置: 電腦知識網 >> 編程 >> Java編程 >> Java核心技術 >> 正文

開發前的約定

2013-11-23 19:01:25  來源: Java核心技術 

  今天進入可開發前的准備階段在開發項目前要求每位開發小組成員都必須先閱讀以下約定嚴格按以下約定來進行開發
  
  系統框架
  
  ·系統總框架采用SUN JEE框架使用JAVA/XML技術和組件技術 基於Application server開發
  
  ·項目中的程序必須嚴格按JEE規范來編碼EJB建議采用規范編碼盡可能多使用EJB 模式設計參考技術文檔如下
  
  《JEE Tutorial》
  
  jee_doctutorialdraftpdf
  
  《JBoss Quick Start Guide》
  
  《EJB Design Patterns》
  
  
  開發環境
  
  
  ·測試用Application server采用JASJAS 配置於Linux OS下IP地址登錄用戶名JEEOA密碼JEEOA登錄ftp工具建議使用SSH Secure Shell或LeapFTPftp地址為:
  
  ·項目開發源碼目錄為/home/local/jboss/applications/JEEOA/src項目開發文檔目錄為/home/product/JEEOA/
  
  · 數據庫服務器IP為數據庫采用Mysql管理工具為phpadmin登錄數據庫的用戶名為test密碼為test
  
  
  源代碼目錄規范
  
  
  每位開發小組成員一定要絕對遵守以下創建源代碼目錄的規范
  
  項目開發目錄結構簡圖
  
  |apps
   |JEEOA
   |admin
  |components
   |a component
  |modules
   |a module
  |lib
   |ant
  |buildproperties
   
  圖片 項目開發目錄結構圖
  
  項目開發目錄結構說明
  
  \ (說明根目錄)
  |apps (說明此目錄下放應用程序的代碼)
   |JEEOA (說明此目錄為放JEEOA應用程序的代碼)
   |admin (說明此目錄為放項目的admin應用程序的代碼)
  |components (說明此目錄下放應用程序組件的代碼)
   |a component (說明此目錄為放一個組件的代碼)
  |modules (說明此目錄下放應用程序模塊的代碼)
   |a module (說明此目錄為放一個模塊的代碼)
  |lib (說明此目錄下放項目開發工具)
   |ant (說明Ant工具包括bin和lin目錄)
  |buildproperties
  (說明此文件定義項目開發共用的環境變量
  如jbosshomenfigurationservletlibpath等)
  
  模塊組件開發目錄結構簡圖
  
  |build
  |etc
   |multilangs
  |lib
   |docs
   |ejb
  | METAINF
   |jee
    |METAINF
   |web
  |WEBINF
  |src
   |ejb
   |javabean
   |servlet
   |web
  |buildbat
  |buildsh
  |buildxml
   
  圖片 模塊組件目錄結構圖
  
  
  說明srcetc目錄和buildbatbuildshbuildxml為開發人員建立的目錄build和lib目錄為由ant工具生成的目錄
  
  模塊組件開發目錄結構說明
  
  \ (說明一個模塊或一個組件的根目錄)
  |build (說明保存由ant工具生成的擴展名為jarwarear等文件)
  |etc
  (說明存放部署文件如webxmlejbjarxmlapplicationxml
  jawsxmljbosscmpjdbcxml等)
   |multilangs (說明存放多語言資源文件擴展名為properties)
  |lib (說明保存由ant工具生成的API文件class文件等)
   |docs
  |api
   |ejb
  | METAINF
   |jee
    |METAINF
   |web
  |WEBINF
  |src (說明存放源代碼包括java和jsp代碼下面有四個目錄)
   |ejb (說明采用EJB進行開發存放EJB和Helper Classes源代碼)
   |javabean (說明采用Javabean進行開發存放Javabean和Helper Classes源代碼)
   |servlet (說明存放Servlet源代碼)
   |web (說明存放JSP源代碼)
  |buildbat (說明在Window OS下進行build的文件)
  |buildsh (說明在Unix OS下進行build的文件)
  |buildxml (說明Ant工具要build的目標文件)
  
  應用程序開發目錄結構簡圖
  
  |build
  |etc
  |lib
   |docs
   |ejb
  | METAINF
   |jee
    |METAINF
   |web
  |WEBINF
  |team
   |a member
  |ejb
  |javabean
  |web
  |buildbat
  |buildsh
  |buildxml
  |buildproperties
  
  圖片 應用程序目錄結構圖
  
  
  應用程序開發目錄結構
  
   由於項目由多個程序員一起來進行編碼所以應用程序開發目錄結構和模塊組件開發目錄結構的不一樣
  
   應用程序開發目錄結構沒有src目錄但多了一個team目錄此目錄存放所有程序員的classes和Jsp代碼
  
   應用程序開發目錄結構下buildxml和模塊組件開發目錄結構下的buildxml有很大不同
  
   由項目組長負責管理etc目錄buildxmlbuildbatbuildshbuildproperties程序員分別管理team目錄下的屬於自己的目錄如程序員tom管理team/tom目錄
  buildxml編碼規范
  
  · 應用程序目錄下的buildxml
  
  源代碼應用程序目錄下的buildxml規范模板
  
  說明在建立buildxml時組長只需修改創建的時間和變量ProjectName等
  
  模塊組件目錄下的buildxml
  
  源代碼模塊組件目錄下的buildxml規范模板
  
  說明在建立buildxml時開發人員只需修改創建的時間和和變量ProjectNamecomponentName等
  
  
  編碼規范
  
  
  · 項目中的JAVA源代碼必須按《JAVA開發規范》
  
  ·項目中的JSP代碼必須按《JSP開發規范》
  
  · 每位開發小組成員在開發項目時都嚴格按此規范來進行編寫程序讓項目中所有的文檔都看起來像一個人寫的增加可讀性減少項目組中因為換人而帶來的損失
  
  · 每位開發小組成員一定要絕對遵守這個規范當實際應用與下面的規范相抵觸時記錄下原因潛在後果以及符合規范需要的條件但必須是在讓程序有良好的可讀性的前提下
  
  
  功能模塊
  
  
  在做業務邏輯模塊前先把一些准備工作做出來
  
  建立一些公用的bean(項目中稱為系統控制器controller)包名為ntroller*提供給系統各模塊使用包括對時間字符的操作調試器軟件國際化多語言版本系統的WEB外殼MVC模式的Servlet和Action對WEB頁面顯示的控制如樹結構路徑結構等等
  
  建立一個序列發生器包名為comcwapoasequencegenerator*提供給bean使用它用來產生一個唯一的ID而且也可用來計數也就是把它當成計數器使用介紹如何取id的方法的文字要寫在bean的代碼內以便生成API後供其它開發人員參閱
  
  建立一個ServerFacade它為EJB Home提供統一的接口ServerFacade為程序要用到的所有EJB的home handle提供緩存提高訪問效率以後查找JNDI Name的方法都應寫在接口裡調用時直接從接口調用
  
  建立一個翻頁控制器包名為ntrollerwebpage*用來進行分頁顯示的管理以後頁面中的分頁都由翻頁控制器管理
  
  
  異常處理和日志
  
  
  · 程序中所有的異常處理使用統一的調試器bean的名稱為ntrollerutilDebug用法見項目API
  
  · 程序中所有的日志使用Jakartalogj管理包的名稱為logjjar
  
  官方URL
  
  
  Session
  
  
  · 放在session中的變量統一放在一個bean裡存儲不直接把session變量名稱放在JSPServlet或Bean內存儲session變量名稱的bean為ntrollerwebutilWebKeys取session變量名的方法為getXX()
  
  · 取session變量的值的方法統一放在一個bean裡bean的名稱為ntrollerwebutilJSPUtil取session變量值的方法為getXX()之後要取session變量值就調用JSPUtil中對應的方法
  
  · 當前系統中已知的session變量名有useriduserNamelocaleskinuserid為用戶標識userName為用戶名稱locale為用戶選擇的地域skin為用戶選擇的界面風格
  
  
  DAO
  
  
  使用DAO封裝SQL語言對數據庫的直接操作DAO采用Factory模式編寫
  
  
  組件
  
  
  所有的業務邏輯使用組件技術每個組件內同時提供EJB版本和DAO版本兩種的方法不推薦直接使用EJB版本和DAO版本的方法 <
From:http://tw.wingwit.com/Article/program/Java/hx/201311/26157.html
    推薦文章
    Copyright © 2005-2013 電腦知識網 Computer Knowledge   All rights reserved.