阿里巴巴Java開發規範手冊

阿里巴巴 JAVA 開發手冊 

 1 / 32 

Java 開發手冊 

版本號 制定團隊 更新日期 備  注 

1.0.0 阿里巴巴集團技術部 2016.12.7 首次向 Java 業界公開 

  一、程式設計規約 

(一) 命名規約 

1. 【強制】所有程式設計相關命名均不能以下劃線或美元符號開始，也不能以下劃線或美元符號結束。

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

2. 【強制】所有程式設計相關的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。

 說明：正確的英文拼寫和語法可以讓閱讀者易於理解，避免歧義。注意，即使純拼音命名方式

也要避免採用。 

反例： DaZhePromotion [打折] / getPingfenByName() [評分] / int 變數 = 3; 

正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等國際通用的

名稱，可視為英文。 

3. 【強制】類名使用 UpperCamelCase 風格，必須遵從駝峰形式，但以下情形例外：（領域模型 的相關命名）DO / DTO / VO / DAO 等。 我剛整理了一套2018最新的0基礎入門和進階教程，無私分享，加Java學習裙 ：678-241-563 即可獲取，內附：開發工具和安裝包，以及系統學習路線圖

正例：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 結尾。 

阿里巴巴 JAVA 開發手冊 

 2 / 32 

7. 【強制】中括號是陣列型別的一部分，陣列定義如下：String[] args; 反例：請勿使用 String args[]的方式來定義 

8. 【強制】POJO 類中的任何布林型別的變數，都不要加 is，否則部分框架解析會引起序列化錯

誤。 

反例：定義為基本資料型別 boolean isSuccess；的屬性，它的方法也是 isSuccess()，RPC

框架在反向解析的時候，“以為”對應的屬性名稱是 success，導致屬性獲取不到，進而丟擲

異常。 

9. 【強制】包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用 單數形式，但是類名如果有複數含義，類名可以使用複數形式。 

正例： 應用工具類包名為 com.alibaba.mpp.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 介面。 

阿里巴巴 JAVA 開發手冊 

 3 / 32 

 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。 

(二) 常量定義 

1. 【強制】不允許出現任何魔法值（即未經定義的常量）直接出現在程式碼中。 

反例： String key="Id#taobao_"+tradeId； 

    cache.put(key, value); 

2. 【強制】long 或者 Long 初始賦值時，必須使用大寫的 L，不能是小寫的 l，小寫容易跟數字 1 混淆，造成誤解。 

說明：Long a = 2l; 寫的是數字的 21，還是 Long 型的 2? 

3. 【推薦】不要使用一個常量類維護所有常量，應該按常量功能進行歸類，分開維護。如：快取 相關的常量放在類：CacheConsts 下；系統配置相關的常量放在類：ConfigConsts 下。 

說明：大而全的常量類，非得 ctrl+f 才定位到修改的常量，不利於理解，也不利於維護。 

阿里巴巴 JAVA 開發手冊 

 4 / 32 

4. 【推薦】常量的複用層次有五層：跨應用共享常量、應用內共享常量、子工程內共享常量、包

內共享常量、類內共享常量。 

 1） 跨應用共享常量：放置在二方庫中，通常是 client.jar 中的 const 目錄下。 

 2） 應用內共享常量：放置在一方庫的 modules 中的 const 目錄下。 

  反例：易懂變數也要統一定義成應用內共享常量，兩位攻城師在兩個類中分別定義了表示

“是”的變數： 

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

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

    A.YES.equals(B.YES)，預期是 true，但實際返回為 false，導致產生線上問題。 

 3） 子工程內部共享常量：即在當前子工程的 const 目錄下。 

 4） 包內共享常量：即在當前包下單獨的 const 目錄下。 

 5） 類內共享常量：直接在類內部 private static final 定義。 

5. 【推薦】如果變數值僅在一個範圍內變化用 Enum 類。如果還帶有名稱之外的延伸屬性，必須 使用 Enum 類，下面正例中的數字就是延伸資訊，表示星期幾。 

正例：public Enum{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), 

SATURDAY(6), SUNDAY(7);} 

(三) 格式規約 

1. 【強制】大括號的使用約定。如果是大括號內為空，則簡潔地寫成{}即可，不需要換行；如果 是非空程式碼塊則： 

 1） 左大括號前不換行。 

 2） 左大括號後換行。 

 3） 右大括號前換行。 

 4） 右大括號後還有 else 等程式碼則不換行；表示終止右大括號後必須換行。 

2. 【強制】 左括號和後一個字元之間不出現空格；同樣，右括號和前一個字元之間也不出現空 格。詳見第 5 條下方正例提示。 

3. 【強制】if/for/while/switch/do 等保留字與左右括號之間都必須加空格。 

4. 【強制】任何運算子左右必須加一個空格。 說明：運算子包括賦值運算子=、邏輯運算子&&、加減乘除符號、三目執行符等。 

5. 【強制】程式碼塊縮排 4 個空格，如果使用 tab 縮排，請設定成 1 個 tab 為 4 個空格。 正例： （涉及 1-5 點） 

阿里巴巴 JAVA 開發手冊 

 5 / 32 

