1.【強制】不能以 _ $開始 或結束
2.【強制】嚴禁使用 拼音和英文混合,或中文。即使是純拼音也要避免使用。除非是國際通用的例如taobao youku 等。
3.【強制】類名 必須遵從駝峰形式UpperCamelCase,除了DO/BO/DTO/VO/AO.
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【強制】方法名、參數名、成員變量、局部變量 都統一使用lowerCamelCase風格,必須遵從駝峰形式。
正例: localValue / getHttpMessage() / inputUserId
5. 【強制】常量命名全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。
正例: MAX_STOCK_COUNT
反例: MAX_COUNT
6. 【強制】抽象類命名使用Abstract或Base開頭;異常類命名使用Exception結尾;測試類命名以它要測試的類的名稱開始,以Test結尾。
7. 【強制】中括号是數組類型的一部分,數組定義如下:String[] args; 反例:使用String args[]的方式來定義。
8. 【強制】POJO類中布爾類型的變量,都不要加is,否則部分架構解析會引起序列化錯誤。
反例:定義為基本資料類型Boolean isDeleted;的屬性,它的方法也是isDeleted(),RPC
架構在反向解析的時候,“以為”對應的屬性名稱是deleted,導緻屬性擷取不到,進而抛出異常。
9. 【強制】包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用單數形式,但是類名如果有複數含義,類名可以使用複數形式。
正例: 應用工具類包名為com.alibaba.open.util、類名為MessageUtils(此規則參考spring的架構結構)
10. 【強制】杜絕完全不規範的縮寫,避免望文不知義。
反例: AbstractClass“縮寫”命名成AbsClass;condition“縮寫”命名成 condi,此類随意縮寫嚴重降低了代碼的可閱讀性。
11. 【推薦】如果使用到了設計模式,建議在類名中展現出具體模式。 說明:将設計模式展現在名字中,有利于閱讀者快速了解架構設計思想。
正例:public class OrderFactory; public class LoginProxy; public class ResourceObserver;
12. 【推薦】接口類中的方法和屬性不要加任何修飾符号(public 也不要加),保持代碼的簡潔性,并加上有效的Javadoc注釋。盡量不要在接口裡定義變量,如果一定要定義變量,肯定是與接口方法相關,并且是整個應用的基礎常量。
正例:接口方法簽名:void f(); 接口基礎常量表示:String COMPANY = "alibaba";
反例:接口方法定義:public abstract void f(); 說明:JDK8中接口允許有預設實作,那麼這個default方法,是對所有實作類都有價值的預設實作。
13. 接口和實作類的命名有兩套規則:
1)【強制】對于Service和DAO類,基于SOA的理念,暴露出來的服務一定是接口,内部的實作類用Impl的字尾與接口差別。
正例:CacheServiceImpl實作CacheService接口。
2) 【推薦】 如果是形容能力的接口名稱,取對應的形容詞做接口名(通常是–able的形式)。 正例:AbstractTranslator實作 Translatable。
14. 【參考】枚舉類名建議帶上Enum字尾,枚舉成員名稱需要全大寫,單詞間用下劃線隔開。
說明:枚舉其實就是特殊的常量類,且構造方法被預設強制是私有。
正例:枚舉名字:DealStatusEnum,成員名稱:SUCCESS / UNKOWN_REASON。
15. 【參考】各層命名規約:
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。