為什麼阿里巴巴Java開發手冊中不允許魔法值出現在程式碼中？

武培軒發表於2020-06-09
阿里Java

在閱讀《阿里巴巴Java開發手冊》時，發現有一條關於關於常量定義的規約，具體內容如下：

圖中的反例是將資料快取起來，並使用魔法值加鏈路 id 組成 key，這就可能會出現其他開發人員在複製貼上的時候，少複製 _ 的情況發生，這種錯誤很難去檢查到，因為讀取快取不存在，可能會去資料庫讀取，很難察覺到。

如果在生產環境中，大量的請求進來，快取全部失效，直接請求資料庫，導致資料庫連線過多，查詢效率變低的問題發生，因此看來魔法值確實應該避免出現在程式碼中。

另外在 《Clean Code》 和 《重構》 等書中也提到了類似的問題，在程式碼中出現原始形態數字通常來說是壞現象，應該用命名良好的常量類隱藏它。

靜態常量取代魔法值

像下面這個例子：

if (billCount > 75) {
    //todo
} else {
    //todo
}

如果在不瞭解這塊的業務的同事，在讀到這塊程式碼的時候，可能會想，75 是什麼鬼，為啥和這個數比較，背後深藏著什麼祕密嗎？可能只有當時的開發人員記得了，導致程式碼可讀性和可維護性極差。

如果宣告一個常量，來替換該魔法值，可能就會使程式碼的可讀性和可維護性大大增加。

static final Integer BASIC_BILL_COUNT = 75;

還有些魔法表示式，比如：

if (value > 60 && value <= 80 && type = 1) {
    // todo
}

比如這個表示式是表示狀態為正常且專案活躍，就可以定義：

boolean isActiveProject = value > 60 && value <= 80 && type = 1;

這樣是不是可讀性就提高了，一眼就可以看出來這塊程式碼的邏輯。

列舉類取代魔法值

還有一種消除魔法值的方式是使用列舉類代替，下面讓我們舉個例子：

if (eventId == 1) {
    System.out.println("睡覺");
} else if (eventId == 2) {
    System.out.println("吃飯");
} else if (eventId == 3) {
    System.out.println("打豆豆");
}

如上程式碼是針對事件 id 去執行相應的事件，如果事件比較少，大家還可以勉強記住每個 eventId 對應的含義，但是隨著事件 id 的增多，很可能會發生，新來的員工把事件 id 給搞混了，導致執行錯誤的事件，發生 bug。

那麼我們可以使用列舉類來表示相應的事件：

public enum EventEnum {

    /**
     * 睡覺
     */
    SLEEP_EVENT(1, "睡覺"),

    /**
     * 吃飯
     */
    EAT_EVENT(2, "吃飯"),

    /**
     * 打豆豆
     */
    FIGHT_PEA_EVENT(3, "打豆豆");

    private int eventId;
    private String desc;

    EventEnum(int eventId, String desc) {
        this.eventId = eventId;
        this.desc = desc;
    }

    public int getEventId() {
        return eventId;
    }

    public String getDesc() {
        return desc;
    }
}

修改完之後的程式碼如下：

if (eventId == EventEnum.SLEEP_EVENT.getEventId()) {
    System.out.println("睡覺");
} else if (eventId == EventEnum.EAT_EVENT.getEventId()) {
    System.out.println("吃飯");
} else if (eventId == EventEnum.FIGHT_PEA_EVENT.getEventId()) {
    System.out.println("打豆豆");
}

是不是可讀性急劇提升，還不快看看自己程式碼中有沒有這樣的魔法值出現，有的話趕緊改造起來。

還有如果你需要在不同的地點引用同一數值，魔法數會讓你煩惱不已，因為一旦這些數字發生改變，就必須在程式中找到所有的魔法值，並將它們全部修改一遍，這樣就太費時費力了。

其實不只是 Java 不應該在程式碼中使用魔法值，其他語言亦是如此。

總結

本文主要介紹了為什麼不允許在程式碼中出現魔法值以及如何將程式碼中已有的魔法值去除掉。

程式碼可讀性還是比較重要的，你肯定不希望別人在接手你的程式碼的時候，罵到這數字啥意思，這程式碼寫得跟粑粑一樣。

最好的關係就是互相成就，大家的在看、轉發、留言三連就是我創作的最大動力。

參考

《Java開發手冊》泰山版

相關文章