public static void main(String args[]) {      // 縮排 4 個空格      String say = "hello";      // 運算子的左右必須有一個空格      int flag = 0;     // 關鍵詞 if 與括號之間必須有一個空格，括號內 f 與左括號，1 與右括號不需要空格      if (flag == 0) {          System.out.println(say);      }               // 左大括號前加空格且不換行；左大括號後換行      if (flag == 1) {          System.out.println("world");      // 右大括號前換行，右大括號後有 else，不用換行      } else {            System.out.println("ok");      // 右大括號做為結束，必須換行      }  }  6. 【強制】單行字元數限制不超過 120 個，超出需要換行，換行時，遵循如下原則：  1） 換行時相對上一行縮排 4 個空格。 

 2） 運算子與下文一起換行。 

 3） 方法呼叫的點符號與下文一起換行。 

 4） 在多個引數超長，逗號後進行換行。 

 5） 在括號前不要換行，見反例。 

正例： 

StringBuffer sb = new StringBuffer();  //超過 120 個字元的情況下，換行縮排 4 個空格，並且方法前的點符號一起換行  sb.append("zi").append("xin")…     .append("huang");  

反例： 

StringBuffer sb = new StringBuffer();  //超過 120 個字元的情況下，不要在括號前換行  sb.append("zi").append("xin")…append      ("huang");   

//引數很多的方法呼叫也超過 120 個字元，逗號後才是換行處  method(args1, args2, args3, ...      , argsX);  7. 【強制】方法引數在定義和傳入時，多個引數逗號後邊必須加空格。 正例：下例中實參的"a",後邊必須要有一個空格。 

method("a", "b", "c");  

阿里巴巴 JAVA 開發手冊 

 6 / 32 

8. 【推薦】沒有必要增加若干空格來使某一行的字元與上一行的相應字元對齊。 

正例： 

int a = 3;  long b = 4L;  float c = 5F;  StringBuffer sb = new StringBuffer();  說明：增加 sb 這個變數，如果需要對齊，則給 a、b、c 都要增加幾個空格，在變數比較多的

情況下，是一種累贅的事情。 

9. 【強制】IDE 的 text file encoding 設定為 UTF-8; IDE 中檔案的換行符使用 Unix 格式，不 要使用 windows 格式。 

10.【推薦】方法體內的執行語句組、變數的定義語句組、不同的業務邏輯之間或者不同的語義之

間插入一個空行。相同業務邏輯和語義之間不需要插入空行。 

說明：沒有必要插入多行空格進行隔開。 

(四) OOP 規約 

1. 【強制】避免通過一個類的物件引用訪問此類的靜態變數或靜態方法，無謂增加編譯器解析成 本，直接用類名來訪問即可。 

2. 【強制】所有的覆寫方法，必須加@Override 註解。 反例：getObject()與 get0bject()的問題。一個是字母的 O，一個是數字的 0，加@Override

可以準確判斷是否覆蓋成功。另外，如果在抽象類中對方法簽名進行修改，其實現類會馬上編

譯報錯。 

3. 【強制】相同引數型別，相同業務含義，才可以使用 Java 的可變引數，避免使用 Object。 說明：可變引數必須放置在引數列表的最後。（提倡同學們儘量不用可變引數程式設計） 

正例：public User getUsers(String type, Integer... ids);  4. 【強制】對外暴露的介面簽名，原則上不允許修改方法簽名，避免對介面呼叫方產生影響。接 口過時必須加@Deprecated 註解，並清晰地說明採用的新介面或者新服務是什麼。 

5. 【強制】不能使用過時的類或方法。 說明：java.net.URLDecoder 中的方法 decode(String encodeStr) 這個方法已經過時，應該

使用雙引數 decode(String source, String encode)。介面提供方既然明確是過時介面，那

麼有義務同時提供新的介面；作為呼叫方來說，有義務去考證過時方法的新實現是什麼。 

6. 【強制】Object的equals方法容易拋空指標異常，應使用常量或確定有值的物件來呼叫equals。

正例： "test".equals(object); 

阿里巴巴 JAVA 開發手冊 

 7 / 32 

反例： object.equals("test"); 

說明：推薦使用 java.util.Objects#equals （JDK7 引入的工具類） 

7. 【強制】所有的相同型別的包裝類物件之間值的比較，全部使用 equals 方法比較。 

說明：對於 Integer var=?在-128 至 127 之間的賦值，Integer 物件是在 IntegerCache.cache

產生，會複用已有物件，這個區間內的 Integer 值可以直接使用==進行判斷，但是這個區間之

外的所有資料，都會在堆上產生，並不會複用已有物件，這是一個大坑，推薦使用 equals 方

法進行判斷。 

8. 【強制】關於基本資料型別與包裝資料型別的使用標準如下：  1） 所有的 POJO 類屬性必須使用包裝資料型別。 

 2） RPC 方法的返回值和引數必須使用包裝資料型別。 

 3） 所有的區域性變數推薦使用基本資料型別。 

 說明：POJO 類屬性沒有初值是提醒使用者在需要使用時，必須自己顯式地進行賦值，任何

NPE 問題，或者入庫檢查，都由使用者來保證。 

 正例：資料庫的查詢結果可能是 null，因為自動拆箱，用基本資料型別接收有 NPE 風險。 

 反例：某業務的交易報表上顯示成交總額漲跌情況，即正負 x%，x 為基本資料型別，呼叫的

RPC 服務，呼叫不成功時，返回的是預設值，頁面顯示：0%，這是不合理的，應該顯示成中劃

線-。所以包裝資料型別的 null 值，能夠表示額外的資訊，如：遠端呼叫失敗，異常退出。 

9. 【強制】定義 DO/DTO/VO 等 POJO 類時，不要設定任何屬性預設值。 反例：某業務的 DO 的 gmtCreate 預設值為 new Date();但是這個屬性在資料提取時並沒有置

入具體值，在更新其它欄位時又附帶更新了此欄位，導致建立時間被修改成當前時間。 

10.【強制】序列化類新增屬性時，請不要修改 serialVersionUID 欄位，避免反序列失敗；如果

完全不相容升級，避免反序列化混亂，那麼請修改 serialVersionUID 值。 

說明：注意 serialVersionUID 不一致會丟擲序列化執行時異常。 

11.【強制】構造方法裡面禁止加入任何業務邏輯，如果有初始化邏輯，請放在 init 方法中。 

12.【強制】POJO 類必須寫 toString 方法。使用工具類 source> generate toString 時，如果繼

承了另一個 POJO 類，注意在前面加一下 super.toString。 

說明：在方法執行丟擲異常時，可以直接呼叫 POJO 的 toString()方法列印其屬性值，便於排

查問題。 

13. 【推薦】使用索引訪問用 String 的 split 方法得到的陣列時，需做最後一個分隔符後有無內 容的檢查，否則會有拋 IndexOutOfBoundsException 的風險。 

阿里巴巴 JAVA 開發手冊 

 8 / 32 

說明： 

String str = "a,b,c,,"; String[] ary = str.split(",");  //預期大於 3，結果是 3 System.out.println(ary.length);  14.【推薦】當一個類有多個構造方法，或者多個同名方法，這些方法應該按順序放置在一起，便

於閱讀。 

15.【推薦】 類內方法定義順序依次是：公有方法或保護方法 > 私有方法 > getter/setter 方

法。 

說明：公有方法是類的呼叫者和維護者最關心的方法，首屏展示最好；保護方法雖然只是子類

關心，也可能是“模板設計模式”下的核心方法；而私有方法外部一般不需要特別關心，是一

個黑盒實現；因為方法資訊價值較低，所有 Service 和 DAO 的 getter/setter 方法放在類體最

後。 

16. 【推薦】setter 方法中，引數名稱與類成員變數名稱一致，this.成員名=引數名。在 getter/setter 方法中，儘量不要增加業務邏輯，增加排查問題難度。 

反例： 

public Integer getData(){      if(true)  {  return data + 100;  } else  { return data - 100;  }  }  17. 【推薦】迴圈體內，字串的聯接方式，使用 StringBuilder 的 append 方法進行擴充套件。 反例： 

String str = "start";      for(int i=0; i<100; i++){          str = str + "hello";      }  說明：反編譯出的位元組碼檔案顯示每次迴圈都會 new 出一個 StringBuilder 物件，然後進行

append 操作，最後通過 toString 方法返回 String 物件，造成記憶體資源浪費。 

18.【推薦】final 可提高程式響應效率，宣告成 final 的情況： 

 1） 不需要重新賦值的變數，包括類屬性、區域性變數。 

 2） 物件引數前加 final，表示不允許修改引用的指向。 

 3） 類方法確定不允許被重寫。 

19.【推薦】慎用 Object 的 clone 方法來拷貝物件。 

說明：物件的 clone 方法預設是淺拷貝，若想實現深拷貝需要重寫 clone 方法實現屬性物件的

拷貝。 

阿里巴巴 JAVA 開發手冊 

 9 / 32 

20.【推薦】類成員與方法訪問控制從嚴： 

 1） 如果不允許外部直接通過 new 來建立物件，那麼構造方法必須是 private。 

 2） 工具類不允許有 public 或 default 構造方法。 

 3） 類非 static 成員變數並且與子類共享，必須是 protected。  

 4） 類非 static 成員變數並且僅在本類使用，必須是 private。 

 5） 類 static 成員變數如果僅在本類使用，必須是 private。 

 6） 若是 static 成員變數，必須考慮是否為 final。 

 7） 類成員方法只供類內部呼叫，必須是 private。  

 8） 類成員方法只對繼承類公開，那麼限制為 protected。 

說明：任何類、方法、引數、變數，嚴控訪問範圍。過寬泛的訪問範圍，不利於模組解耦。思

考：如果是一個 private 的方法，想刪除就刪除，可是一個 public 的 Service 方法，或者一

個 public 的成員變數，刪除一下，不得手心冒點汗嗎？變數像自己的小孩，儘量在自己的視

線內，變數作用域太大，如果無限制的到處跑，那麼你會擔心的。 

(五) 集合處理 

1. 【強制】Map/Set 的 key 為自定義物件時，必須重寫 hashCode 和 equals。 正例：String 重寫了 hashCode 和 equals 方法，所以我們可以非常愉快地使用 String 物件作

為 key 來使用。 

2. 【強制】ArrayList 的 subList 結果不可強轉成 ArrayList，否則會丟擲 ClassCastException 異常：java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ; 

說明：subList 返回的是 ArrayList 的內部類 SubList，並不是 ArrayList ，而是 ArrayList 

的一個檢視，對於 SubList 子列表的所有操作最終會反映到原列表上。 

3. 【強制】在 subList 場景中，高度注意對原集合元素個數的修改，會導致子列表的遍歷、增加、 刪除均產生 ConcurrentModificationException 異常。 

4. 【強制】使用集合轉陣列的方法，必須使用集合的 toArray(T[] array)，傳入的是型別完全 一樣的陣列，大小就是 list.size()。 

反例：直接使用 toArray 無參方法存在問題，此方法返回值只能是 Object[]類，若強轉其它

型別陣列將出現 ClassCastException 錯誤。 

正例： 

List list = new ArrayList(2);      list.add("guan");      list.add("bao");       String[] array = new String[list.size()];      array = list.toArray(array);  

阿里巴巴 JAVA 開發手冊 

 10 / 32 

說明：使用 toArray 帶參方法，入參分配的陣列空間不夠大時，toArray 方法內部將重新分配

記憶體空間，並返回新陣列地址；如果陣列元素大於實際所需，下標為[ list.size() ]的陣列

元素將被置為 null，其它陣列元素保持原值，因此最好將方法入引數組大小定義與集合元素

個數一致。 

5. 【強制】使用工具類Arrays.asList()把陣列轉換成集合時，不能使用其修改集合相關的方法， 它的 add/remove/clear 方法會丟擲 UnsupportedOperationException 異常。 

說明：asList 的返回物件是一個 Arrays 內部類，並沒有實現集合的修改方法。Arrays.asList

體現的是介面卡模式，只是轉換介面，後臺的資料仍是陣列。 

    String[] str = new String[] { "a", "b" }; 

    List list = Arrays.asList(str); 

第一種情況：list.add("c"); 執行時異常。 

第二種情況：str[0]= "gujin"; 那麼 list.get(0)也會隨之修改。 

6. 【強制】泛型萬用字元來接收返回的資料，此寫法的泛型集合不能使用 add 方法。 

說明：蘋果裝箱後返回一個物件，此物件就不能往裡加任何水果，包括蘋

果。 

7. 【強制】不要在 foreach 迴圈裡進行元素的 remove/add 操作。remove 元素請使用 Iterator 方式，如果併發操作，需要對 Iterator 物件加鎖。 

反例： 

List a = new ArrayList();      a.add("1");      a.add("2");      for (String temp : a) {          if("1".equals(temp)){              a.remove(temp);          }      }  

說明：這個例子的執行結果會出乎大家的意料，那麼試一下把“1”換成“2”，會是同樣的結

果嗎？ 

正例： 

Iterator it = a.iterator();  while(it.hasNext()){              String temp =  it.next();                       if(刪除元素的條件){                              it.remove();                 }      }      

阿里巴巴 JAVA 開發手冊 

 11 / 32 

8. 【強制】在 JDK7 版本以上，Comparator 要滿足自反性，傳遞性，對稱性，不然 Arrays.sort，

Collections.sort 會報 IllegalArgumentException 異常。 

說明： 

 1） 自反性：x，y 的比較結果和 y，x 的比較結果相反。 

 2） 傳遞性：x>y,y>z,則 x>z。 

 3） 對稱性：x=y,則 x,z 比較結果和 y，z 比較結果相同。 

反例：下例中沒有處理相等的情況，實際使用中可能會出現異常： 

new Comparator() {           @Override          public int compare(Student o1, Student o2) {              return o1.getId() > o2.getId() ? 1 : -1;          }      }  9. 【推薦】集合初始化時，儘量指定集合初始值大小。 說明：ArrayList 儘量使用 ArrayList(int initialCapacity) 初始化。 

10.【推薦】使用 entrySet 遍歷 Map 類集合 KV，而不是 keySet 方式進行遍歷。 

說明：keySet 其實是遍歷了 2 次，一次是轉為 Iterator 物件，另一次是從 hashMap 中取出 key

所對應的 value。而 entrySet 只是遍歷了一次就把 key 和 value 都放到了 entry 中，效率更

高。如果是 JDK8，使用 Map.foreach 方法。 

正例：values()返回的是 V 值集合，是一個 list 集合物件；keySet()返回的是 K 值集合，是

一個 Set 集合物件；entrySet()返回的是 K-V 值組合集合。 

11.【推薦】高度注意 Map 類集合 K/V 能不能儲存 null 值的情況，如下表格： 

集合類 Key Value Super 說明 

Hashtable 不允許為 null 不允許為 null Dictionary 執行緒安全 

ConcurrentHashMap 不允許為 null 不允許為 null AbstractMap 執行緒區域性安全 

TreeMap 不允許為 null 允許為 null AbstractMap 執行緒不安全 

HashMap 允許為 null 允許為 null AbstractMap 執行緒不安全 

反例：很多同學認為 ConcurrentHashMap 是可以置入 null 值。在批量翻譯場景中，子執行緒分

發時，出現置入 null 值的情況，但主執行緒沒有捕獲到此異常，導致排查困難。 

12.【參考】合理利用好集合的有序性(sort)和穩定性(order)，避免集合的無序性(unsort)和不

穩定性(unorder)帶來的負面影響。 

阿里巴巴 JAVA 開發手冊 

 12 / 32 

說明：穩定性指集合每次遍歷的元素次序是一定的。有序性是指遍歷的結果是按某種比較規則

依次排列的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是

order/sort。 

13.【參考】利用 Set 元素唯一的特性，可以快速對另一個集合進行去重操作，避免使用 List 的

contains 方法進行遍歷去重操作。 

(六) 併發處理 

1. 【強制】獲取單例物件要執行緒安全。在單例物件裡面做操作也要保證執行緒安全。 說明：資源驅動類、工具類、單例工廠類都需要注意。 

2. 【強制】執行緒資源必須通過執行緒池提供，不允許在應用中自行顯式建立執行緒。 

說明：使用執行緒池的好處是減少在建立和銷燬執行緒上所花的時間以及系統資源的開銷，解決資

源不足的問題。如果不使用執行緒池，有可能造成系統建立大量同類執行緒而導致消耗完記憶體或者

“過度切換”的問題。 

3. 【強制】SimpleDateFormat 是執行緒不安全的類，一般不要定義為 static 變數，如果定義為 static，必須加鎖，或者使用 DateUtils 工具類。 

正例：注意執行緒安全，使用 DateUtils。亦推薦如下處理： 

private static final ThreadLocal df = new ThreadLocal() {        @Override        protected DateFormat initialValue() {            return new SimpleDateFormat("yyyy-MM-dd");        }    };    說明：如果是 JDK8 的應用，可以使用 instant 代替 Date，Localdatetime 代替 Calendar，

Datetimeformatter 代替 Simpledateformatter，官方給出的解釋：simple beautiful strong 

immutable thread-safe。 

4. 【強制】高併發時，同步呼叫應該去考量鎖的效能損耗。能用無鎖資料結構，就不要用鎖；能 鎖區塊，就不要鎖整個方法體；能用物件鎖，就不要用類鎖。 

5. 【強制】對多個資源、資料庫表、物件同時加鎖時，需要保持一致的加鎖順序，否則可能會造 成死鎖。 

說明：執行緒一需要對錶 A、B、C 依次全部加鎖後才可以進行更新操作，那麼執行緒二的加鎖順序

也必須是 A、B、C，否則可能出現死鎖。 

6. 【強制】併發修改同一記錄時，避免更新丟失，要麼在應用層加鎖，要麼在快取加鎖，要麼在

資料庫層使用樂觀鎖，使用 version 作為更新依據。 

阿里巴巴 JAVA 開發手冊 

 13 / 32 

說明：如果每次訪問衝突概率小於 20%，推薦使用樂觀鎖，否則使用悲觀鎖。樂觀鎖的重試次

數不得小於 3 次。 

7. 【強制】多執行緒並行處理定時任務時，Timer 執行多個 TimeTask 時，只要其中之一沒有捕獲 丟擲的異常，其它任務便會自動終止執行，使用 ScheduledExecutorService 則沒有這個問題。 

8. 【強制】執行緒池不允許使用 Executors 去建立，而是通過 ThreadPoolExecutor 的方式，這樣

的處理方式讓寫的同學更加明確執行緒池的執行規則，規避資源耗盡的風險。 

說明：Executors 各個方法的弊端： 

1）newFixedThreadPool 和 newSingleThreadExecutor: 

  主要問題是堆積的請求處理佇列可能會耗費非常大的記憶體，甚至 OOM。 

2）newCachedThreadPool 和 newScheduledThreadPool: 

  主要問題是執行緒數最大數是 Integer.MAX_VALUE，可能會建立數量非常多的執行緒，甚至 OOM。

9. 【強制】建立執行緒或執行緒池時請指定有意義的執行緒名稱，方便出錯時回溯。 正例： 

public class TimerTaskThread extends Thread {      public TimerTaskThread(){          super.setName("TimerTaskThread"); …  }  10.【推薦】使用 CountDownLatch 進行非同步轉同步操作，每個執行緒退出前必須呼叫 countDown 方

法，執行緒執行程式碼注意 catch 異常，確保 countDown 方法可以執行，避免主執行緒無法執行至

countDown 方法，直到超時才返回結果。 

說明：注意，子執行緒丟擲異常堆疊，不能在主執行緒 try-catch 到。 

11.【推薦】避免 Random 例項被多執行緒使用，雖然共享該例項是執行緒安全的，但會因競爭同一 seed 

導致的效能下降。 

說明：Random 例項包括 java.util.Random 的例項或者 Math.random()例項。 

正例：在 JDK7 之後，可以直接使用 API ThreadLocalRandom，在 JDK7 之前，可以做到每個線

程一個例項。 

12. 【推薦】通過雙重檢查鎖（double-checked locking）（在併發場景）實現延遲初始化的優化 問題隱患(可參考 The "Double-Checked Locking is Broken" Declaration),推薦問題解決方

案中較為簡單一種（適用於 jdk5 及以上版本），將目標屬性宣告為 volatile 型（比如反例

中修改 helper 的屬性宣告為 private volatile Helper helper = null;）； 

反例： 

class Foo {   private Helper helper = null;  public Helper getHelper() {  

阿里巴巴 JAVA 開發手冊 

 14 / 32 

if (helper == null)   synchronized(this) {      if (helper == null)         helper = new Helper();    }      return helper; }  // other functions and members...  

}  13.【參考】volatile 解決多執行緒記憶體不可見問題。對於一寫多讀，是可以解決變數同步問題，

但是如果多寫，同樣無法解決執行緒安全問題。如果想取回 count++資料，使用如下類實現：

AtomicInteger count = new AtomicInteger(); count.addAndGet(1); count++操作如果是

JDK8，推薦使用 LongAdder 物件，比 AtomicLong 效能更好（減少樂觀鎖的重試次數）。 

14.【參考】注意 HashMap 的擴容死鏈，導致 CPU 飆升的問題。 

15.【參考】ThreadLocal無法解決共享物件的更新問題，ThreadLocal物件建議使用static修飾。

這個變數是針對一個執行緒內所有操作共有的，所以設定為靜態變數，所有此類例項共享此靜態

變數 ，也就是說在類第一次被使用時裝載，只分配一塊儲存空間，所有此類的物件(只要是這

個執行緒內定義的)都可以操控這個變數。 

(七) 控制語句 

1. 【強制】在一個 switch 塊內，每個 case 要麼通過 break/return 來終止，要麼註釋說明程式 將繼續執行到哪一個 case 為止；在一個 switch 塊內，都必須包含一個 default 語句並且放在

最後，即使它什麼程式碼也沒有。 

2. 【強制】在 if/else/for/while/do 語句中必須使用大括號，即使只有一行程式碼，避免使用下 面的形式：if (condition) statements; 

3. 【推薦】推薦儘量少用 else， if-else 的方式可以改寫成： 

if(condition){              …             return obj;    }   // 接著寫 else 的業務邏輯程式碼;  說明：如果使用要 if-else if-else 方式表達邏輯，【強制】請勿超過 3 層，超過請使用狀態

設計模式。 

4. 【推薦】除常用方法（如 getXxx/isXxx）等外，不要在條件判斷中執行復雜的語句，以提高 可讀性。 

正例： 

//虛擬碼如下  InputStream stream = file.open(fileName, "w");  

阿里巴巴 JAVA 開發手冊 

 15 / 32 

if (stream != null) {         … }    反例： 

if (file.open(fileName, "w") != null)) {  … }  5. 【推薦】迴圈體中的語句要考量效能，以下操作儘量移至迴圈體外處理，如定義物件、變數、 獲取資料庫連線，進行不必要的 try-catch 操作（這個 try-catch 是否可以移至迴圈體外）。

6. 【推薦】介面入參保護，這種場景常見的是用於做批量操作的介面。 

7. 【參考】方法中需要進行引數校驗的場景： 

 1） 呼叫頻次低的方法。 

 2） 執行時間開銷很大的方法，引數校驗時間幾乎可以忽略不計，但如果因為引數錯誤導致

中間執行回退，或者錯誤，那得不償失。 

 3） 需要極高穩定性和可用性的方法。 

 4） 對外提供的開放介面，不管是 RPC/API/HTTP 介面。 

8. 【參考】方法中不需要引數校驗的場景： 

 1） 極有可能被迴圈呼叫的方法，不建議對引數進行校驗。但在方法說明裡必須註明外部參

數檢查。 

 2） 底層的方法呼叫頻度都比較高，一般不校驗。畢竟是像純淨水過濾的最後一道，引數錯

誤不太可能到底層才會暴露問題。一般 DAO 層與 Service 層都在同一個應用中，部署在同一臺

伺服器中，所以 DAO 的引數校驗，可以省略。 

 3） 被宣告成 private 只會被自己程式碼所呼叫的方法，如果能夠確定呼叫方法的程式碼傳入參

數已經做過檢查或者肯定不會有問題，此時可以不校驗引數。 

(八) 註釋規約 

1. 【強制】類、類屬性、類方法的註釋必須使用 javadoc 規範，使用/**內容*/格式，不得使用 //xxx 方式。 

說明：在 IDE 編輯視窗中，javadoc 方式會提示相關注釋，生成 javadoc 可以正確輸出相應注

釋；在 IDE 中，工程呼叫方法時，不進入方法即可懸浮提示方法、引數、返回值的意義，提高

閱讀效率。 

2. 【強制】所有的抽象方法（包括介面中的方法）必須要用 javadoc 註釋、除了返回值、引數、

異常說明外，還必須指出該方法做什麼事情，實現什麼功能。 

說明：如有實現和呼叫注意事項，請一併說明。 

阿里巴巴 JAVA 開發手冊 

 16 / 32 

3. 【強制】所有的類都必須新增建立者資訊。 

4. 【強制】方法內部單行註釋，在被註釋語句上方另起一行，使用//註釋。方法內部多行註釋使 用/* */註釋，注意與程式碼對齊。 

5. 【強制】所有的列舉型別欄位必須要有註釋，說明每個資料項的用途。 

6. 【推薦】與其“半吊子”英文來註釋，不如用中文註釋把問題說清楚。專有名詞、關鍵字，保 持英文原文即可。 

反例：“TCP 連線超時”解釋成“傳輸控制協議連線超時”，理解反而費腦筋。 

7. 【推薦】程式碼修改的同時，註釋也要進行相應的修改，尤其是引數、返回值、異常、核心邏輯 等的修改。 

說明：程式碼與註釋更新不同步，就像路網與導航軟體更新不同步一樣，如果導航軟體嚴重滯後，

就失去了導航的意義。 

8. 【參考】註釋掉的程式碼儘量要配合說明，而不是簡單的註釋掉。 說明：程式碼被註釋掉有兩種可能性：1）後續會恢復此段程式碼邏輯。2）永久不用。前者如果沒

有備註資訊，難以知曉註釋動機。後者建議直接刪掉（程式碼倉庫儲存了歷史程式碼）。 

9. 【參考】對於註釋的要求：第一、能夠準確反應設計思想和程式碼邏輯；第二、能夠描述業務含 義，使別的程式設計師能夠迅速瞭解到程式碼背後的資訊。完全沒有註釋的大段程式碼對於閱讀者形同

天書，註釋是給自己看的，即使隔很長時間，也能清晰理解當時的思路；註釋也是給繼任者看

的，使其能夠快速接替自己的工作。 

10. 【參考】好的命名、程式碼結構是自解釋的，註釋力求精簡準確、表達到位。避免出現註釋的一

個極端：過多過濫的註釋，程式碼的邏輯一旦修改，修改註釋是相當大的負擔。 

反例： 

// put elephant into fridge  put(elephant, fridge);      方法名 put，加上兩個有意義的變數名 elephant 和 fridge，已經說明了這是在幹什麼，

語義清晰的程式碼不需要額外的註釋。 

11.【參考】特殊註釋標記，請註明標記人與標記時間。注意及時處理這些標記，通過標記掃描，

經常清理此類標記。線上故障有時候就是來源於這些標記處的程式碼。 

 1） 待辦事宜（TODO）:（ 標記人，標記時間，[預計處理時間]） 

   表示需要實現，但目前還未實現的功能。這實際上是一個 javadoc 的標籤，目前的

javadoc 還沒有實現，但已經被廣泛使用。只能應用於類，介面和方法（因為它是一個 javadoc

標籤）。 

阿里巴巴 JAVA 開發手冊 

 17 / 32 

 2） 錯誤，不能工作（FIXME）:（標記人，標記時間，[預計處理時間]） 

   在註釋中用 FIXME 標記某程式碼是錯誤的，而且不能工作，需要及時糾正的情況。 

(九) 其它 

1. 【強制】在使用正規表示式時，利用好其預編譯功能，可以有效加快正則匹配速度。 說明：不要在方法體內定義：Pattern pattern = Pattern.compile(規則); 

2. 【強制】避免用 Apache Beanutils 進行屬性的 copy。 說明：Apache BeanUtils 效能較差，可以使用其他方案比如 Spring BeanUtils, Cglib 

BeanCopier。 

3. 【強制】velocity 呼叫 POJO 類的屬性時，建議直接使用屬性名取值即可，模板引擎會自動按 規範呼叫 POJO 的 getXxx()，如果是 boolean 基本資料型別變數（注意，boolean 命名不需要

加 is 字首），會自動呼叫 isXxx()方法。 

說明：注意如果是 Boolean 包裝類物件，優先呼叫 getXxx()的方法。 

4. 【強制】後臺輸送給頁面的變數必須加$!{var}——中間的感嘆號。 說明：如果 var=null 或者不存在，那麼${var}會直接顯示在頁面上。 

5. 【強制】注意 Math.random() 這個方法返回是 double 型別，注意取值範圍 0≤x<1（能夠取 到零值，注意除零異常），如果想獲取整數型別的隨機數，不要將 x 放大 10 的若干倍然後取

整，直接使用 Random 物件的 nextInt 或者 nextLong 方法。 

6. 【強制】獲取當前毫秒數：System.currentTimeMillis(); 而不是 new Date().getTime(); 說明：如果想獲取更加精確的納秒級時間值，用 System.nanoTime。在 JDK8 中，針對統計時

間等場景，推薦使用 Instant 類。 

7. 【推薦】儘量不要在 vm 中加入變數宣告、邏輯運算子，更不要在 vm 模板中加入任何複雜的邏 輯。 

8. 【推薦】任何資料結構的使用都應限制大小。 說明：這點很難完全做到，但很多次的故障都是因為資料結構自增長，結果造成記憶體被吃光。

9. 【推薦】對於“明確停止使用的程式碼和配置”，如方法、變數、類、配置檔案、動態配置屬性 等要堅決從程式中清理出去，避免造成過多垃圾。清理這類垃圾程式碼是技術氣場，不要有這樣

的觀念：“不做不錯，多做多錯”。 

阿里巴巴 JAVA 開發手冊 

 18 / 32 

二、異常日誌 

(一) 異常處理 

1. 【強制】不要捕獲 Java 類庫中定義的繼承自 RuntimeException 的執行時異常類，如：

IndexOutOfBoundsException / NullPointerException，這類異常由程式設計師預檢查來規避，保

證程式健壯性。 

正例：if(obj != null) {...} 

反例：try { obj.method() } catch(NullPointerException e){…} 

2. 【強制】異常不要用來做流程控制，條件控制，因為異常的處理效率比條件分支低。 

3. 【強制】對大段程式碼進行 try-catch，這是不負責任的表現。catch 時請分清穩定程式碼和非穩 定程式碼，穩定程式碼指的是無論如何不會出錯的程式碼。對於非穩定程式碼的 catch 儘可能進行區分

異常型別，再做對應的異常處理。 

4. 【強制】捕獲異常是為了處理它，不要捕獲了卻什麼都不處理而拋棄之，如果不想處理它，請

將該異常拋給它的呼叫者。最外層的業務使用者，必須處理異常，將其轉化為使用者可以理解的

內容。 

5. 【強制】有 try 塊放到了事務程式碼中，catch 異常後，如果需要回滾事務，一定要注意手動回 滾事務。 

6. 【強制】finally 塊必須對資源物件、流物件進行關閉，有異常也要做 try-catch。 說明：如果 JDK7，可以使用 try-with-resources 方法。 

7. 【強制】不能在 finally 塊中使用 return，finally 塊中的 return 返回後方法結束執行，不 會再執行 try 塊中的 return 語句。 

8. 【強制】捕獲異常與拋異常，必須是完全匹配，或者捕獲異常是拋異常的父類。 說明：如果預期拋的是繡球，實際接到的是鉛球，就會產生意外情況。 

9. 【推薦】方法的返回值可以為 null，不強制返回空集合，或者空物件等，必須新增註釋充分 說明什麼情況下會返回 null 值。呼叫方需要進行 null 判斷防止 NPE 問題。 

說明：本規約明確防止 NPE 是呼叫者的責任。即使被呼叫方法返回空集合或者空物件，對呼叫

者來說，也並非高枕無憂，必須考慮到遠端呼叫失敗，執行時異常等場景返回 null 的情況。 

10.【推薦】防止 NPE，是程式設計師的基本修養，注意 NPE 產生的場景： 

 1） 返回型別為包裝資料型別，有可能是 null，返回 int 值時注意判空。 

阿里巴巴 JAVA 開發手冊 

 19 / 32 

    反例：public int f(){ return Integer 物件}，如果為 null，自動解箱拋 NPE。 

 2） 資料庫的查詢結果可能為 null。 

 3） 集合裡的元素即使 isNotEmpty，取出的資料元素也可能為 null。 

 4） 遠端呼叫返回物件，一律要求進行 NPE 判斷。 

 5） 對於 Session 中獲取的資料，建議 NPE 檢查，避免空指標。 

 6） 級聯呼叫 obj.getA().getB().getC()；一連串呼叫，易產生 NPE。 

11.【推薦】在程式碼中使用“拋異常”還是“返回錯誤碼”，對於公司外的 http/api 開放介面必

須使用“錯誤碼”；而應用內部推薦異常丟擲；跨應用間 RPC 呼叫優先考慮使用 Result 方式，

封裝 isSuccess、“錯誤碼”、“錯誤簡簡訊息”。 

說明：關於 RPC 方法返回方式使用 Result 方式的理由： 

 1）使用拋異常返回方式，呼叫方如果沒有捕獲到就會產生執行時錯誤。 

 2）如果不加棧資訊，只是 new 自定義異常，加入自己的理解的 error message，對於呼叫

端解決問題的幫助不會太多。如果加了棧資訊，在頻繁呼叫出錯的情況下，資料序列化和傳輸

的效能損耗也是問題。 

12.【推薦】定義時區分 unchecked / checked 異常，避免直接使用 RuntimeException 丟擲，更

不允許丟擲 Exception 或者 Throwable，應使用有業務含義的自定義異常。推薦業界已定義過

的自定義異常，如：DaoException / ServiceException 等。 

13.【參考】避免出現重複的程式碼（Don’t Repeat Yourself），即 DRY 原則。 

說明：隨意複製和貼上程式碼，必然會導致程式碼的重複，在以後需要修改時，需要修改所有的副

本，容易遺漏。必要時抽取共性方法，或者抽象公共類，甚至是共用模組。 

正例：一個類中有多個 public 方法，都需要進行數行相同的引數校驗操作，這個時候請抽取： 

private boolean checkParam(DTO dto){...}  (二) 日誌規約 

1. 【強制】應用中不可直接使用日誌系統（Log4j、Logback）中的 API，而應依賴使用日誌框架 SLF4J 中的 API，使用門面模式的日誌框架，有利於維護和各個類的日誌處理方式統一。 

import org.slf4j.Logger;  import org.slf4j.LoggerFactory;  private static final Logger logger = LoggerFactory.getLogger(Abc.class);  2. 【強制】日誌檔案推薦至少儲存 15 天，因為有些異常具備以“周”為頻次發生的特點。 

3. 【強制】應用中的擴充套件日誌（如打點、臨時監控、訪問日誌等）命名方式：

appName_logType_logName.log。logType:日誌型別，推薦分類有 stats/desc/monitor/visit

等；logName:日誌描述。這種命名的好處：通過檔名就可知道日誌檔案屬於什麼應用，什麼

阿里巴巴 JAVA 開發手冊 

 20 / 32 

型別，什麼目的，也有利於歸類查詢。 

正例：mppserver 應用中單獨監控時區轉換異常，如：                   

mppserver_monitor_timeZoneConvert.log 

說明：推薦對日誌進行分類，錯誤日誌和業務日誌儘量分開存放，便於開發人員檢視，也便於

通過日誌對系統進行及時監控。 

4. 【強制】對 trace/debug/info 級別的日誌輸出，必須使用條件輸出形式或者使用佔位符的方 式。 

說明：logger.debug("Processing trade with id: " + id + " symbol: " + symbol); 如果

日誌級別是 warn，上述日誌不會列印，但是會執行字串拼接操作，如果 symbol 是物件，會

執行 toString()方法，浪費了系統資源，執行了上述操作，最終日誌卻沒有列印。 

正例：（條件） 

if (logger.isDebugEnabled()) {    logger.debug("Processing trade with id: " + id + " symbol: " + symbol);   }       正例：（佔位符） 

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);  5. 【強制】避免重複列印日誌，浪費磁碟空間，務必在 log4j.xml 中設定 additivity=false。 正例：  6. 【強制】異常資訊應該包括兩類資訊：案發現場資訊和異常堆疊資訊。如果不處理，那麼往上 拋。 

