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