1. 【強制】不允許任何魔法值(即未經定義的常量)直接出現在代碼中。
反例:String key = "Id\#taobao\_" + tradeId; cache.put(key, value);
1. 【強制】long或者Long初始賦值時,使用大寫的L,不能是小寫的l,小寫容易跟數字1混淆,造成誤解。
說明:Long a = 2l; 寫的是數字的21,還是Long型的2?
1. 【推薦】不要使用一個常量類維護所有常量,按常量功能進行歸類,分開維護。
說明:大而全的常量類,非得使用查找功能才能定位到修改的常量,不利于理解和維護。
正例:緩存相關常量放在類CacheConsts下;系統配置相關常量放在類ConfigConsts下。
1. 【推薦】常量的復用層次有五層:跨應用共享常量、應用內共享常量、子工程內共享常量、包內共享常量、類內共享常量。
1) 跨應用共享常量:放置在二方庫中,通常是client.jar中的constant目錄下。
2) 應用內共享常量:放置在一方庫中,通常是modules中的constant目錄下。
反例:易懂變量也要統一定義成應用內共享常量,兩位攻城師在兩個類中分別定義了表示
“是”的變量:
類A中:public static final String YES = "yes"; 類B中:public static final String YES = "y";
A.YES.equals(B.YES),預期是true,但實際返回為false,導致線上問題。
3) 子工程內部共享常量:即在當前子工程的constant目錄下。
4) 包內共享常量:即在當前包下單獨的constant目錄下。
5) 類內共享常量:直接在類內部private static final定義。
1. 【推薦】如果變量值僅在一個范圍內變化,且帶有名稱之外的延伸屬性,定義為枚舉類。下面正例中的數字就是延伸信息,表示星期幾。
正例:public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}
- 一、編程規約????1
- (一) 命名風格????1
- (二) 常量定義????3
- (三) 代碼格式????4
- (四) OOP規約????6
- (五) 集合處理????9
- (六) 并發處理????12
- (七) 控制語句????14
- (八) 注釋規約????16
- (九) 其它????17
- 二、異常日志????18
- (一) 異常處理????18
- (二) 日志規約????19
- 三、單元測試????21
- 四、安全規約????23
- 五、MySQL數據庫????24
- (一) 建表規約????24
- (二) 索引規約????25
- (三) SQL語句????27
- (四) ORM映射????28
- 六、工程結構????30
- (一) 應用分層????30
- (二) 二方庫依賴????31
- (三) 服務器????32
- 附1:版本歷史????34
- 附2:本手冊專有名詞????35