正例：logger.error(各類引數或者物件 toString + "_" + e.getMessage(), e); 

7. 輸出的 POJO 類必須重寫 toString 方法，否則只輸出此物件的 hashCode 值（地址值），沒啥 參考意義。 

8. 【推薦】可以使用 warn 日誌級別來記錄使用者輸入引數錯誤的情況，避免使用者投訴時，無所適

從。注意日誌輸出的級別，error 級別只記錄系統邏輯出錯、異常、或者重要的錯誤資訊。如

非必要，請不要在此場景打出 error 級別，避免頻繁報警。 

9. 【推薦】謹慎地記錄日誌。生產環境禁止輸出 debug 日誌；有選擇地輸出 info 日誌；如果使 用 warn 來記錄剛上線時的業務行為資訊，一定要注意日誌輸出量的問題，避免把伺服器磁碟

撐爆，並記得及時刪除這些觀察日誌。 

說明：大量地輸出無效日誌，不利於系統效能提升，也不利於快速定位錯誤點。紀錄日誌時請

思考：這些日誌真的有人看嗎？看到這條日誌你能做什麼？能不能給問題排查帶來好處？ 

10.【參考】如果日誌用英文描述不清楚，推薦使用中文註釋。對於中文 UTF-8 的日誌，在 secureCRT

