- 【強制】不允許任何魔法值(即未經預先定義的常量)直接出現在代碼中。
反例:
String key = "Id#taobao_" + tradeId;
cache.put(key, value);
- 【強制】long或者Long初始賦值時,使用大寫的L,不能是小寫的l,小寫容易跟數字1混淆,造成誤解。
說明:Long a = 2l;
寫的是數字的21
,還是Long型的2
? - 【推薦】不要使用一個常量類維護所有常量,按常量功能進行歸類,分開維護。
說明:大而全的常量類,非得使用查找功能才能定位到修改的常量,不利於理解和維護。
正例:緩存相關常量放在類CacheConsts下;系統配置相關常量放在類ConfigConsts下。 - 【推薦】常量的複用層次有五層:跨應用共享常量、應用內共享常量、子工程內共享常量、包內共享常量、類內共享常量。
1) 跨應用共享常量:放置在二方庫中,通常是client.jar中的constant目錄下。
2) 應用內共享常量:放置在一方庫中,通常是子模塊中的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定義。
5. 【推薦】如果變量值僅在一個固定範圍內變化用enum類型來定義。 說明:如果存在名稱之外的延伸屬性使用enum類型,下面正例中的數字就是延伸信息,表示一年中的第幾個季節。
正例:
public enum SeasonEnum {
SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
int seq;
SeasonEnum(int seq){
this.seq = seq;
}
}