什么是神奇数字?
为什么要避免呢?
有没有合适的情况?
什么是神奇数字?
为什么要避免呢?
有没有合适的情况?
当前回答
我总是以不同的方式使用术语“魔数”,作为存储在数据结构中的模糊值,可以作为快速有效性检查进行验证。例如,gzip文件的前三个字节包含0x1f8b08, Java类文件以0xcafebabe开头,等等。
您经常看到在文件格式中嵌入了神奇的数字,因为文件可以相当混乱地四处发送,并丢失关于它们如何创建的任何元数据。然而,魔法数字有时也用于内存中的数据结构,如ioctl()调用。
在处理文件或数据结构之前快速检查这个神奇的数字,可以尽早发现错误,而不是为了宣布输入完全是胡编乱作而进行可能很长的处理。
其他回答
那么返回变量呢?
我发现在实现存储过程时尤其具有挑战性。
想象下一个存储过程(我知道语法错误,只是举个例子):
int procGetIdCompanyByName(string companyName);
如果该公司存在于特定的表中,则返回该公司的Id。否则,返回-1。 不知何故,这是一个神奇的数字。到目前为止,我读到的一些建议说,我真的必须设计这样的东西:
int procGetIdCompanyByName(string companyName, bool existsCompany);
顺便问一下,如果公司不存在,它应该返回什么?它会将existesCompany设为false,但也会返回-1。
Antoher的选择是做两个独立的功能
bool procCompanyExists(string companyName);
int procGetIdCompanyByName(string companyName);
因此第二个存储过程的先决条件是公司存在。
但是我害怕并发,因为在这个系统中,一个公司可以由另一个用户创建。
顺便说一句,最重要的是:你对使用这种相对已知和安全的“神奇数字”来判断某事不成功或某事不存在有什么看法?
我想这是在回答你之前的问题。在编程中,魔数是一个没有解释就出现的嵌入数字常数。如果它出现在两个不同的位置,则可能导致一个实例被更改而另一个实例未更改的情况。出于这两个原因,在使用数值常数的地方之外隔离和定义数值常数是很重要的。
幻数是文件格式或协议交换开头的字符序列。这个数字可以作为一个完整性检查。
例子: 打开任何GIF文件,你会在最开始看到:GIF89。GIF89是一个神奇的数字。
其他程序可以读取文件的前几个字符,并正确识别gif。
危险在于随机二进制数据可能包含这些相同的字符。但这种可能性非常小。
至于协议交换,您可以使用它来快速识别正在传递给您的当前“消息”是否已损坏或无效。
神奇的数字仍然很有用。
魔术数字是在代码中直接使用数字。
例如,如果你有(在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这样的静态分析工具可以检测到代码中使用的神奇数字,并建议进行重构。
值得注意的是,有时您确实希望在代码中使用不可配置的“硬编码”数字。有许多著名的,包括0x5F3759DF,它用于优化的平方根反算法。
在极少数情况下,我发现需要使用这种神奇的数字,我将它们设置为我的代码中的const,并记录为什么使用它们,它们是如何工作的,以及它们来自哪里。