中，set encoding=utf-8；如果中文字元還亂碼，請設定：全域性>預設的會話設定>外觀>字型>

阿里巴巴 JAVA 開發手冊 

 21 / 32 

選擇字符集 gb2312；如果還不行，執行命令：set termencoding=gbk，並且直接使用中文來

進行檢索。 

三、MYSQL 規約 

(一) 建表規約 

1. 【強制】表達是與否概念的欄位，必須使用 is_xxx 的方式命名，資料型別是 unsigned tinyint （ 1 表示是，0 表示否），此規則同樣適用於 odps 建表。 

說明：任何欄位如果為非負數，必須是 unsigned。 

2. 【強制】表名、欄位名必須使用小寫字母或數字；禁止出現數字開頭，禁止兩個下劃線中間只 出現數字。資料庫欄位名的修改代價很大，因為無法進行預釋出，所以欄位名稱需要慎重考慮。 

正例：getter_admin，task_config，level3_name 

反例：GetterAdmin，taskConfig，level_3_name 

3. 【強制】表名不使用複數名詞。 

說明：表名應該僅僅表示表裡面的實體內容，不應該表示實體數量，對應於 DO 類名也是單數

形式，符合表達習慣。 

4. 【強制】禁用保留字，如 desc、range、match、delayed 等，參考官方保留字。 

