命名規(guī)約

1. 【強(qiáng)制】 代碼中的命名均不能以下劃線或美元符號(hào)開(kāi)始，也不能以下劃線或美元符號(hào)結(jié)束。

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

2. 【強(qiáng)制】 代碼中的命名嚴(yán)禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。

說(shuō)明：正確的英文拼寫和語(yǔ)法可以讓閱讀者易于理解，避免歧義。注意，即使純拼音命名方式也要避免采用。

反例：  DaZhePromotion [ 打折 ] /  getPingfenByName() [ 評(píng)分 ] /  int 某變量 = 3

正例：  alibaba /  taobao /  youku /  hangzhou 等國(guó)際通用的名稱，可視同英文。

3. 【強(qiáng)制】類名使用 UpperCamelCase 風(fēng)格，必須遵從駝峰形式，但以下情形例外： （ 領(lǐng)域模型的相關(guān)命名 ）DO /  BO  /  DTO /  VO 等。

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

反例： macroPolo /  UserDo /  XMLService /  TCPUDPDeal /  TAPromotion

4. 【強(qiáng)制】方法名、參數(shù)名、成員變量、局部變量都統(tǒng)一使用 lowerCamelCase 風(fēng)格，必須遵從駝峰形式。

正例：  localValue /  getHttpMessage() /  inputUserId

5. 【強(qiáng)制】常量命名全部大寫，單詞間用下劃線隔開(kāi)，力求語(yǔ)義表達(dá)完整清楚，不要嫌名字長(zhǎng)。

正例：  MAX _ STOCK _ COUNT

反例：  MAX _ COUNT

6. 【強(qiáng)制】抽象類命名使用 Abstract 或 Base 開(kāi)頭 ； 異常類命名使用 Exception 結(jié)尾 ； 測(cè)試類命名以它要測(cè)試的類的名稱開(kāi)始，以 Test 結(jié)尾。

7. 【強(qiáng)制】中括號(hào)是數(shù)組類型的一部分，數(shù)組定義如下： String[] args;

反例：請(qǐng)勿使用 String args[] 的方式來(lái)定義。

8. 【強(qiáng)制】 POJO 類中布爾類型的變量，都不要加 is ，否則部分框架解析會(huì)引起序列化錯(cuò)誤。

反例：定義為基本數(shù)據(jù)類型 boolean isSuccess； 的屬性，它的方法也是 isSuccess() ， RPC框架在反向解析的時(shí)候，“為”對(duì)應(yīng)的屬性名稱是 success ，導(dǎo)致屬性獲取不到，進(jìn)而拋出異

常。

9. 【強(qiáng)制】包名統(tǒng)一使用小寫，點(diǎn)分隔符之間有且僅有一個(gè)自然語(yǔ)義的英語(yǔ)單詞。包名統(tǒng)一使用單數(shù)形式，但是類名如果有復(fù)數(shù)含義，類名可以使用復(fù)數(shù)形式。

正例： 應(yīng)用工具類包名為 com . alibaba . open . util 、類名為 MessageUtils（ 此規(guī)則參考spring 的框架結(jié)構(gòu) ）

10. 【強(qiáng)制】杜絕完全不規(guī)范的縮寫，避免望文不知義。

反例：  AbstractClass “縮寫”命名成 AbsClass；condition “縮寫”命名成  condi ，此類隨意縮寫嚴(yán)重降低了代碼的可閱讀性。

11. 【推薦】如果使用到了設(shè)計(jì)模式，建議在類名中體現(xiàn)出具體模式。

說(shuō)明：將設(shè)計(jì)模式體現(xiàn)在名字中，有利于閱讀者快速理解架構(gòu)設(shè)計(jì)思想。

正例： public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

12. 【推薦】接口類中的方法和屬性不要加任何修飾符號(hào) （public 也不要加 ） ，保持代碼的簡(jiǎn)潔性，并加上有效的 Javadoc 注釋。盡量不要在接口里定義變量，如果一定要定義變量，肯定是與接口方法相關(guān)，并且是整個(gè)應(yīng)用的基礎(chǔ)常量。

正例：接口方法簽名： void f();

接口基礎(chǔ)常量表示： String COMPANY = " alibaba " ;

反例：接口方法定義： public abstract void f();

說(shuō)明： JDK 8 中接口允許有默認(rèn)實(shí)現(xiàn)，那么這個(gè) default 方法，是對(duì)所有實(shí)現(xiàn)類都有價(jià)值的默認(rèn)實(shí)現(xiàn)。

13. 接口和實(shí)現(xiàn)類的命名有兩套規(guī)則：

1 ） 【強(qiáng)制】對(duì)于 Service 和 DAO 類，基于 SOA 的理念，暴露出來(lái)的服務(wù)一定是接口，內(nèi)部的實(shí)現(xiàn)類用 Impl 的后綴與接口區(qū)別。

正例： CacheServiceImpl 實(shí)現(xiàn) CacheService 接口。

2 ）  【推薦】 如果是形容能力的接口名稱，取對(duì)應(yīng)的形容詞做接口名 （ 通常是– able 的形式 ） 。

正例： AbstractTranslator 實(shí)現(xiàn)  Translatable 。

14. 【參考】枚舉類名建議帶上 Enum 后綴，枚舉成員名稱需要全大寫，單詞間用下劃線隔開(kāi)。

說(shuō)明：枚舉其實(shí)就是特殊的常量類，且構(gòu)造方法被默認(rèn)強(qiáng)制是私有。

正例：枚舉名字： DealStatusEnum， 成員名稱： SUCCESS /  UNKOWN _ REASON 。

15. 【參考】各層命名規(guī)約：

A) Service / DAO 層方法命名規(guī)約

1 ） 獲取單個(gè)對(duì)象的方法用 get 做前綴。

2 ） 獲取多個(gè)對(duì)象的方法用 list 做前綴。

3 ） 獲取統(tǒng)計(jì)值的方法用 count 做前綴。

4 ） 插入的方法用 save（ 推薦 ） 或 insert 做前綴。

5 ） 刪除的方法用 remove（ 推薦 ） 或 delete 做前綴。

6 ） 修改的方法用 update 做前綴。

B) 領(lǐng)域模型命名規(guī)約

1 ） 數(shù)據(jù)對(duì)象： xxxDO ， xxx 即為數(shù)據(jù)表名。

2 ） 數(shù)據(jù)傳輸對(duì)象： xxxDTO ， xxx 為業(yè)務(wù)領(lǐng)域相關(guān)的名稱。

3 ） 展示對(duì)象： xxxVO ， xxx 一般為網(wǎng)頁(yè)名稱。

4 ） POJO 是 DO / DTO / BO / VO 的統(tǒng)稱，禁止命名成 xxxPOJO 。