常數定義
1. 【強制】不允許出現任何魔法值 ( 即未經定義的常數 ) 直接出現在程式碼中。
反例: String key =" Id # taobao _" tradeId;
cache . put(key , value);
2. 【強制】 long 或Long 初始賦值時,必須使用大寫的L ,不能是小寫的l ,小寫容易跟數字1 混淆,造成誤解。
說明: Long a = 2 l; 寫的是數字的21,還是Long 型的2?
3. 【推薦】不要用一個常量類維護所有常數,應依常量功能歸類,分開維護。如:快取相關的常數放在類別:CacheConsts 下 ; 系統配置相關的常數放在類別: ConfigConsts 下。
說明:大而全的常數類,非得使用查找功能才能定位到修改的常數,不利於理解和維護。
4. 【建議】常數的複用層次有五層:跨應用共享常數、應用內共享常數、子工程內共享常數、套件內共享常數、類別內共享常數。
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 定義。
5. 【建議】如果變數值只在一個範圍內變化用 Enum 類別。如果還帶有名稱之外的延伸屬性,必須使用 Enum 類,下面正例中的數字就是延伸訊息,表示星期幾。
正例: public Enum { MONDAY( 1 ) , TUESDAY( 2 ) , WEDNESDAY( 3 ) , THURSDAY( 4 ) , FRIDAY(##) , THURSDAY( 4 ) , FRIDAY(##) ,
SATURDAY( 6 ) , SUNDAY( 7 ); }