什么是神奇数字?
为什么要避免呢?
有没有合适的情况?
什么是神奇数字?
为什么要避免呢?
有没有合适的情况?
当前回答
你看过维基百科上关于魔法数字的词条了吗?
它详细介绍了魔术数字引用的所有方式。下面是关于魔术数字是一种糟糕的编程实践的引用
“魔数”一词也指在源代码中直接使用数字而不作解释的糟糕编程实践。在大多数情况下,这会使程序更难阅读、理解和维护。尽管大多数指南对数字0和1做了例外处理,但在代码中将所有其他数字定义为命名常量是个好主意。
其他回答
幻数是文件格式或协议交换开头的字符序列。这个数字可以作为一个完整性检查。
例子: 打开任何GIF文件,你会在最开始看到:GIF89。GIF89是一个神奇的数字。
其他程序可以读取文件的前几个字符,并正确识别gif。
危险在于随机二进制数据可能包含这些相同的字符。但这种可能性非常小。
至于协议交换,您可以使用它来快速识别正在传递给您的当前“消息”是否已损坏或无效。
神奇的数字仍然很有用。
值得注意的是,有时您确实希望在代码中使用不可配置的“硬编码”数字。有许多著名的,包括0x5F3759DF,它用于优化的平方根反算法。
在极少数情况下,我发现需要使用这种神奇的数字,我将它们设置为我的代码中的const,并记录为什么使用它们,它们是如何工作的,以及它们来自哪里。
那么返回变量呢?
我发现在实现存储过程时尤其具有挑战性。
想象下一个存储过程(我知道语法错误,只是举个例子):
int procGetIdCompanyByName(string companyName);
如果该公司存在于特定的表中,则返回该公司的Id。否则,返回-1。 不知何故,这是一个神奇的数字。到目前为止,我读到的一些建议说,我真的必须设计这样的东西:
int procGetIdCompanyByName(string companyName, bool existsCompany);
顺便问一下,如果公司不存在,它应该返回什么?它会将existesCompany设为false,但也会返回-1。
Antoher的选择是做两个独立的功能
bool procCompanyExists(string companyName);
int procGetIdCompanyByName(string companyName);
因此第二个存储过程的先决条件是公司存在。
但是我害怕并发,因为在这个系统中,一个公司可以由另一个用户创建。
顺便说一句,最重要的是:你对使用这种相对已知和安全的“神奇数字”来判断某事不成功或某事不存在有什么看法?
在编程中,“神奇的数字”是一个值,它应该被赋予一个符号名称,但却被作为文字插入到代码中,通常在多个地方。
它不好的原因与SPOT (Single Point of Truth)好的原因是一样的:如果以后想更改这个常量,就必须遍历代码以找到每个实例。这也很糟糕,因为其他程序员可能不清楚这个数字代表什么,因此出现了“魔术”。
人们有时会进一步使用神奇数字消除,将这些常量移到单独的文件中作为配置。这有时是有帮助的,但也会带来更多的复杂性。
提取一个神奇数字作为常数的另一个优点是可以清楚地记录业务信息。
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();
}
}
}