Java開發相關命名規範

1、JAVA文件命名規範

1.類命名

抽象類以 Abstract 或者 Base 開頭。
異常類以 Exception 做爲後綴。
枚舉類以 Enum 做爲後綴。
工具類以 Utils 做爲後綴(相應的包名最後以 .util 結尾)。
常量類以 Consts 做爲後綴(相應的包名最後以 .constant 結尾)。
形容能力的接口使用 able 做爲後綴。
實現類與接口用後綴 Impl 區別。
數據類：表名(首字母大寫) + DO。
傳輸類：領域相關名 + DTO。
展現類：頁面名稱 + VO。

2.service/dao層方法命名

獲取單個對象的方法用 get 作前綴。
獲取多個對象的方法用 list 作前綴。
獲取統計值的方法用 count 作前綴。
插入的方法用 save 作前綴。
刪除的方法用 remove 作前綴。
修改的方法用 update 作前綴。

3.變量的命名規範

第一個單詞的首字母小寫，其後單詞的首字母大寫 例如：maxValue。
變量名不該如下劃線或美圓符號開頭，儘管這在語法上是容許的。變量名應簡短且富於描述。變量名的選用應該易於記憶，即，可以指出其用途。儘可能避免單個字符的變量名，除非是一次性的臨時變量。
pojo中的布爾變量，都不要加is(數據庫中的布爾字段全都要加 is_ 前綴)。

4.常量/枚舉值的命名規範

常量名/枚舉值應該都使用大寫字母，下劃線分割單詞。
例如：MAX_VALUE

2、數據庫命名規範

表名和字段名字必須用小寫字母或數字，數字不可開頭，兩個下劃線中間不能只有數字。
庫名與應用名儘可能一致。
表名：業務名稱_表的做用(單數形式)。
主鍵索引：pk_字段名。
惟一索引：uk_字段名。
普通索引：idx_字段名。
表示是否字段：is_xxxx unsigned tinyint(1.表示是，0.表示否)。
觸發器：trg_表名_[ insert | update | delete ]
視圖：viw_相關表名1_相關表名2_...
數據庫禁止用存儲過程。

3、JUnit單元測試命名規範

1.測試類的命名規範

類的命名規則是：被測試的業務 + Test、被測試的接口 + Test、被測試的類 + Test。
類的名字必須由大寫字母開頭而其餘字母均爲小寫；若是類名稱由多個單詞組成，則每一個單詞的首字母均應爲大寫，如MobileBindTest。若是類名稱中包含單詞縮寫，則這個所寫詞的每一個字母均應大寫，如：XMLExample。

2.被測方法的命名規範

test + 被測方法_測試時所處狀態 或者 test + 被測方法_具體測試方法。
好比要測試的用例是「數據庫用戶信息不存在時,獲取Mobile綁定消息」，那麼它的測試用例名稱就是testSetMobileBind_NoSkyid。
​好比要測試的方法是findParam，採用的是邊界值方法，那麼它的測試用例名稱能夠是testFindParam_Boundaries。

3.測試包命名規範

被測試類的包名前加上「test.」 。被測試類的包名是com.wistrons.util，那麼測試類的包名就是test.com.wistrons.util。
(經過maven構建項目，默認狀況家已經建好了test文件夾，不須要再包前面加上test前綴了。)

4、註釋規範

註釋不是必須的，語義清晰的代碼不須要註釋。
類、類屬性、類方法必須使用 Javadoc 註釋。
類註釋至少標明做用、建立者和建立日期。
抽象方法必須使用 Javadoc 註釋，至少標明功能(參數、返回值、異常、子類的實現要求等可斟酌加上)。
枚舉值必須有註釋，建議用段落註釋(使用/*內容*/格式)。
修改代碼同時，註釋也要作相應的修改。

5、版本控制工具提交信息規範

第1行：提交修改內容的摘要(少於25個漢字，或英文大寫字母開始，不加句號，使用祈使句)。
第2行：空行
第3行及之後：修改的理由(36個漢字左右換行，正文解釋是什麼和爲何，而不是如何作)。

備註

部分參考自《阿里巴巴Java開發手冊v1.2.0》。不一樣公司的命名規範還應該根據各自公司內部要求來制定。以上只是提供一個參考。