5. 【強制】唯一索引名為 uk_欄位名；普通索引名則為 idx_欄位名。 說明：uk_ 即 unique key；idx_ 即 index 的簡稱。 

6. 【強制】小數型別為 decimal，禁止使用 float 和 double。 

說明：float 和 double 在儲存的時候，存在精度損失的問題，很可能在值的比較時，得到不

正確的結果。如果儲存的資料範圍超過 decimal 的範圍，建議將資料拆成整數和小數分開儲存。

7. 【強制】如果儲存的字串長度幾乎相等，使用 CHAR 定長字串型別。 

8. 【強制】varchar 是可變長字串，不預先分配儲存空間，長度不要超過 5000，如果儲存長度

大於此值，定義欄位型別為 TEXT，獨立出來一張表，用主鍵來對應，避免影響其它欄位索引

效率。 

9. 【強制】表必備三欄位：id, gmt_create, gmt_modified。 說明：其中 id 必為主鍵，型別為 unsigned bigint、單表時自增、步長為 1；分表時改為從

TDDL Sequence 取值，確保分表之間的全域性唯一。gmt_create, gmt_modified 的型別均為

date_time 型別。 

阿里巴巴 JAVA 開發手冊 

 22 / 32 

10.【推薦】表的命名最好是加上“業務名稱_表的作用”，避免上雲梯後，再與其它業務表關聯

