什么是神奇数字?为什么它不好?

什么是神奇数字?

为什么要避免呢?

有没有合适的情况?

当前回答

Magic Number是一个硬编码的值，它可能在以后的阶段更改，但因此很难更新。

例如，假设您有一个页面，在“您的订单”概览页面中显示最近50个订单。50在这里是一个神奇的数字，因为它不是通过标准或惯例设置的，它是您根据规范中概述的原因虚构的数字。

现在，你要做的是你在不同的地方有50个-你的SQL脚本(SELECT TOP 50 * FROM orders)，你的网站(你的最后50个订单)，你的订单登录(for (i = 0;I < 50;i++))和可能的许多其他地方。

那么，如果有人决定把50岁改成25岁，会发生什么呢?还是75年?还是153年?现在你必须在所有的地方替换50，你很可能会错过它。Find/Replace可能不起作用，因为50可能用于其他事情，盲目地将50替换为25可能会产生一些其他不良副作用(即你的Session)。Timeout = 50呼叫，也设置为25，用户开始报告太频繁的超时)。

此外，代码可能很难理解，即。"if a < 50那么bla"——如果你在一个复杂的函数中遇到这种情况，其他不熟悉代码的开发人员可能会问自己"WTF是50?? "

这就是为什么最好在1个地方有这样模糊和任意的数字-“const int NumOrdersToDisplay = 50”，因为这使代码更具可读性(“如果< NumOrdersToDisplay”，这也意味着你只需要在1个定义良好的地方更改它。

适用Magic Numbers的地方是通过标准定义的所有内容，即SmtpClient。DefaultPort = 25或TCPPacketSize =任何(不确定是否标准化)。此外，只在一个函数中定义的所有内容都可能是可接受的，但这取决于上下文。

2008-09-06 22:31:42

其他回答

提取一个神奇数字作为常数的另一个优点是可以清楚地记录业务信息。

public class Foo {
    /** 
     * Max age in year to get child rate for airline tickets
     * 
     * The value of the constant is {@value}
     */
    public static final int MAX_AGE_FOR_CHILD_RATE = 2;

    public void computeRate() {
         if (person.getAge() < MAX_AGE_FOR_CHILD_RATE) {
               applyChildRate();
         }
    }
}

2015-06-09 21:38:37

魔术数字是在代码中直接使用数字。

例如，如果你有(在Java中):

public class Foo {
    public void setPassword(String password) {
         // don't do this
         if (password.length() > 7) {
              throw new InvalidArgumentException("password");
         }
    }
}

这应该被重构为:

public class Foo {
    public static final int MAX_PASSWORD_SIZE = 7;

    public void setPassword(String password) {
         if (password.length() > MAX_PASSWORD_SIZE) {
              throw new InvalidArgumentException("password");
         }
    }
}

它提高了代码的可读性，也更容易维护。想象一下我在GUI中设置密码字段大小的情况。如果我使用一个神奇的数字，每当最大大小发生变化时，我必须在两个代码位置进行更改。如果我忘记了一个，就会导致不一致。

JDK中有很多例子，比如Integer, Character和Math类。

PS:像FindBugs和PMD这样的静态分析工具可以检测到代码中使用的神奇数字，并建议进行重构。

2008-09-06 22:46:17

幻数是文件格式或协议交换开头的字符序列。这个数字可以作为一个完整性检查。

例子: 打开任何GIF文件，你会在最开始看到:GIF89。GIF89是一个神奇的数字。

其他程序可以读取文件的前几个字符，并正确识别gif。

危险在于随机二进制数据可能包含这些相同的字符。但这种可能性非常小。

至于协议交换，您可以使用它来快速识别正在传递给您的当前“消息”是否已损坏或无效。

神奇的数字仍然很有用。

2008-09-06 22:27:11

你看过维基百科上关于魔法数字的词条了吗?