Java開發(fā) 常量定義

\1. 【強制】不允許任何魔法值（即未經(jīng)預先定義的常量）直接出現(xiàn)在代碼中。

反例：
// 本例中，開發(fā)者 A 定義了緩存的 key，然后開發(fā)者 B 使用緩存時少了下劃線，即 key 是"Id#taobao"+tradeId，導致


出現(xiàn)故障
String key = "Id#taobao_" + tradeId;
cache.put(key, value);

\2. 【強制】在 long 或者 Long 賦值時，數(shù)值后使用大寫字母 L，不能是小寫字母 l，小寫容易跟

數(shù)字混淆，造成誤解。

說明：Long a = 2l; 寫的是數(shù)字的 21，還是 Long 型的 2？

\3. 【推薦】不要使用一個常量類維護所有常量，要按常量功能進行歸類，分開維護。

說明：大而全的常量類，雜亂無章，使用查找功能才能定位到修改的常量，不利于理解，也不利于維護。


正例：緩存相關常量放在類 CacheConsts 下；系統(tǒng)配置相關常量放在類 SystemConfigConsts 下。

\4. 【推薦】常量的復用層次有五層：跨應用共享常量、應用內(nèi)共享常量、子工程內(nèi)共享常量、包內(nèi)共享常量、類內(nèi)共享常量。

? 1） 跨應用共享常量：放置在二方庫中，通常是 client.jar 中的 constant 目錄下。

? 2） 應用內(nèi)共享常量：放置在一方庫中，通常是子模塊中的 constant 目錄下。

反例：易懂變量也要統(tǒng)一定義成應用內(nèi)共享常量，兩位工程師在兩個類中分別定義了“YES”的變量：


    類 A 中：public static final String YES = "yes";
    類 B 中：public static final String YES = "y";
    A.YES.equals(B.YES)，預期是 true，但實際返回為 false，導致線上問題。

? 3） 子工程內(nèi)部共享常量：即在當前子工程的 constant 目錄下。

? 4） 包內(nèi)共享常量：即在當前包下單獨的 constant 目錄下。

? 5） 類內(nèi)共享常量：直接在類內(nèi)部 private static final 定義。

\5. 【推薦】如果變量值僅在一個固定范圍內(nèi)變化用 enum 類型來定義。

說明：如果存在名稱之外的延伸屬性應使用 enum 類型，下面正例中的數(shù)字就是延伸信息，表示一年中的第幾個季節(jié)。


正例：
public enum SeasonEnum {
    SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
    private int seq;
    SeasonEnum(int seq) {
        this.seq = seq;
    }
    public int getSeq() {
        return seq;
    } 
}