1.規范存在的意義:
好的編碼規范可以盡可能的減少一個軟件的維護成本 , 并且幾乎沒有任何一個軟件,在其整個生命周期中,均由最初的開發人員來維護;
好的編碼規范可以改善軟件的可讀性,可以讓開發人員盡快而徹底地理解新的代碼;好的編碼規范可以最大限度的提高團隊開發的合作效率;
長期的規范性編碼還可以讓開發人員養成好的編碼習慣,甚至鍛煉出更加嚴謹的思維;
2.命名規范:
盡量使用完整的英文描述符
采用適用于相關領域的術語
采用大小寫混合使名字可讀
盡量少用縮寫,但如果用了,必須符合整個工程中的統一定義
避免使用長的名字(小于 15 個字母為正常選擇)
避免使用類似的名字,或者僅僅是大小寫不同的名字
避免使用下劃線(除靜態常量等)
所有Pojo類與數據庫表名對應
所有Dao接口類繼承自BaseDao,以I打頭,以pojo類名稱+Dao結束
所有Daoimpl實現類以pojo類名稱+DaoImpl結束
所有業務接口類以I打頭,以業務名稱+Service結束
所有業務實現類:業務名稱+Service;
3.標識符類型說明:
包( Package )的命名:
采用完整的英文描述符,都是由一個小寫單詞組成
類( Class )的命名:
類名應該是個一名詞,采用大小寫混合的方式,每個單詞的首字母大寫。盡量保證類名簡潔而富于描述。使用完整單詞,避免縮寫詞 ( 除非工程內有統一縮寫規范或該縮寫詞被更廣泛使用
接口( Interface )的命名:
基本與 Class 的命名規范類似。在滿足 Classd 命名規則的基礎之上,保證開頭第一個字母為”I”,便于與普通的 Class區別開
枚舉( Enum )的命名
異常( Exception )的命名
方法( Method )的命名
在service中,操作數據庫更新、寫入、刪除,方法名以update、save、edit、add、move、delet、remove打頭,保證spring事務托管的有效;對數據的查詢采用 list、get、find打頭;
一般方法遵循:
方法名是一個動詞,采用大小寫混合的方式,第一個單詞的首字母小寫,其后單詞的首字母大寫。方法名盡可能的描述出該方法的動作行為。返回類型為 Boolean 值的方法一般由“ is ”或“ has ”來開頭例如:返回類型為 Boolean 值:用“ is ”或“ has ”來開頭
得到某數據: get+ 數據描述名詞復數 + 數據類型;
得到所有數據: get+All+ 數據描述名詞復數 + 數據類型;
通過 XXX 得到 / 查詢某數據: get/query+ 數據描述名詞復數 + 數據類型 +By+ 條件;
添加某數據: save/add+ 數據描述名詞 ()
更新某數據: save/update+ 數據描述名詞;
刪除某數據: delete/remove+ 數據描述名詞;
參數( Param )的命名:
第一個單詞的首字母小寫,其后單詞的首字母大寫。參數量名不允許以下劃線或美元符號開頭,雖然這在語法上是允許的。參數名應簡短且富于描述。
常量字段( Constants )的命名:
靜態常量字段( static final )全部采用大寫字母,單詞之間用下劃線分隔;