枚舉的接口命名規則?
1.[強制] 代碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束.
2.[強制] 代碼中的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式.
3.[強制] 類名使用UpperCamelCase風格,必須遵守駝峰命名的形式.
4.[強制] 方法名、參數名、成員變量、局部變量同意使用lowerCamelCase風格,必須遵守駝峰命名的形式.
5.[強制] 常量命名全部大寫,單子間使用下劃線隔開,力求語義表達完整.
6.[強制] 抽象類命名使用Abstract或Base開頭;異常類名使用Exception結尾;測試類命名以被測試的類名開頭以Test結尾.
7.[強制] POJO類中不二類型的變量,都不要加is,否則部分框架解析會引起序列化錯誤.
8.[強制] 包名統一使用小寫,點分隔符之間僅有一個自然語義的英文單詞.包名統一使用單數形式,但是類名如果有復數含義可以使用復數形式.
9.[強制] 杜絕完全不規范的縮寫,避免望文不知意.
10.[推薦] 模塊、接口、類、方法使用了設計模式,在命名時體現出具體模式。將設計模式體現在名字中,有利于閱讀者快速理解架構設計理念.
11.[推薦] 接口類中的方法和屬性不要加任何修飾符號,保持代碼的簡潔性,并加上有效的javadoc注釋.盡量不要在接口里定義變量,如果一定要
定義變量肯定是與接口方法相關,并且是整個應用的基礎常量.
12.[推薦] 接口和實現類的命名有兩套規則:
1).[強制] 對于Service和DAO類,基于SOA的理念,暴露出來的服務一定是接口,內部的實現類用Impl的后綴與接口區別.
2).[推薦] 如果是形容能力的接口名稱,去對應的形容詞做接口名(通常是-able的形式)
13.[參考] 枚舉類名建議帶上Enum后綴,枚舉成員名稱需要全大寫,單詞間用下劃線隔開.枚舉其實是特殊的常量類,且構造方法被默認強制私有.
14.各層命名規范:
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