Java開發相關命名規范


一、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

二、數據庫命名規范

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

三、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前綴了。)

四、注釋規范

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

五、版本控制工具提交信息規范

第1行:提交修改內容的摘要(少於25個漢字,或英文大寫字母開始,不加句號,使用祈使句)。
第2行:空行
第3行及以后:修改的理由(36個漢字左右換行,正文解釋是什么和為什么,而不是如何做)。

備注

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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM