魔术数字 (程式设计)

用于识别或验证文件内容的数据。

程式设计中,魔术数字(magic number)可能指:

  • 缺乏解释或命名的独特数值。常常在程序中出现多次,并且可以(从规范上而言也应当)被有名字的常量取代。
  • 用于辨识一个档案格式或协定类型的一段常量或字符串,例如UNIX的特征签章。
  • 不易于其他值混淆的值,例如UUID

未命名的具体数值

编辑

魔术数字可以是指写死在程式码里的具体数值(如“10”“123”等以数字直接写出的值)。例如,在下面这个计算含税价格的程序片段中,1.05即是一个典型的魔术数字:

price_tax = 1.05 * price

虽然程式作者写的时候自己能了解数值的意义,但对其他程式员而言,甚至制作者本人经过一段时间后,会难以了解这个数值的用途,只能苦笑讽刺“这个数值的意义虽然不懂,不过至少程式能够执行,真是个魔术般的数字”而得名(起源参考平方根倒数速算法)。

魔术数字带来的常见的负面影响包括:

  • 数值的意义难以了解,影响可读性。
  • 数值需要变动时,可能要改不只一个地方。
  • 当魔术数字是浮点数时,若在不同地方使用精度不同的数值,可能产生难以溯源的误差问题。例如在程序中某处圆周率使用3.14159,另一处又使用3.1415926

因此,一般认为应该用一个带有有意义名称的常量取代魔术数字,例如上述的例子可以改为:

TAX = 0.05
price_tax = (1.0 + TAX) * price

在计算机中以数字表示的其他信息也可能成为魔术数字,例如以十六进制数字表示的RGB格式的颜色:

setColor("text", 0xffffff)

当读到这段代码时,很难第一时间就看懂0xffffff代表白色。如果使用名称清晰的常量,则可以使程序更清晰:

WHITE = 0xffffff
setColor("text", WHITE)

魔术数字也可以指其他非数字的值,例如字符,字符串等等。

但是,并非所有未命名的具体数值都是魔术数字。一般而言,只要数字能让人一眼明白其含义,并且基本没有需要改变的可能,就不会被认为是魔术数字。常见的例子包括:

  • 循环的初始值和步进值,如for (int i = 0; i < max; i += 1)中的01
  • 数学公式中的简单常数,例如一元二次方程判别式公式d = b * b - 4 * a * c中的4

在文件中

编辑

魔术数字也会在文件中使用。在特定文件格式中加入固定数值和固定字符串,然后便可以通过检查文件是否包含这些数据来快速地识别文件格式。

例如:GIF文件开头会包含GIF89a47 49 46 38 39 61)或GIF87a47 49 46 38 37 61)这两种字符串。

参见

编辑