(一)命名風格

3. 【強制】類名使用 UpperCamelCase 風格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。

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

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

6. 【強制】抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類 命名以它要測試的類的名稱開始，以 Test 結尾。

7. 【強制】類型與中括號緊挨相連來表示數組。

正例：定義整形數組 int[] arrayDemo;

反例：在 main 參數中，使用 String args[]來定義。

8. 【強制】POJO 類中布爾類型的變量，都不要加 is 前綴，否則部分框架解析會引起序列化錯誤。

反例：定義為基本數據類型 Boolean isDeleted 的屬性，它的方法也是 isDeleted()，RPC 阿裏巴巴 Java 開發手冊 2/38 框架在反向解析的時候，“誤以為”對應的屬性名稱是 deleted，導致屬性獲取不到，進而拋 出異常。

9. 【強制】包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用 單數形式，但是類名如果有復數含義，類名可以使用復數形式。 正例：應用工具類包名為 com.alibaba.ai.util、類名為 MessageUtils（此規則參考 spring 的框架結構）

13. 【推薦】接口類中的方法和屬性不要加任何修飾符號（public 也不要加），保持代碼的簡潔 性，並加上有效的 Javadoc 註釋。盡量不要在接口裏定義變量，如果一定要定義變量，肯定是 與接口方法相關，並且是整個應用的基礎常量。 正例：接口方法簽名 void commit(); 接口基礎常量 String COMPANY = "alibaba"; 反例：接口方法定義 public abstract void f(); 說明：JDK8 中接口允許有默認實現，那麽這個 default 方法，是對所有實現類都有價值的默 認實現。

14. 接口和實現類的命名有兩套規則：

1）【強制】對於 Service 和 DAO 類，基於 SOA 的理念，暴露出來的服務一定是接口，內部 的實現類用 Impl 的後綴與接口區別。 正例：CacheServiceImpl 實現 CacheService 接口。

2）【推薦】如果是形容能力的接口名稱，取對應的形容詞為接口名（通常是–able 的形式）。 正例：AbstractTranslator 實現 Translatable 接口。

15. 【參考】枚舉類名建議帶上 Enum 後綴，枚舉成員名稱需要全大寫，單詞間用下劃線隔開。 說明：枚舉其實就是特殊的類，域成員均為常量，且構造方法被默認強制是私有。 正例：枚舉名字為 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON。

16. 【參考】各層命名規約：

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 為業務領域相關的名稱。

3） 展示對象：xxxVO，xxx 一般為網頁名稱。

4） POJO 是 DO/DTO/BO/VO 的統稱，禁止命名成 xxxPOJO。

(二)常量定義

3. 【推薦】不要使用一個常量類維護所有常量，要按常量功能進行歸類，分開維護。 說明：大而全的常量類，雜亂無章，使用查找功能才能定位到修改的常量，不利於理解和維護。

正例：緩存相關常量放在類 CacheConsts 下；系統配置相關常量放在類 ConfigConsts 下。

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

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

2） 應用內共享常量：放置在一方庫中，通常是子模塊中的 constant 目錄下。

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

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

類 B 中：public static final String YES = "y"; A.YES.equals(B.YES)，預期是 true，但實際返回為 false，導致線上問題。

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

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

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

(三)代碼格式

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

1） 左大括號前不換行。

2） 左大括號後換行。

3） 右大括號前換行。

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

2. 【強制】左小括號和字符之間不出現空格；同樣，右小括號和字符之間也不出現空格；而左大 括號前需要空格。詳見第 5 條下方正例提示。 反例：if (空格 a == b 空格)

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

4. 【強制】任何二目、三目運算符的左右兩邊都需要加一個空格。 說明：運算符包括賦值運算符=、邏輯運算符&&、加減乘除符號等。

5. 【強制】采用 4 個空格縮進，禁止使用 tab 字符。 說明：如果使用 tab 縮進，必須設置 1 個 tab 為 4 個空格。IDEA 設置 tab 為 4 個空格時， 請勿勾選 Use tab character；而在 eclipse 中，必須勾選 insert spaces for tabs。

7. 【強制】單行字符數限制不超過 120 個，超出需要換行，換行時遵循如下原則：

1） 第二行相對第一行縮進 4 個空格，從第三行開始，不再繼續縮進，參考示例。

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

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

4） 方法調用中的多個參數需要換行時，在逗號後進行。

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

8. 【強制】方法參數在定義和傳入時，多個參數逗號後邊必須加空格。 正例：下例中實參的 args1，後邊必須要有一個空格。 method(args1, args2, args3);

9. 【強制】IDE 的 text file encoding 設置為 UTF-8; IDE 中文件的換行符使用 Unix 格式， 不要使用 Windows 格式。

10. 【推薦】單個方法的總行數不超過 80 行。

說明：包括方法簽名、結束右大括號、方法內代碼、註釋、空行、回車及任何不可見字符的總 行數不超過 80 行。

正例：代碼邏輯分清紅花和綠葉，個性和共性，綠葉邏輯單獨出來成為額外方法，使主幹代碼 更加清晰；共性邏輯抽取成為共性方法，便於復用和維護。

12. 【推薦】不同邏輯、不同語義、不同業務的代碼之間插入一個空行分隔開來以提升可讀性。 說明：任何情形，沒有必要插入多個空行進行隔開。

java開發手冊（阿裏巴巴）——編程規約（部分）