命名風(fēng)格

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

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

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

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

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

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

3、【強(qiáng)制】類名使用 UpperCamelCase 風(fēng)格，但以下情形例外：DO / BO / DTO / VO / AO/ PO / UID 等。

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

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

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

正例： localValue / getHttpMessage() / inputUserId

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

正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

反例：MAX_COUNT / EXPIRED_TIME

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

7、【強(qiáng)制】類型與中括號(hào)緊挨相連來(lái)表示數(shù)組。

正例：定義整形數(shù)組 int[] arrayDemo;

反例：在 main 參數(shù)中，使用 String args[]來(lái)定義。

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

說明：在本文 MySQL 規(guī)約中的建表約定第一條，表達(dá)是與否的值采用 is_xxx的命名方式，所以，需要在<resultMap>設(shè)置從 is_xxx 到 xxx 的映射關(guān)系。

反例：定義為基本數(shù)據(jù)類型 Boolean isDeleted 的屬性，它的方法也是 isDeleted()，RPC 框架在反向解析的時(shí)候，“誤以為”對(duì)應(yīng)的屬性名稱是 deleted，導(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.ai.util、類名為 MessageUtils（此規(guī)則參考 spring 的框架結(jié)構(gòu)）

10、【強(qiáng)制】避免在子父類的成員變量之間、或者不同代碼塊的局部變量之間采用完全相同的命名，使可讀性降低。

說明：子類、父類成員變量名相同，即使是 public 類型的變量也是能夠通過編譯，而局部變量在同一方法內(nèi)的不同代碼塊中同名也是合法的，但是要避免使用。對(duì)于非 setter/getter 的參數(shù)名稱也要避免與成員變量名稱相同。

反例：

public class ConfusingName {
 
  public int age;
 
  // 非 setter/getter 的參數(shù)名稱，不允許與本類成員變量同名 
  public void getData(String alibaba) {
 
    if(condition) {
 
      final int money = 531;
 
    // ...
 
    }
 
    for (int i = 0; i < 10; i++) {
 
    // 在同一方法體中，不允許與其它代碼塊中的 money 命名相同
 
    final int money = 615;
 
    // ...
 
    } 
  }
 
}
 
class Son extends ConfusingName {
 
// 不允許與父類的成員變量名稱相同 public int age;
 
}

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

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

12、【推薦】為了達(dá)到代碼自解釋的目標(biāo)，任何自定義編程元素在命名時(shí)，使用盡量完整的單詞組合來(lái)表達(dá)其意。

正例：在 JDK 中，表達(dá)原子更新的類名為：AtomicReferenceFieldUpdater。

反例：int a 的隨意命名方式。

13、【推薦】在常量與變量的命名時(shí)，表示類型的名詞放在詞尾，以提升辨識(shí)度。

正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

14、【推薦】如果模塊、接口、類、方法使用了設(shè)計(jì)模式，在命名時(shí)需體現(xiàn)出具體模式。

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

正例：

public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

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

正例：接口方法簽名 void commit();接口基礎(chǔ)常量 String COMPANY = "alibaba";

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

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

16、接口和實(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 接口。

17、【參考】枚舉類名帶上 Enum 后綴，枚舉成員名稱需要全大寫，單詞間用下劃線隔開。

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

正例：枚舉名字為 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON。

18、【參考】各層命名規(guī)約：

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

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

2） 獲取多個(gè)對(duì)象的方法用 list 做前綴，復(fù)數(shù)形式結(jié)尾如：listObjects。

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。

常量定義

1、【強(qiáng)制】不允許任何魔法值（即未經(jīng)預(yù)先定義的常量）直接出現(xiàn)在代碼中。

反例：

String key = "Id#taobao_" + tradeId;

cache.put(key, value);

// 緩存 get 時(shí)，由于在代碼復(fù)制時(shí)，漏掉下劃線，導(dǎo)致緩存擊穿而出現(xiàn)問題

2、【強(qiáng)制】在 long 或者 Long 賦值時(shí)，數(shù)值后使用大寫的 L，不能是小寫的 l，小寫容易跟數(shù)字 1 混淆，造成誤解。

說明：Long a = 2l; 寫的是數(shù)字的 21，還是 Long 型的 2。

3、【推薦】不要使用一個(gè)常量類維護(hù)所有常量，要按常量功能進(jìn)行歸類，分開維護(hù)。

說明：大而全的常量類，雜亂無(wú)章，使用查找功能才能定位到修改的常量，不利于理解和維護(hù)。

正例：緩存相關(guān)常量放在類 CacheConsts 下；系統(tǒng)配置相關(guān)常量放在類 ConfigConsts 下。

4、【推薦】常量的復(fù)用層次有五層：跨應(yīng)用共享常量、應(yīng)用內(nèi)共享常量、子工程內(nèi)共享常量、

包內(nèi)共享常量、類內(nèi)共享常量。

1） 跨應(yīng)用共享常量：放置在二方庫(kù)中，通常是 client.jar 中的 constant 目錄下。

2） 應(yīng)用內(nèi)共享常量：放置在一方庫(kù)中，通常是子模塊中的 constant 目錄下。

反例：易懂變量也要統(tǒng)一定義成應(yīng)用內(nèi)共享常量，兩位工程師在兩個(gè)類中分別定義了“YES”的變量：

類 A 中：public static final String YES = "yes";

類 B 中：public static final String YES = "y";

A.YES.equals(B.YES)，預(yù)期是 true，但實(shí)際返回為 false，導(dǎo)致線上問題。

3） 子工程內(nèi)部共享常量：即在當(dāng)前子工程的 constant 目錄下。

4） 包內(nèi)共享常量：即在當(dāng)前包下單獨(dú)的 constant 目錄下。

5） 類內(nèi)共享常量：直接在類內(nèi)部 private static final 定義。

5【推薦】如果變量值僅在一個(gè)固定范圍內(nèi)變化用 enum 類型來(lái)定義。

說明：如果存在名稱之外的延伸屬性應(yīng)使用 enum 類型，下面正例中的數(shù)字就是延伸信息，表示一年中的

第幾個(gè)季節(jié)。

正例：

public enum SeasonEnum {
 
  SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
 
  private int seq; 
  SeasonEnum(int seq) {this.seq = seq;}
  public int getSeq() {return seq;}
 
}
 

代碼格式

1、【強(qiáng)制】如果是大括號(hào)內(nèi)為空，則簡(jiǎn)潔地寫成{}即可，大括號(hào)中間無(wú)需換行和空格；如果是非空代碼塊則：

1） 左大括號(hào)前不換行。

2） 左大括號(hào)后換行。

3） 右大括號(hào)前換行。

4） 右大括號(hào)后還有 else 等代碼則不換行；表示終止的右大括號(hào)后必須換行。

2、左小括號(hào)和字符之間不出現(xiàn)空格；同樣，右小括號(hào)和字符之間也不出現(xiàn)空格；而左大括號(hào)前需要空格。詳見第 5 條下方正例提示。

反例：if (空格 a == b 空格)

3、【強(qiáng)制】if/for/while/switch/do 等保留字與括號(hào)之間都必須加空格。

4、【強(qiáng)制】任何二目、三目運(yùn)算符的左右兩邊都需要加一個(gè)空格。

說明：運(yùn)算符包括賦值運(yùn)算符=、邏輯運(yùn)算符&&、加減乘除符號(hào)等。

5、【強(qiáng)制】采用 4 個(gè)空格縮進(jìn)，禁止使用 tab 字符。

說明：如果使用 tab 縮進(jìn)，必須設(shè)置 1 個(gè) tab 為 4 個(gè)空格。IDEA 設(shè)置 tab 為 4 個(gè)空格時(shí)，請(qǐng)勿勾選 Use tab character；而在 eclipse 中，必須勾選 insert spaces for tabs。

正例： （涉及 1-5 點(diǎn)）

public static void main(String[] args) {

// 縮進(jìn) 4 個(gè)空格 String say = "hello";

// 運(yùn)算符的左右必須有一個(gè)空格 int flag = 0;

// 關(guān)鍵詞 if 與括號(hào)之間必須有一個(gè)空格，括號(hào)內(nèi)的 f 與左括號(hào)，0 與右括號(hào)不需要空格 if (flag == 0) {

System.out.println(say); }

// 左大括號(hào)前加空格且不換行；左大括號(hào)后換行 if (flag == 1) {

 System.out.println("world");

// 右大括號(hào)前換行，右大括號(hào)后有 else，不用換行

} else {

System.out.println("ok");

// 在右大括號(hào)后直接結(jié)束，則必須換行 }

}

6、【強(qiáng)制】注釋的雙斜線與注釋內(nèi)容之間有且僅有一個(gè)空格。

正例：

// 這是示例注釋，請(qǐng)注意在雙斜線之后有一個(gè)空格 String param = new String();

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。