命名風格
-
【強制】代碼中的命名均不能以下劃線或美元符號開始，也不能以下劃線或美元符號結束。
反例：_name / name / / name -
【強制】所有編程相關的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。
說明：正確的英文拼寫和語法可以讓閱讀者易於理解，避免歧義。注意，純拼音命名方式更要避免採用。
正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等國際通用的名稱，可視同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3 -
【強制】類名使用 UpperCamelCase 風格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion 反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion -
【強制】方法名、參數名、成員變量、局部變量都統一使用 lowerCamelCase 風格。
正例： localValue / getHttpMessage() / inputUserId -
【強制】常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。
正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME 反例：MAX_COUNT / EXPIRED_TIME -
【強制】抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類 命名以它要測試的類的名稱開始，以 Test 結尾。
-
【強制】類型與中括號緊挨相連來表示數組。
正例：定義整形數組 int[] arrayDemo; 反例：在 main 參數中，使用 String args[]來定義。 -
【強制】POJO 類中的任何布爾類型的變量，都不要加 is 前綴，否則部分框架解析會引起序列 化錯誤。 說明：在本文 MySQL 規約中的建表約定第一條，表達是與否的值採用 is_xxx 的命名方式，所以，需要在 設置從 is_xxx 到 xxx 的映射關係。
反例：定義爲基本數據類型 Boolean isDeleted 的屬性，它的方法也是 isDeleted()，框架在反向解析的時
候，“誤以爲”對應的屬性名稱是 deleted，導致屬性獲取不到，進而拋出異常。 -
【強制】包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用單數形式，但是類名如果有複數含義，類名可以使用複數形式。
正例：應用工具類包名爲 com.alibaba.ei.kunlun.aap.util、類名爲 MessageUtils（此規則參考 spring 的框架結構） -
【強制】避免在子父類的成員變量之間、或者不同代碼塊的局部變量之間採用完全相同的命名，使可讀性降低。
說明：子類、父類成員變量名相同，即使是 public 類型的變量也是能夠通過編譯，而局部變量在同一方法內的不同代碼塊中同名也是合法的，但是要避免使用。對於非 setter/getter 的參數名稱也要避免與成員變量名稱相同。
反例：
public class ConfusingName {
public int stock;
// 非 setter/getter 的參數名稱，不允許與本類成員變量同名
public void get(String alibaba) {
if (condition) {
final int money = 666;
// ...
}
for (int i = 0; i < 10; i++) {
// 在同一方法體中，不允許與其它代碼塊中的 money 命名相同
final int money = 15978;
// ...
}
}
}
class Son extends ConfusingName {
// 不允許與父類的成員變量名稱相同
public int stock;
}
-
【強制】杜絕完全不規範的縮寫，避免望文不知義。
反例：AbstractClass“縮寫”命名成 AbsClass；condition“縮寫”命名成 condi，此類隨意縮寫嚴重降低了代碼的可閱讀性。 -
【推薦】爲了達到代碼自解釋的目標，任何自定義編程元素在命名時，使用盡量完整的單詞組
合來表達。
正例：在 JDK 中，對某個對象引用的 volatile 字段進行原子更新的類名爲：AtomicReferenceFieldUpdater。
反例：常見的方法內變量爲 int a;的定義方式。 -
【推薦】在常量與變量的命名時，表示類型的名詞放在詞尾，以提升辨識度。
正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD -
【推薦】如果模塊、接口、類、方法使用了設計模式，在命名時需體現出具體模式。
說明：將設計模式體現在名字中，有利於閱讀者快速理解架構設計理念。
正例： public class OrderFactory;
public class LoginProxy;
public class ResourceObserver; -
【推薦】接口類中的方法和屬性不要加任何修飾符號（public 也不要加），保持代碼的簡潔
性，並加上有效的 Javadoc 註釋。儘量不要在接口裏定義變量，如果一定要定義變量，確定
與接口方法相關，並且是整個應用的基礎常量。
正例：接口方法簽名 void commit();
接口基礎常量 String COMPANY = “alibaba”;
反例：接口方法定義 public abstract void f();
說明：JDK8 中接口允許有默認實現，那麼這個 default 方法，是對所有實現類都有價值的默認實現。 -
接口和實現類的命名有兩套規則：
1）【強制】對於 Service 和 DAO 類，基於 SOA 的理念，暴露出來的服務一定是接口，內部的實現類用
Impl 的後綴與接口區別。
正例：CacheServiceImpl 實現 CacheService 接口。
2）【推薦】如果是形容能力的接口名稱，取對應的形容詞爲接口名（通常是–able 的形容詞）。
正例：AbstractTranslator 實現 Translatable 接口。 -
【參考】枚舉類名帶上 Enum 後綴，枚舉成員名稱需要全大寫，單詞間用下劃線隔開。
說明：枚舉其實就是特殊的常量類，且構造方法被默認強制是私有。
正例：枚舉名字爲 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON。 -
【參考】各層命名規約：
A) Service/DAO 層方法命名規約
1） 獲取單個對象的方法用 get 做前綴。
2） 獲取多個對象的方法用 list 做前綴，複數結尾，如：listObjects。
3） 獲取統計值的方法用 count 做前綴。
4） 插入的方法用 save/insert 做前綴。
5） 刪除的方法用 remove/delete 做前綴。
6） 修改的方法用 update 做前綴。
B) 領域模型命名規約
1） 數據對象：xxxDO，xxx 即爲數據表名。
2） 數據傳輸對象：xxxDTO，xxx 爲業務領域相關的名稱