1. 程式人生 > >阿裏巴巴Java開發手冊

阿裏巴巴Java開發手冊

阿裏巴巴java開發手冊

一,命名風格

1,(強制)類的命名使用駝峰命名,DO(表名的數據對象),DTO(頁面數據傳輸對象),VO(展示對象),可以以上的結尾,可以不遵守駝峰規則。(POJO是以上的統稱)

2,(強制)抽象類使用Abstract開頭,異常類使用Exception結尾,測試類使用Test結尾,枚舉類使用Enum結尾。

3,(強制)所有的布爾類型的變量,都不加is,否則某些框架會有序列化的錯誤。

4,(強制)包名統一使用小寫,包名使用單數形式。

5,(強制)杜絕不規範的縮寫,比如condition簡寫成condi,降低了可讀性。

6,(強制)盡量達到代碼字解釋目標,不要使用int a這樣的變量名

7,(推薦)如果使用了設計模式,可以將設計模式名稱放到命名中,增加可讀性,比如OrderFactory,ResourceObserver

8,(強制)接口類中的方法,不加任何的修飾符,例如void f();不要public等修飾。

9,(推薦)service/DAO中方法命名規則:獲得單個對象使用get前綴,獲得多個對象使用list前綴,統計方法使用count前綴,插入的方法使用save/insert做前綴,刪除使用remove/delete做前綴,修改使用update做前綴。


二,常量定義

1,(強制)不允許任何未定義的常量出現在代碼中,比如未定義的字符串或者數字,“id_”,999等。

2,(強制)長整型的變量使用大寫L不適用小寫l,避免l和1混淆。比如使用Long a = 2L;不適用Long b = 2l;

3,(推薦)定義變量的類使用五層分開:跨應用共享常量、應用內共享常量、子工程內共享常量、包內共享常量、類內共享常量。

4,(推薦)如果變量值僅在一個範圍內變化,且帶著名稱之外的延伸屬性,定義為枚舉類型。


阿裏巴巴Java開發手冊