【強制】所有編程相關命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束。
反例: _name / __name /Object/name/name / Object$【強制】所有編程相關的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式。
說明: 正確的英文拼寫和語法可以讓閱讀者易於理解,避免歧義。注意, 即使純拼音命名方式
也要避免採用。
反例: DaZhePromotion [打折] / getPingfenByName() [評分] / int 變量 = 3;
正例: ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等國際通用的
名稱,可視爲英文。【強制】類名使用 UpperCamelCase 風格,必須遵從駝峯形式,但以下情形例外:(領域模型
的相關命名) DO / DTO / VO / DAO 等。
正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例: macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion【強制】方法名、參數名、成員變量、局部變量都統一使用 lowerCamelCase 風格,必須遵從
駝峯形式。
正例: localValue / getHttpMessage() / inputUserId【 強制】常量命名全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。
正例: MAX_STOCK_COUNT
反例: MAX_COUNT【強制】抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結尾;測試類命
名以它要測試的類的名稱開始,以 Test 結尾。
如:
AbstractDemo //抽象類
ArithmeticException //運算錯誤異常類
DemoTwoTest//測試類【強制】中括號是數組類型的一部分,數組定義如下: String[] args;
反例: 請勿使用 String args[]的方式來定義【強制】 POJO 類中的任何布爾類型的變量,都不要加 is,否則部分框架解析會引起序列化錯
誤。
反例: 定義爲基本數據類型 boolean isSuccess;的屬性,它的方法也是 isSuccess(), RPC
框架在反向解析的時候, “ 以爲” 對應的屬性名稱是 success,導致屬性獲取不到,進而拋出
異常。【強制】包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用
單數形式,但是類名如果有複數含義,類名可以使用複數形式。
正例: 應用工具類包名爲 com.alibaba.mpp.util、類名爲 MessageUtils (此規則參考 spring
的框架結構)
/—————-over———–/
Java命名規範
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.