(以下內容,摘自 Alibaba java開發手冊 ,本人只是做一個讀書筆記,與大家分享, 侵權的話,聯繫本人刪除 )
1.1命名風格
1.強制 代碼中的命名均不能與下劃線,或美元符號開始,也不能以下劃線或美元符號結束。
反例 _name _name Sname name_ name$ name__
2.強制 代碼中的命名嚴謹使用拼音與英文混合的方式,更不允許直接使用中文的方式。
說明: 正確的英文拼寫和語法可以讓閱讀者易於理解避免歧義。注意,即使是純拼音的命名方式也要避免採用
正例: alibaba /taobao / youku / hangzhou 等國際通用的名稱,可視同英文
反例:DaZhepromotion[打折],getPingFenByName(【評分】) int 某變量 = 3;
3.強制: 類型使用UppercameCase 風格,但Do /BO/DTO/VO/PO等情形例外。
正例:MarcoPole / UserDo / XmlService / tcpUdpDeal / TaPromotion /Qrcode
反例:macroPole / UserDo /XMLService /TCPUdpDeal /Tapromotion / QRcode
4.強制:方法名、參數名、成員變量、局部變量都統一使用 lowerCameCase 風格 ,必須遵從駝峯形式。
正例:locaValue / getHttpMessage() / inputUserId
5.強制:敞亮命名全部大寫,但此件用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。
正例:MAX_STOCK_COUNT / PRIZE_NUMBER_EVERYDAY
反例:MAX_COUNT / PRIZE_NUMBER
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 中,對某個對象引用的 volatile 字段進行原子更新的類名爲:AtomicRefreenceFieldUpdater。
反例:變量 int a ; 的隨意命名方式。
12.推薦:如果模塊、接口、類、方法使用了設計模式,應在命名是體現出具體模式。
說明:將設計模式體現在名字中,有利於閱讀者快速理解架構設計理念。
正例:public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
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.參考:枚舉類名建議帶上 Enum 後綴,枚舉成員名稱需要大寫,單詞間用下畫線隔開。
說明:枚舉其實就是特殊的常量類,且構造方法被默認強制爲私有。
正例:枚舉名字爲 ProcessstatusEnum 的成員名稱:SUCESS / UNKNOWN_REASON。
16.參考:各層命名規約:
1)Service / DAO 層方法命名規約如下:
- 獲取單個對象的方法用 get 作爲前綴。
- 獲取多個對象的方法用 list 作爲前綴。
- 獲取統計值得方法用 count 作爲前綴。
- 插入的方法用 sava / insert 作爲前綴。
- 刪除的方法用 remove / delete 作爲前綴。
- 修改的方法 update 作爲前綴。
2)領域模型命名規約如下。
- 數據對象:xxxDO, xxx 爲數據表名。
- 數據傳輸對象: xxxDTO, xxx 爲業務領域相關的名稱。
- 展示對象: xxxVO, xxx 一般爲網頁名稱。
- POJO 是 DO / DTO / BO/ VO 的統稱,禁止命名成 xxxPOJO.