時有混淆。 

正例：tiger_task / tiger_reader / mpp_config 

11.【推薦】庫名與應用名稱儘量一致。 

12.【推薦】如果修改欄位含義或對欄位表示的狀態追加時，需要及時更新欄位註釋。 

13.【推薦】欄位允許適當冗餘，以提高效能，但是必須考慮資料同步的情況。冗餘欄位應遵循：

 1）不是頻繁修改的欄位。 

 2）不是 varchar 超長欄位，更不能是 text 欄位。 

正例：各業務線經常冗餘儲存商品名稱，避免查詢時需要呼叫 IC 服務獲取。 

14.【推薦】單錶行數超過 500 萬行或者單表容量超過 2GB，才推薦進行分庫分表。 

說明：如果預計三年後的資料量根本達不到這個級別，請不要在建立表時就分庫分表。 

反例：某業務三年總資料量才 2 萬行，卻分成 1024 張表，問：你為什麼這麼設計？答：分 1024

張表，不是標配嗎？ 

15.【參考】合適的字元儲存長度，不但節約資料庫表空間、節約索引儲存，更重要的是提升檢索

速度。 

正例：人的年齡用 unsigned tinyint（表示範圍 0-255，人的壽命不會超過 255 歲）；海龜就

必須是 smallint，但如果是太陽的年齡，就必須是 int；如果是所有恆星的年齡都加起來，那

麼就必須使用 bigint。 

(二) 索引規約 

1. 【強制】業務上具有唯一特性的欄位，即使是組合欄位，也必須建成唯一索引。 說明：不要以為唯一索引影響了 insert 速度，這個速度損耗可以忽略，但提高查詢速度是明

顯的；另外，即使在應用層做了非常完善的校驗和控制，只要沒有唯一索引，根據墨菲定律，

必然有髒資料產生。 

2. 【強制】超過三個表禁止 join。需要 join 的欄位，資料型別保持絕對一致；多表關聯查詢時， 保證被關聯的欄位需要有索引。 

說明：即使雙表 join 也要注意表索引、SQL 效能。 

3. 【強制】在 varchar 欄位上建立索引時，必須指定索引長度，沒必要對全欄位建立索引，根據

實際文字區分度決定索引長度。 

說明：索引的長度與區分度是一對矛盾體，一般對字串型別資料，長度為 20 的索引，區分

阿里巴巴 JAVA 開發手冊 

 23 / 32 

度會高達 90%以上，可以使用 count(distinct left(列名, 索引長度))/count(*)的區分度來

確定。 

4. 【強制】頁面搜尋嚴禁左模糊或者全模糊，如果需要請走搜尋引擎來解決。 

說明：索引檔案具有 B-Tree 的最左字首匹配特性，如果左邊的值未確定，那麼無法使用此索

引。 

5. 【推薦】如果有 order by 的場景，請注意利用索引的有序性。order by 最後的欄位是組合索 引的一部分，並且放在索引組合順序的最後，避免出現 file_sort 的情況，影響查詢效能。 

正例：where a=? and b=? order by c; 索引：a_b_c 

反例：索引中有範圍查詢，那麼索引有序性無法利用，如：WHERE a>10 ORDER BY b; 索引 a_b

無法排序。 

6. 【推薦】利用覆蓋索引來進行查詢操作，來避免回表操作。 

說明：如果一本書需要知道第 11 章是什麼標題，會翻開第 11 章對應的那一頁嗎？目錄瀏覽一

下就好，這個目錄就是起到覆蓋索引的作用。 

正例：IDB 能夠建立索引的種類：主鍵索引、唯一索引、普通索引，而覆蓋索引是一種查詢的

一種效果，用 explain 的結果，extra 列會出現：using index. 

7. 【推薦】利用延遲關聯或者子查詢優化超多分頁場景。 說明：MySQL 並不是跳過 offset 行，而是取 offset+N 行，然後返回放棄前 offset 行，返回 N

行，那當 offset 特別大的時候，效率就非常的低下，要麼控制返回的總頁數，要麼對超過特

定閾值的頁數進行 SQL 改寫。 

正例：先快速定位需要獲取的 id 段，然後再關聯：       SELECT a.* FROM 表 1 a, (select id from 表 1 where 條件 LIMIT 100000,20 ) b where a.id=b.id 

8. 【推薦】 SQL 效能優化的目標：至少要達到 range 級別，要求是 ref 級別，如果可以是 consts 最好。 

說明： 

 1）consts 單表中最多隻有一個匹配行（主鍵或者唯一索引），在優化階段即可讀取到資料。 

 2）ref 指的是使用普通的索引。（normal index） 

 3）range 對索引進範圍檢索。 

反例：explain 表的結果，type=index，索引物理檔案全掃描，速度非常慢，這個 index 級別

比較 range 還低，與全表掃描是小巫見大巫。 

9. 【推薦】建組合索引的時候，區分度最高的在最左邊。 正例：如果 where a=? and b=? ，a 列的幾乎接近於唯一值，那麼只需要單建 idx_a 索引即可。 

阿里巴巴 JAVA 開發手冊 

 24 / 32 

說明：存在非等號和等號混合判斷條件時，在建索引時，請把等號條件的列前置。如：where a>? 

and b=? 那麼即使 a 的區分度更高，也必須把 b 放在索引的最前列。 

10.【參考】建立索引時避免有如下極端誤解： 

 1）誤認為一個查詢就需要建一個索引。 

 2）誤認為索引會消耗空間、嚴重拖慢更新和新增速度。 

 3）誤認為唯一索引一律需要在應用層通過“先查後插”方式解決。 

(三) SQL 規約 

