阿里巴巴Java開發(fā)規(guī)范手冊 PDF 下載
一、編程規(guī)約
(一)命名風格
1. 【強制】代碼中的命名均不能以下劃線或美元符號開始，也不能以下劃線或美元符號結束。
反例：_name / __name / $Object / name_ / name$ / Object$
2. 【強制】代碼中的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。
說明：正確的英文拼寫和語法可以讓閱讀者易于理解，避免歧義。注意，即使純拼音命名方式
也要避免采用。
正例：alibaba / taobao / youku / hangzhou 等國際通用的名稱，可視同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3
3. 【強制】類名使用 UpperCamelCase 風格，必須遵從駝峰形式，但以下情形例外：DO / BO /
DTO / VO / AO
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【強制】方法名、參數(shù)名、成員變量、局部變量都統(tǒng)一使用 lowerCamelCase 風格，必須遵從
駝峰形式。
正例： localValue / getHttpMessage() / inputUserId
5. 【強制】常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
6. 【強制】抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類
命名以它要測試的類的名稱開始，以 Test 結尾。
7. 【強制】中括號是數(shù)組類型的一部分，數(shù)組定義如下：String[] args;
反例：使用 String args[]的方式來定義。
8. 【強制】POJO 類中布爾類型的變量，都不要加 is，否則部分框架解析會引起序列化錯誤。
反例：定義為基本數(shù)據(jù)類型 Boolean isDeleted；的屬性，它的方法也是 isDeleted()，RPC阿里巴巴 Java 開發(fā)手冊
框架在反向解析的時候，“以為”對應的屬性名稱是 deleted，導致屬性獲取不到，進而拋出異
常。
9. 【強制】包名統(tǒng)一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統(tǒng)一使用
單數(shù)形式，但是類名如果有復數(shù)含義，類名可以使用復數(shù)形式。
正例： 應用工具類包名為 com.alibaba.open.util、類名為 MessageUtils（此規(guī)則參考
spring 的框架結構）
10. 【強制】杜絕完全不規(guī)范的縮寫，避免望文不知義。
反例：AbstractClass“縮寫”命名成 AbsClass；condition“縮寫”命名成 condi，此類隨
意縮寫嚴重降低了代碼的可閱讀性。
11. 【推薦】為了達到代碼自解釋的目標，任何自定義編程元素在命名時，使用盡量完整的單詞
組合來表達其意。
正例：從遠程倉庫拉取代碼的類命名為 PullCodeFromRemoteRepository。
反例：變量 int a; 的隨意命名方式。
12. 【推薦】如果模塊、接口、類、方法使用了設計模式，在命名時體現(xiàn)出具體模式。
說明：將設計模式體現(xiàn)在名字中，有利于閱讀者快速理解架構設計理念。
正例：public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
13. 【推薦】接口類中的方法和屬性不要加任何修飾符號（public 也不要加），保持代碼的簡潔
性，并加上有效的 Javadoc 注釋。盡量不要在接口里定義變量，如果一定要定義變量，肯定是
與接口方法相關，并且是整個應用的基礎常量。
正例：接口方法簽名：void f();
接口基礎常量表示：String COMPANY = "alibaba";
反例：接口方法定義：public abstract void f();
