java 編碼規範 1 命名風格
- 【強制】程式碼中的命名均不能以下劃線或美元符號開始，也不能以下劃線或美元符號結束。反例：_name / __name / $Object / name_ / name$ / Object$
- 【強制】程式碼中的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。
說明：正確的英文拼寫和語法可以讓閱讀者易於理解，避免歧義。注意，即使純拼音命名方式也要避免採用。
正例：alibaba / taobao / youku / hangzhou 等國際通用的名稱，可視同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變數 = 3
- 【強制】類名使用 UpperCamelCase 風格，必須遵從駝峰形式，但以下情形例外：DO / BO /
DTO / VO / AO
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
- 【強制】方法名、引數名、成員變數、區域性變數都統一使用 lowerCamelCase 風格，必須遵從駝峰形式。
正例： localValue / getHttpMessage() / inputUserId
- 【強制】常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。正例：MAX_STOCK_COUNT
反例：MAX_COUNT
- 【強制】抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類命名以它要測試的類的名稱開始，以 Test 結尾。
- 【強制】中括號是陣列型別的一部分，陣列定義如下：String[] args;
反例：使用 String args[]的方式來定義。
- 【強制】POJO 類中布林型別的變數，都不要加 is，否則部分框架解析會引起序列化錯誤。反例：定義為基本資料型別 Boolean isDeleted；的屬性，它的方法也是 isDeleted()，RPC
——禁止用於商業用途，違者必究—— 1
阿里巴巴 Java 開發手冊
框架在反向解析的時候，“以為”對應的屬性名稱是 deleted，導致屬性獲取不到，進而丟擲異常。
- 【強制】包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用單數形式，但是類名如果有複數含義，類名可以使用複數形式。
正例： 應用工具類包名為 com.alibaba.open.util、類名為 MessageUtils（此規則參考 spring 的框架結構）
- 【強制】杜絕完全不規範的縮寫，避免望文不知義。
反例：AbstractClass“縮寫”命名成 AbsClass；condition“縮寫”命名成 condi，此類隨
意縮寫嚴重降低了程式碼的可閱讀性。
- 【推薦】為了達到程式碼自解釋的目標，任何自定義程式設計元素在命名時，使用盡量完整的單詞
組合來表達其意。
正例：從遠端倉庫拉取程式碼的類命名為 PullCodeFromRemoteRepository。
反例：變數 int a; 的隨意命名方式。
- 【推薦】如果模組、介面、類、方法使用了設計模式，在命名時體現出具體模式。
說明：將設計模式體現在名字中，有利於閱讀者快速理解架構設計理念。
正例：public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
- 【推薦】介面類中的方法和屬性不要加任何修飾符號（public 也不要加），保持程式碼的簡潔性，並加上有效的 Javadoc 註釋。儘量不要在接口裡定義變數，如果一定要定義變數，肯定是
與介面方法相關，並且是整個應用的基礎常量。
正例：介面方法簽名：void f();
介面基礎常量表示：String COMPANY = "alibaba";
反例：介面方法定義：public abstract void f();
說明：JDK8 中介面允許有預設實現，那麼這個 default 方法，是對所有實現類都有價值的預設實現。
- 介面和實現類的命名有兩套規則：
1）【強制】對於 Service 和 DAO 類，基於 SOA 的理念，暴露出來的服務一定是介面，內部的實現類用 Impl 的字尾與介面區別。
正例：CacheServiceImpl 實現 CacheService 介面。
2）【推薦】 如果是形容能力的介面名稱，取對應的形容詞做介面名（通常是–able 的形式）。
正例：AbstractTranslator 實現 Translatable。
——禁止用於商業用途，違者必究—— 2 /35
阿里巴巴 Java 開發手冊
- 【參考】列舉類名建議帶上 Enum 字尾，列舉成員名稱需要全大寫，單詞間用下劃線隔開。
說明：列舉其實就是特殊的常量類，且構造方法被預設強制是私有。
正例：列舉名字為 ProcessStatusEnum 的成員名稱：SUCCESS / UNKOWN_REASON。
- 【參考】各層命名規約：
-
- Service/DAO 層方法命名規約
1） 獲取單個物件的方法用 get 做字首。
2） 獲取多個物件的方法用 list 做字首。
3） 獲取統計值的方法用 count 做字首。
4） 插入的方法用 save/insert 做字首。
5） 刪除的方法用 remove/delete 做字首。
6） 修改的方法用 update 做字首。
- 領域模型命名規約
1） 資料物件：xxxDO，xxx 即為資料表名。
2） 資料傳輸物件：xxxDTO，xxx 為業務領域相關的名稱。
3） 展示物件：xxxVO，xxx 一般為網頁名稱。
4） POJO 是 DO/DTO/BO/VO 的統稱，禁止命名成 xxxPOJO。