1. 【強制】不要使用 count(列名)或 count(常量)來替代 count(*)，count(*)就是 SQL92 定義的 標準統計行數的語法，跟資料庫無關，跟 NULL 和非 NULL 無關。 

說明：count(*)會統計值為 NULL 的行，而 count(列名)不會統計此列為 NULL 值的行。 

2. 【強制】count(distinct col) 計算該列除 NULL 之外的不重複數量。注意 count(distinct col1, col2) 如果其中一列全為 NULL，那麼即使另一列有不同的值，也返回為 0。 

3. 【強制】當某一列的值全是 NULL 時，count(col)的返回結果為 0，但 sum(col)的返回結果為 NULL，因此使用 sum()時需注意 NPE 問題。 

正例：可以使用如下方式來避免 sum 的 NPE 問題：SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM 

table; 

4. 【強制】使用 ISNULL()來判斷是否為 NULL 值。注意：NULL 與任何值的直接比較都為 NULL。 

說明： 

 1） NULL<>NULL 的返回結果是 NULL，不是 false。 

 2） NULL=NULL 的返回結果是 NULL，不是 true。 

 3） NULL<>1 的返回結果是 NULL，而不是 true。 

5. 【強制】在程式碼中寫分頁查詢邏輯時，若 count 為 0 應直接返回，避免執行後面的分頁語句。

6. 【強制】不得使用外來鍵與級聯，一切外來鍵概念必須在應用層解決。 說明：（概念解釋）學生表中的 student_id 是主鍵，那麼成績表中的 student_id 則為外來鍵。

如果更新學生表中的 student_id，同時觸發成績表中的 student_id 更新，則為級聯更新。外

鍵與級聯更新適用於單機低併發，不適合分散式、高併發叢集；級聯更新是強阻塞，存在資料

庫更新風暴的風險；外來鍵影響資料庫的插入速度。 

7. 【強制】禁止使用儲存過程，儲存過程難以除錯和擴充套件，更沒有移植性。 

阿里巴巴 JAVA 開發手冊 

 25 / 32 

8. 【強制】IDB 資料訂正時，刪除和修改記錄時，要先 select，避免出現誤刪除，確認無誤才能 提交執行。 

9. 【推薦】in 操作能避免則避免，若實在避免不了，需要仔細評估 in 後邊的集合元素數量，控 制在 1000 個之內。 

10.【參考】因阿里巴巴全球化需要，所有的字元儲存與表示，均以 utf-8 編碼，那麼字元計數方

法注意： 

說明： 

    SELECT LENGTH("阿里巴巴")； 返回為 12 

    SELECT CHARACTER_LENGTH("阿里巴巴")； 返回為 4 

    如果要使用表情，那麼使用 utfmb4 來進行儲存，注意它與 utf-8 編碼。 

11.【參考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系統和事務日誌資源少，但 TRUNCATE

無事務且不觸發 trigger，有可能造成事故，故不建議在開發程式碼中使用此語句。 

說明：TRUNCATE TABLE 在功能上與不帶 WHERE 子句的 DELETE 語句相同。 

(四) ORM 規約 

1. 【強制】在表查詢中，一律不要使用 * 作為查詢的欄位列表，需要哪些欄位必須明確寫明。 說明：1）增加查詢分析器解析成本。2）增減欄位容易與 resultMap 配置不一致。 

2. 【強制】POJO 類的 boolean 屬性不能加 is，而資料庫欄位必須加 is_，要求在 resultMap 中

進行欄位與屬性之間的對映。 

說明：參見定義 POJO 類以及資料庫欄位定義規定，在 sql.xml 增加對映，是必須的。 

3. 【強制】不要用 resultClass 當返回引數，即使所有類屬性名與資料庫欄位一一對應，也需要 定義；反過來，每一個表也必然有一個與之對應。 

說明：配置對映關係，使欄位與 DO 類解耦，方便維護。 

4. 【強制】xml 配置中引數注意使用：#{}，#param# 不要使用${} 此種方式容易出現 SQL 注入。 

5. 【強制】iBATIS 自帶的 queryForList(String statementName,int start,int size)不推薦使 用。 

說明：其實現方式是在資料庫取到 statementName 對應的 SQL 語句的所有記錄，再通過 subList

取 start,size 的子集合，線上因為這個原因曾經出現過 OOM。 

阿里巴巴 JAVA 開發手冊 

 26 / 32 

正例：在 sqlmap.xml 中引入 #start#, #size# 

Map map = new HashMap();    map.put("start", start);    map.put("size", size);    6. 【強制】不允許直接拿 HashMap 與 HashTable 作為查詢結果集的輸出。 反例：某同學為避免寫一個，直接使用 HashTable 來接收資料庫返回結果，結果

出現日常是把 bigint 轉成 Long 值，而線上由於資料庫版本不一樣，解析成 BigInteger，導

致線上問題。 

7. 【強制】更新資料表記錄時，必須同時更新記錄對應的 gmt_modified 欄位值為當前時間。 

8. 【推薦】不要寫一個大而全的資料更新介面，傳入為 POJO 類，不管是不是自己的目標更新字 段，都進行 update table set c1=value1,c2=value2,c3=value3; 這是不對的。執行 SQL 時，

儘量不要更新無改動的欄位，一是易出錯；二是效率低；三是 binlog 增加儲存。 

9. 【參考】@Transactional 事務不要濫用。事務會影響資料庫的 QPS，另外使用事務的地方需要 考慮各方面的回滾方案，包括快取回滾、搜尋引擎回滾、訊息補償、統計修正等。 

10.【參考】中的 compareValue 是與屬性值對比的常量，一般是數字，表示相等時帶上

此條件；表示不為空且不為 null 時執行；表示不為 null 值時執行。 

四、工程規約 

(一) 應用分層 

1. 【推薦】圖中預設上層依賴於下層，箭頭關係表示可直接依賴，如：開放介面層可以依賴於

Web 層，也可以直接依賴於 Service 層，依此類推： 

阿里巴巴 JAVA 開發手冊 

 27 / 32 

 開放介面層：可直接封裝 Service 介面暴露成 RPC 介面；通過 Web 封裝成 http 介面；閘道器控

制層等。 

 終端顯示層：各個端的模板渲染並執行顯示層。當前主要是 velocity 渲染，JS 渲染，JSP 渲

染，移動端展示層等。 

 Web 層：主要是對訪問控制進行轉發，各類基本引數校驗，或者不復用的業務簡單處理等。 

 Service 層：相對具體的業務邏輯服務層。 

 Manager 層：通用業務處理層，它有如下特徵： 

   1） 對第三方平臺封裝的層，預處理返回結果及轉化異常資訊； 

   2） 對 Service 層通用能力的下沉，如快取方案、中介軟體通用處理； 

   3） 與 DAO 層互動，對 DAO 的業務通用能力的封裝。 

 DAO 層：資料訪問層，與底層 Mysql、Oracle、Hbase、OB 進行資料互動。 

 外部介面或第三方平臺：包括其它部門 RPC 開放介面，基礎平臺，其它公司的 HTTP 介面。 

2. 【參考】（分層異常處理規約）在 DAO 層，產生的異常型別有很多，無法用細粒度異常進行 catch，使用 catch(Exception e)方式，並 throw new DaoException(e)，不需要列印日誌，

因為日誌在 Manager/Service 層一定需要捕獲並打到日誌檔案中去，如果同臺伺服器再打日誌，

浪費效能和儲存。在 Service 層出現異常時，必須記錄日誌資訊到磁碟，儘可能帶上引數資訊，

相當於保護案發現場。如果 Manager 層與 Service 同機部署，日誌方式與 DAO 層處理一致，如

果是單獨部署，則採用與 Service 一致的處理方式。Web 層絕不應該繼續往上拋異常，因為已

經處於頂層，無繼續處理異常的方式，如果意識到這個異常將導致頁面無法正常渲染，那麼就

應該直接跳轉到友好錯誤頁面，儘量加上友好的錯誤提示資訊。開放介面層要將異常處理成錯

誤碼和錯誤資訊方式返回。 

3. 【參考】分層領域模型規約： 

 DO（Data Object）：與資料庫表結構一一對應，通過 DAO 層向上傳輸資料來源物件。 

 DTO（Data Transfer Object）：資料傳輸物件，Service 和 Manager 向外傳輸的物件。 

 BO（Business Object）：業務物件。可以由 Service 層輸出的封裝業務邏輯的物件。 

 QUERY：資料查詢物件，各層接收上層的查詢請求。注：超過 2 個引數的查詢封裝，禁止使

用 Map 類來傳輸。 

 VO（View Object）：顯示層物件，通常是 Web 向模板渲染引擎層傳輸的物件。 

阿里巴巴 JAVA 開發手冊 

 28 / 32 

(二) 二方庫規約 

