Java——命名風格

**1. 【強制】代碼中的命名均不能以下劃線或美元符號開始，也不能以下劃線或美元符號結束。**
```text
反例：_name / __name / $Object / name_ / name$ / Object$
```
----
**2. 【強制】代碼中的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。**
說明：正確的英文拼寫和語法可以讓閱讀者易於理解，避免歧義。注意，即使純拼音命名方式
也要避免採用。


```text
正例：alibaba / taobao / youku / hangzhou 等國際通用的名稱，可視同英文。**
反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3
```
----
**3. 【強制】類名使用 UpperCamelCase 風格，必須遵從駝峯形式，但以下情形例外：DO / BO /
DTO / VO / AO**


```text
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
```
----
**4. 【強制】方法名、參數名、成員變量、局部變量都統一使用 lowerCamelCase 風格，必須遵從
駝峯形式。**


```text
正例： localValue / getHttpMessage() / inputUserId
```
----
**5. 【強制】常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。**
```text
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
```
----

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

----

**7. 【強制】中括號是數組類型的一部分，數組定義如下：String[] args;**
```text
反例：使用 String args[]的方式來定義。
```
----

**8. 【強制】POJO 類中布爾類型的變量，都不要加 is，否則部分框架解析會引起序列化錯誤。**
```text
反例：定義爲基本數據類型 Boolean isDeleted；的屬性，它的方法也是 isDeleted()，RPC
框架在反向解析的時候，“以爲”對應的屬性名稱是 deleted，導致屬性獲取不到，進而拋出異
常。
```
----
**9. 【強制】包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用
單數形式，但是類名如果有複數含義，類名可以使用複數形式。**
```text
正例： 應用工具類包名爲 com.alibaba.open.util、類名爲 MessageUtils（此規則參考
spring 的框架結構）
```
----
**10. 【強制】杜絕完全不規範的縮寫，避免望文不知義。**
```text
反例：AbstractClass“縮寫”命名成 AbsClass；condition“縮寫”命名成 condi，此類隨
意縮寫嚴重降低了代碼的可閱讀性。
```
----
**11. 【推薦】爲了達到代碼自解釋的目標，任何自定義編程元素在命名時，使用盡量完整的單詞
組合來表達其意。**
```text
正例：從遠程倉庫拉取代碼的類命名爲 PullCodeFromRemoteRepository。
反例：變量 int a; 的隨意命名方式。
```
----
**12. 【推薦】如果模塊、接口、類、方法使用了設計模式，在命名時體現出具體模式。**
```text
說明：將設計模式體現在名字中，有利於閱讀者快速理解架構設計理念。
正例：public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
```
----
**13. 【推薦】接口類中的方法和屬性不要加任何修飾符號（public 也不要加），保持代碼的簡潔
性，並加上有效的 Javadoc 註釋。儘量不要在接口裏定義變量，如果一定要定義變量，肯定是
與接口方法相關，並且是整個應用的基礎常量。**
```text
正例：接口方法簽名：void f();
 接口基礎常量表示：String COMPANY = "alibaba";
反例：接口方法定義：public abstract void f();
說明：JDK8 中接口允許有默認實現，那麼這個 default 方法，是對所有實現類都有價值的默
認實現。
```
----
**14. 接口和實現類的命名有兩套規則：**
```text
1）【強制】對於 Service 和 DAO 類，基於 SOA 的理念，暴露出來的服務一定是接口，內部
的實現類用 Impl 的後綴與接口區別。
正例：CacheServiceImpl 實現 CacheService 接口。
2）【推薦】如果是形容能力的接口名稱，取對應的形容詞做接口名（通常是–able 的形式）。
正例：AbstractTranslator 實現 Translatable。
```
----
**15. 【參考】枚舉類名建議帶上 Enum 後綴，枚舉成員名稱需要全大寫，單詞間用下劃線隔開。**
```text
說明：枚舉其實就是特殊的常量類，且構造方法被默認強制是私有。
正例：枚舉名字爲 ProcessStatusEnum 的成員名稱：SUCCESS / UNKOWN_REASON。
```
----
**16. 【參考】各層命名規約：**
```text
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。
```