命名規約


1. 【強制】 程式碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束。

反例: _name / __name / $Object / name_ / name$ / Object$

2. 【強制】 程式碼中的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式。

說明:正確的英文拼字和文法可以讓閱讀者易於理解,避免歧義。注意,即使純拼音命名方式也要避免採用。

反例:  DaZhePromotion [ 折扣] /  getPingfenByName() [ 評分] /  int 某變數= 3

#。例:  alibaba /  taobao /  youku /  hangzhou 等國際通用的名稱,視同英文。

3. 【強制】類別名稱使用 UpperCamelCase 風格,必須遵從駝峰形式,但以下情況例外: ( 領域模型的相關命名 )DO /  BO  /  DTO /  VO 等。

正例: MarcoPolo /  UserDO /  XmlService /  TcpUdpDeal /  TaPromotion

反例: macroPolo /  UserDo /PTC

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 isSuccess; 的屬性,它的方法也是isSuccess() , RPC框架在反向解析的時候,「為」對應的屬性名稱是success ,導致屬性取得不到,進而拋出異

#常。

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();

說明: JDK 8 中介面允許有默認實現,那麼這個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 。