1. 【強制】定義 GAV 遵從以下規則：  1） GroupID 格式：com.{公司/BU }.業務線.[子業務線]，最多 4 級。 

  說明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress 等 BU 一級；子業務線可選。 

  正例：com.taobao.tddl 或 com.alibaba.sourcing.multilang 

 2） ArtifactID 格式：產品線名-模組名。語義不重複不遺漏，先到倉庫中心去查證一下。 

  正例：tc-client / uic-api / tair-tool 

 3） Version：詳細規定參考下方。 

2. 【強制】二方庫版本號命名方式：主版本號.次版本號.修訂號 

 1） 主版本號：當做了不相容的 API 修改，或者增加了能改變產品方向的新功能。 

 2） 次版本號：當做了向下相容的功能性新增（新增類、介面等）。 

 3） 修訂號：修復 bug，沒有修改方法簽名的功能加強，保持 API 相容性。 

3. 【強制】線上應用不要依賴 SNAPSHOT 版本（安全包除外）；正式釋出的類庫必須使用 RELEASE 版本號升級+1 的方式，且版本號不允許覆蓋升級，必須去中央倉庫進行查證。 

說明：不依賴 SNAPSHOT 版本是保證應用釋出的冪等性。另外，也可以加快編譯時的打包構建。 

4. 【強制】二方庫的新增或升級，保持除功能點之外的其它 jar 包仲裁結果不變。如果有改變， 必須明確評估和驗證，建議進行 dependency:resolve 前後資訊比對，如果仲裁結果完全不一

致，那麼通過 dependency:tree 命令，找出差異點，進行排除 jar 包。 

5. 【強制】二方庫裡可以定義列舉型別，引數可以使用列舉型別，但是介面返回值不允許使用枚 舉型別或者包含列舉型別的 POJO 物件。 

6. 【強制】依賴於一個二方庫群時，必須定義一個統一版本變數，避免版本號不一致。 

說明：依賴 springframework-core,-context,-beans，它們都是同一個版本，可以定義一個

變數來儲存版本：${spring.version}，定義依賴的時候，引用該版本。 

7. 【強制】禁止在子專案的 pom 依賴中出現相同的 GroupId，相同的 ArtifactId，但是不同的 Version。 

說明：在本地除錯時會使用各子專案指定的版本號，但是合併成一個 war，只能有一個版本號

出現在最後的 lib 目錄中。曾經出現過線下除錯是正確的，釋出到線上出故障的先例。 

8. 【推薦】工具類二方庫已經提供的，儘量不要在本應用中程式設計實現。 

 json 操作： fastjson 

阿里巴巴 JAVA 開發手冊 

 29 / 32 

 md5 操作：commons-codec 

 工具集合：Guava 包 

 陣列操作：ArrayUtils（org.apache.commons.lang3.ArrayUtils） 

 集合操作：CollectionUtils(org.apache.commons.collections4.CollectionUtils) 

 除上面以外還有 NumberUtils、DateFormatUtils、DateUtils 等優先使用

org.apache.commons.lang3 這個包下的，不要使用 org.apache.commons.lang 包下面

的。原因是 commons.lang 這個包是從 JDK1.2 開始支援的所以很多 1.5/1.6 的特性是不

支援的，例如：泛型。 

9. 【推薦】所有 pom 檔案中的依賴宣告放在語句塊中，所有版本仲裁放在 語句塊中。 

說明：裡只是宣告版本，並不實現引入，因此子專案需要顯式的宣告

依賴，version和scope都讀取自父pom。而 所有宣告在主pom的

裡的依賴都會自動引入，並預設被所有的子專案繼承。 

10.【推薦】二方庫儘量不要有配置項，最低限度不要再增加配置項。 

11.【參考】為避免應用二方庫的依賴衝突問題，二方庫釋出者應當遵循以下原則： 

1）精簡可控原則。移除一切不必要的 API 和依賴，只包含 Service API、必要的領域模型對

象、Utils 類、常量、列舉等。如果依賴其它二方庫，儘量是 provided 引入，讓二方庫使用

者去依賴具體版本號；無 log 具體實現，只依賴日誌框架。 

2）穩定可追溯原則。每個版本的變化應該被記錄，二方庫由誰維護，原始碼在哪裡，都需要能

方便查到。除非使用者主動升級版本，否則公共二方庫的行為不應該發生變化。 

(三) 伺服器規約 

1. 【推薦】高併發伺服器建議調小 TCP 協議的 time_wait 超時時間。 

說明：作業系統預設 240 秒後，才會關閉處於 time_wait 狀態的連線，在高併發訪問下，服務

器端會因為處於 time_wait 的連線數太多，可能無法建立新的連線，所以需要在伺服器上調小

此等待值。 

正例：在 linux 伺服器上請通過變更/etc/sysctl.conf 檔案去修改該預設值（秒）： 

     net.ipv4.tcp_fin_timeout = 30 

2. 【推薦】調大伺服器所支援的最大檔案控制程式碼數（File Descriptor，簡寫為 fd）。 

說明：主流作業系統的設計是將 TCP/UDP 連線採用與檔案一樣的方式去管理，即一個連線對應

於一個 fd。主流的 linux 伺服器預設所支援最大 fd 數量為 1024，當併發連線數很大時很容易

阿里巴巴 JAVA 開發手冊 

 30 / 32 

因為 fd 不足而出現“open too many files”錯誤，導致新的連線無法建立。 建議將 linux

伺服器所支援的最大控制程式碼數調高數倍（與伺服器的記憶體數量相關）。 3. 【推薦】給 JVM 設定-XX:+HeapDumpOnOutOfMemoryError 引數，讓 JVM 碰到 OOM 場景時輸出 dump 資訊。 

說明：OOM 的發生是有概率的，甚至有規律地相隔數月才出現一例，出現時的現場資訊對查錯

非常有價值。 

4. 【參考】伺服器內部重定向必須使用 forward；外部重定向地址必須使用 URL Broker 生成，

否則因線上採用 HTTPS 協議而導致瀏覽器提示“不安全”。此外，還會帶來 URL 維護不一致的

問題。 

阿里巴巴 JAVA 開發手冊 

 31 / 32 

五、安全規約 

1. 【強制】可被使用者直接訪問的功能必須進行許可權控制校驗。 說明：防止沒有做許可權控制就可隨意訪問、操作別人的資料，比如檢視、修改別人的訂單。 

2. 【強制】使用者敏感資料禁止直接展示，必須對展示資料脫敏。 說明：支付寶中檢視個人手機號碼會顯示成:158****9119，隱藏中間 4 位，防止隱私洩露。 

3. 【強制】使用者輸入的 SQL 引數嚴格使用引數繫結或者 METADATA 欄位值限定，防止 SQL 注入， 禁止字串拼接 SQL 訪問資料庫。 

4. 【強制】使用者請求傳入的任何引數必須做有效性驗證。 說明：忽略引數校驗可能導致： 

 page size 過大導致記憶體溢位 

 惡意 order by 導致資料庫慢查詢 

 正則輸入源串拒絕服務 ReDOS 

 任意重定向 

 SQL 注入 

 Shell 注入 

 反序列化注入 

5. 【強制】禁止向 HTML 頁面輸出未經安全過濾或未正確轉義的使用者資料。 

6. 【強制】表單、AJAX 提交必須執行 CSRF 安全過濾。 說明：CSRF(Cross-site request forgery)跨站請求偽造是一類常見程式設計漏洞。對於存在 CSRF

漏洞的應用/網站，攻擊者可以事先構造好 URL，只要受害者使用者一訪問，後臺便在使用者不知

情情況下對資料庫中使用者引數進行相應修改。 

7. 【強制】URL 外部重定向傳入的目標地址必須執行白名單過濾。 

正例： 

try {         if (com.alibaba.fasttext.sec.url.CheckSafeUrl              .getDefaultInstance().inWhiteList(targetUrl)){                  response.sendRedirect(targetUrl);           }      } catch (IOException e) {             logger.error("Check returnURL error! targetURL=" + targetURL, e);          throw e;      

阿里巴巴 JAVA 開發手冊 

 32 / 32 

8. 【強制】Web 應用必須正確配置 Robots 檔案，非 SEO URL 必須配置為禁止爬蟲訪問。 

User-agent: * Disallow: /  9. 【強制】在使用平臺資源，譬如簡訊、郵件、電話、下單、支付，必須實現正確的防重放限制， 如數量限制、疲勞度控制、驗證碼校驗，避免被濫刷、資損。 

說明：如註冊時傳送驗證碼到手機，如果沒有限制次數和頻率，那麼可以利用此功能騷擾到其

它使用者，並造成簡訊平臺資源浪費。