1. 程式人生 > >命名規範及部分書寫規範----參照阿裏巴巴java開發手冊

命名規範及部分書寫規範----參照阿裏巴巴java開發手冊

實現類 toc tcpudp size 全部 sla 工具類 apr alibaba

只列一些我能看懂的....

1類名使用 UpperCamelCase 風格,必須遵從駝峰形式,但以下情形例外:DO / BO / DTO / VO / AO

  正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

  反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

2方法名、參數名、成員變量、局部變量都統一使用 lowerCamelCase 風格,必須遵從 駝峰形式。

  正例: localValue / getHttpMessage() / inputUserId

3常量命名全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。


  正例:MAX_STOCK_COUNT 反例:MAX_COUNT

4 抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結尾;測試類 命名以它要測試的類的名稱開始,以 Test 結尾

5 中括號是數組類型的一部分,

  數組定義如下:String[] args; 反例:使用 String args[]的方式來定義

6 包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用 單數形式,但是類名如果有復數含義,類名可以使用復數形式。

  正例: 應用工具類包名為 com.alibaba.open.util、類名為 MessageUtils(此規則參考 spring 的框架結構)

7 接口類中的方法和屬性不要加任何修飾符號(public 也不要加),保持代碼的簡潔 性,並加上有效的 Javadoc 註釋。盡量不要在接口裏定義變量,如果一定 要定義變量,肯定是 與接口方法相關,並且是整個應 用的基礎常量。

  正例:接口方法簽名:void f(); 接口基礎常量表示:String COMPANY = "alibaba";

  反例:接口方法定義:public abstract void f();

8接口和實現類的命名有兩套規則:

   1)【強制】對於 Service 和 DAO 類,基於 SOA 的理念,暴露出來的服務一定是接口,內部 的實現類用 Impl 的後綴與接口區別。 正例:       CacheServiceImpl 實現 CacheService 接口。

  2)【推薦】 如果是形容能力的接口名稱,取對應的形容詞做接口名(通常是–able 的形式)。 正例:AbstractTranslator 實現 Translatable。

命名規範及部分書寫規範----參照阿裏巴巴java開發手冊