一.編程規約
1.命名風格‘
1.代碼中的命名不能以下划線或美元符號開始 也不能以下划線或者美元符號結束;
2.代碼中的命名不能是拼音或者英文混合,盡量不要使用純拼音
3.類名駝峰原則 UserManagerServiceImpl (第一個word首字母大寫)
4.方法駝峰原則 addUserInfo(第一個word首字母小寫)
5.常量名全部大寫 單詞之間用_隔開
6.抽象類 使用 Abstract 和 Base 開頭 異常類使用Exception結尾 測試類以測試的類的名字為開頭 以Test為結尾
7.數組定義 String[] args
8.POJO類 及普通的Java beans 中的布爾型常量 定義的時候 命名不要以is開頭 例如isSure等
9.包名統一使用 小寫 點分隔符之間有且僅有一個自然語義的英語單詞 ,包名統一使用單數形式 但如果類名中存在復數含義 類名可以使用復數形式
10.杜絕 完全不規范的縮寫 例如 Contribution 縮寫成Cont
11.為了保證代碼良好的可閱性 盡可能使用完整的單詞來表達其意
12.如果模塊 接口 類 中使用了設計模式 應該在命名中體現設計模式 提高可閱性
13.接口類的方法和屬性 不要添加任何 修飾符號 (public也不要加)保持代碼的簡潔性 加上有效的java doc 注釋 ,盡量不要在接口中定義變量 如果必須 則一定是與接口方法有關 且一定跟整個應用有關
14.接口和實現類
1.強制 對於Service 和 Dao類 基於SOA(面向服務架構)的理念 暴露出來的一定是接口 內部的實現類 用Impl的后綴 與接口區別
2.如果是形容能力的接口名稱 取對應的形容詞做接口名(通常是able形式) 如AbstractTranslator實現 TransLatable
15.枚舉類名建議加上 Enum后綴 枚舉成員名稱 需要全大寫 單詞間用下划線 隔開
16.Service/Dao層方法命名公約
A. Service/Dao層
1.獲取單個對象用 get做前綴
2.獲取多個對象用list做前綴
3.獲取統計值用count做前綴
4.插入的方法用save/insert做前綴
5.刪除的方法用remove/delete做前綴
6.修改的方法用update做前綴
B.領域模型命名規約
1.數據對象: xxxDO xxx一般為數據表名
2.數據傳輸對象: xxxDTO xxx為業務相關領域的名稱
3.展示對象:xxxVO xxx一般為網頁名稱
4.POJO是DO/DTO/BO/VO的統稱 禁止命名為 xxxPOJO