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

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

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

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

如果在生産環境中，大量的請求進來，緩存全部失效，直接請求資料庫，導緻資料庫連接配接過多，查詢效率變低的問題發生，是以看來魔法值确實應該避免出現在代碼中。

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

靜态常量取代魔法值#

像下面這個例子：

Copy

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開發手冊》泰山版

作者： 武培軒

出處：

https://www.cnblogs.com/wupeixuan/p/13071950.html