設計規範系列（簡要）-類命名規範、資料庫命名規範、分頁檔命名規範

一、類命名規範
 1. Entity層 ：
          繼承關係：所有類繼承自BasicEntity, 其中BasicEntity實現 java.io.Serializable介面；
          命名規則： 類名稱 = Object + 類尾碼，其中類尾碼為 Bean，如：SalesOrderBean
  2. Form層 ：
          繼承關係：所有類繼承自BasicForm, 由於本項目基於Struts結構，因此BaseForm繼承自ValidatorForm；
          命名規則： 類名稱 = Object + 類尾碼，其中類尾碼為 Form，如：SalesOrderForm
  3. Action層 ：
          繼承關係：所有類均繼承自BasicAction, 其中BasicAction實現Action層異常的統一處理；
                    由於本項目基於Struts結構，因此BaseAction繼承自DispatchAction；
          命名規則： 類名稱 = Object + 類尾碼，其中類尾碼為 Action，如：SalesOrderAction
  4. Logic層 ：
          繼承關係：所有類繼承自BasicLogicObject，其中BasicLogicObject實現Logic層異常的統一處理和許可權檢查，至於為什麼要在這層進行許可權的檢查，主要考慮到未來提供SOA服務時升級的需要；
          命名規則： 類名稱 = Object + 類尾碼，其中類尾碼為 Logic，如：SalesOrderLogic
  5. Biz層 : 
          繼承關係：所有類繼承自BasicBizObject，其中BasicBizObject實現Biz層異常的統一處理；
          命名規則： 類名稱 = Object + 類尾碼，其中類尾碼為 Biz，如：SalesOrderBiz
  6. DAO介面層： 
          命名規則： 類名稱 = 類首碼 + Object + 類尾碼，其中類首碼為I，尾碼為 Dao，如：ISalesOrderDao
  7. DAO實現層 : 
          繼承關係：所有類繼承自BasicDaoObject，其中BasicDaoObject實現Dao實現層異常的統一處理；
          命名規則： 類名稱 = Object + 類尾碼，其中類尾碼為 Impl，如：SalesOrderImpl

 

二、資料庫命名規範

1、資料庫表
    根據表所屬的子系統/模組，命名方式為：
        資料庫表名 = 子系統/模組 縮寫 + 表含義
    其中子系統/模組的縮寫首字母大寫，表含義中每個單詞的首字母為大寫。

    子系統/模組及其縮寫應在《資料庫設計說明書》的約定部分加以描述。

    例如：代碼錶可統一採用”code”為表的首碼，則：code_area表示地區代碼錶

2、表欄位：
    概念性模型中，每個資料庫中為每個表定義唯一的縮寫，長度為4~8個字元，
        欄位名 = 表縮寫 + “_”  + 欄位含義。
    如地區代碼錶欄位首碼為area，其相關欄位名：
    area_id     ：地區代碼ID主鍵
    area_name  ：地區代碼名稱

    資料庫表名及表縮寫應在《資料庫設計說明書》中加以描述。
3、索引
    索引名 = idx + “_” + 表縮寫 + 相關欄位/索引含義
4、關聯
    關聯指資料庫表之間的外鍵關係
        關聯名 =  rl + “_” + 主表縮寫 + 從表縮寫
5、預存程序：
    預存程序名 = proc + “_” + 預存程序含

 

三、分頁檔命名規範：

1、目錄命名原則

Ø        大小寫：目錄命名首字母小寫，其他字母可大寫；

Ø        分層原則：分頁檔的根目錄為tiles；根目錄下根據功能子系統建立子目錄;功能子系統目錄下可按照功能模組建立子目錄；

Ø        公用頁面：子系統或功能模組下公用頁面的目錄一般命名為component;

 

2、JSP檔案命名原則

Ø        大小寫：所有檔案的首字母大寫；

Ø        命名：根據頁面的功能，一般為：操作動作 + 操作對象，其中操作對象的首字母大寫；

Ø        常用的操作動作：

新增：New

編輯：Edit

查看：View

列表：List

審批：Audit

確認：Confirm

查詢：Query

選擇：Choice, 一般用於彈出；

統計：Stat

 

Ø        特殊處理

有時候某一操作會有不同的來源或有不同的目的，這種情況下檔案尾碼加上“From”或 “For”等串連詞和來來源物件。例如，根據銷售訂單產生銷售退貨單的頁面名稱為：NewSalesReturnFromSalesOrder.jsp