Java命名風格、常數定義和程式碼格式有哪些

命名風格

1、【強制】程式碼中的命名均不能以下劃線或美元符號開始，也不能以以下劃線或美元符號結束。

反例： _name / __name / $name / name_ / name$ / name__

2、【強制】程式碼中的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。

說明：正確的英文拼字和文法可以讓閱讀者易於理解，避免歧義。注意，純拼音命名方式更要避免採用。

正例：renminbi / alibaba / taobao / youku / hangzhou 等國際通用的名稱，可視同英文。

反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變數= 3

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

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

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

4、【強制】方法名、參數名、成員變數、局部變數都統一使用lowerCamelCase 風格，必須遵從駝峰形式。

正例： localValue / getHttpMessage() / inputUserId

5、【強制】常數命名全部大寫，單字間用底線隔開，力求語意表達完整清楚，不要嫌名字長。

正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

反例：MAX_COUNT / EXPIRED_TIME

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

7、【強制】類型與中括號緊鄰相連來表示陣列。

正例：定義整形陣列 int[] arrayDemo;

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

8、【強制】POJO 類別中布林類型變數都不要加 is 前綴，否則部分框架解析會造成序列化錯誤。

說明：在本文 MySQL 規約中的建表約定第一條，表達是與否的值採用 is_xxx的命名方式，所以，需要在設定從 is_xxx 到 xxx 的映射關係。

反例：定義為基本資料型別Boolean isDeleted 的屬性，它的方法也是isDeleted()，RPC 框架在反向解析的時候，「誤以為」對應的屬性名稱是deleted，導致屬性取得不到，進而拋出異常。

9、【強制】包名統一使用小寫，點分隔符號之間有且僅有一個自然語意的英文單字。包名統一使用單數形式，但是類別名稱如果有複數意義，類別名稱可以使用複數形式。

正例：應用程式工具類別套件名稱名稱為com.alibaba.ai.util、類別名稱為MessageUtils（此規則參考spring 的框架結構）

10、【強制】避免在子父類別的成員變數之間、或不同程式碼區塊的局部變數之間採用完全相同的命名，使可讀性降低。

說明：子類別、父類別成員變數名稱相同，即使是public 類型的變數也是能夠透過編譯，而局部變數在同一方法內的不同程式碼區塊中同名也是合法的，但是要避免使用。對於非 setter/getter 的參數名稱也要避免與成員變數名稱相同。

反例：

public class ConfusingName {   public int age;   // 非setter/getter 的參數名稱，不允許與本類別成員變數同名  public void getData(String alibaba) {     if( condition) {       final int money = 531;     // ...     }     for (int i = 0; i < 10; i ) {     // 在同一方法本體中，並不允許與其它程式碼相同的程式命名 final final int money = 615;     // ...     }   } } class Son extends ConfusingName { // 不允許與父類別的成員變數名稱相同public int age; }

11、【強制 #】杜絕完全不規範的縮寫，避免望文不知義。

反例：AbstractClass「縮寫」命名成 AbsClass；condition「縮寫」命名成 condi，此類隨意縮寫嚴重降低了程式碼的可閱讀性。

12、【推薦】為了達到程式碼自解釋的目標，任何自訂程式設計元素在命名時，使用盡量完整的單字組合來表達其意。

正例：在 JDK 中，表達原子更新的類別名稱為：AtomicReferenceFieldUpdater。

反例：int a 的隨意命名方式。

13、【推薦】在常數與變數的命名時，表示類型的名詞放在詞尾，以提升辨識度。

正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

14、【推薦】如果模組、介面、類別、方法使用了設計模式，在命名時需體現出具體模式。

說明：將設計模式體現在名字中，有利於閱讀者快速理解架構設計理念。

正例：

public class OrderFactory;public class LoginProxy;public class ResourceObserver;

15、【推薦】介面類別中的方法和屬性不要加任何修飾符號（public 也不要加），保持程式碼的簡潔性，並加上有效的Javadoc 註解。盡量不要在介面裡定義變量，如果一定要定義變量，肯定是與介面方法相關，並且是整個應用的基礎常數。

正例：介面方法簽章void commit();介面基礎常數String COMPANY = "alibaba";

反例：介面方法定義public abstract void f();

說明：JDK8 中介面允許有預設實現，那麼這個default 方法，就是對所有實作類別都有價值的預設實作。

16、介面和實作類別的命名有兩套規則：

1）【強制】對於Service 和DAO 類，基於SOA 的理念，暴露出來的服務一定是接口，內部的實作類別用

Impl 的後綴與接口區別。

正例：CacheServiceImpl 實作 CacheService 介面。

2) 【推薦】如果是形容能力的介面名稱，取對應的形容詞為介面名（通常–able 的形容詞）。

正例：AbstractTranslator 實作 Translatable 介面。

17、【參考】枚舉類別名稱帶上 Enum 後綴，枚舉成員名稱需要全大寫，單字間用底線隔開。

說明：枚舉其實就是特殊的類，域成員皆為常數，且建構方法被預設強制是私有。

正例：枚舉名字為 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON。

18、【參考】各層命名規約：

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。

常數定義

1、【強制】不允許任何魔法值（即未經預先定義的常數）直接出現在程式碼中。

反例：

String key = "Id#taobao_" tradeId;cache.put(key, value);// 快取get 時，由於在程式碼複製時，漏掉下劃線，導致快取擊穿而出現問題

2、【強制】在long 或Long 賦值時，數值後使用大寫的L，不能是小寫的l，小寫容易跟數字1 混淆，造成誤解。

說明：Long a = 2l; 寫的是數字的 21，還是 Long 型的 2。

3、【推薦】不要使用一個常數類別來維護所有常數，要依常數功能歸類，分開維護。

說明：大而全的常數類，雜亂無章，使用查找功能才能定位到修改的常數，不利於理解和維護。

正例：快取相關常數放在類別 CacheConsts 下；系統配置相關常數放在類別 ConfigConsts 下。

4、【推薦】常數的複用層次有五層：跨應用共享常數、應用程式內共享常數、子工程內共享常數、

套件內共享常數、類別內共享常數。

1) 跨應用程式共享常數：放置在二方函式庫中，通常是 client.jar 中的 constant 目錄下。

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

反例：易懂變數也要統一定義成應用內共享常數，兩位工程師在兩個類別中分別定義了「YES」的變數：

類別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 定義。

5【建議】如果變數值只在一個固定範圍內變化用 enum 型別來定義。

說明：如果存在名稱之外的延伸屬性應使用 enum 類型，下面正例中的數字就是延伸訊息，表示一年中的

第幾個季節。

正例：

public enum SeasonEnum {   SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);   private int seq;   SeasonEnum(int seq) {this.seq = seq;}  public int Seq. return seq;} }

程式碼格式

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。

正例：(涉及1-5 點)

public static void main(String[] args) {// 縮排4 個空格String say = "hello";// 運算符的左右必須有一個空格int flag = 0;// 關鍵字if 與括號之間必須有一個空格，括號內的f 與左括號，0 與右括號不需要空格if (flag == 0) {System .out.println(say); }// 左大括號前加空格且不換行；左大括號後換行if (flag == 1) { System.out.println("world");// 右大括號前換行，右大括號後面有else，不用換行} else {System.out.println("ok");// 在右大括號後直接結束，則必須換行}}

6、【 強制】註解的雙斜線與註解內容之間有且僅有一個空格。

正例：

// 這是範例註釋，請注意在雙斜線之後有一個空格 String param = new String();

以上是Java命名風格、常數定義和程式碼格式有哪些的詳細內容。更多資訊請關注PHP中文網其他相關文章！