java編程規約

標籤：rac   ring   cto   複數   service   poj   區分   布爾   枚舉   

一、命名風格

1、代碼中的命名不能以底線和貨幣符號開始和結束。

2、代碼中嚴禁使用拼音和英文混合的方式，更加不能使用中文。

3、類名必須使用駝峰形式（UpperCamelCase），一下例外：BO、DO、DTO。

4、方法名、參數名、成員變數名、局部變數名都統一使用lowerCamelCase。

5、常量名全部大寫，各個單詞之間用 _ 分開，比如：MAX_STOCK_COUNT。

6、抽象類別命名必須以Abstract或者Base開頭，異常類命名以Exception結尾，測試類別以Test結尾。

7、中括弧是數群組類型的一部分，String[] args。

8、POJO中布爾類型的變數都不要加is，否則會引起序列化錯誤。

9、包名一律使用小寫，點分符之間使用有自然語義的單詞，不允許使用複數形式，類名可以使用複數形式。

10、杜絕完全不規範的簡寫，避免望文不知義。

11、如果使用了設計模式，要在類名中體現具體的設計模式，比如：OrderFactory/LoginProxy

12、枚舉類名要以Enum結尾，枚舉統一使用大寫各個單詞以底線分開。

13、各層的命名規約：

A）Service、DAO層方法命名：

1）擷取單個對象以get作為首碼；

2）擷取多個對象以list作為首碼；

3）刪除用remove所為首碼；

4）儲存用save作為首碼；

5）更新用update作為首碼；

B）領域模型命名：

1）資料對象：xxxDO，xxx即為資料表名；

2）資料轉送對象：xxxDTO，xxx為業務領域相關名稱；

3）展示對象;xxxVO，xxx為網頁的名稱；

 

二、常量定義

1、不允許任何魔法值，直接出現在代碼中，比如：“JRXJ”+xxx。

2、long賦初始值時必須用L結尾。

3、不要使用一個常量類維護所有常量，根據功能進行區分，比如緩衝相關的用CacheConstant，系統相關的用ConfigConstant。

4、常量的複用層次：跨應用常量、應用內共用常量、子工程內共用常量、包內共用常量、類內共用常量，

跨應用共用常量：儲存在二方庫中，通常是client jar；

應用內共用常量：儲存在一方庫中，通常在modules的constant目錄下面；

子工程內共用常量：在子工程的constant目錄下面；

包內共用常量：當前包單獨的constant目錄下面；

類內共用常量：直接在類內部 private static final ...

5、如果一個變數在一定的範圍內變化，而且帶有一定的延生屬性，那麼使用枚舉。

 

java編程規約