魔术数字 (程序设计)

✍ dations ◷ 2025-11-26 13:22:49 #计算机编程,反模式

程序设计中所谓的魔术数字(magic number)可能有以下含意:

魔术数字可以是指硬编码在代码里的具体数值(如“10”“123”等以数字直接写出的值)。虽然程序作者写的时候自己能了解数值的意义,但对其他程序员而言,甚至制作者本人经过一段时间后,会难以了解这个数值的用途,只能苦笑讽刺“这个数值的意义虽然不懂,不过至少程序能够运行,真是个魔术般的数字”而得名(起源参考平方根倒数速算法)。

因为下述理由,一般认为代码中不应该含有魔术数字。

例1:

price_tax = 1.05 * price

例1是对输入的价格(price)计算含税(price_tax)售价的程序。但税率并不是万年不变,当政府调整税率时,会有修改程序的必要。这里“1.05”就是一种魔术数字,“为什么是1.05”会让人无法马上了解。下面是去掉魔术数字的示例,程序容易了解也容易修正。

例1 (修正):

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

例2:

setColor("text", 0xffffff)

例2是设置以白色显示代码。然而十六进制的色码0xffffff很难直觉看懂是“白色”,故也算是一种魔术数字。下面是一种拿掉魔术数字的方式。

例2 (修正):

white = 0xffffffsetColor("text", white)

像这样,将魔术数字置换成常量或枚举类型是经常用来解决魔术数字问题的手段。由于常量可以赋予易懂的名称,可使帮助阅读者了解数值的意义。当然,在程序初始化部分定义的常量列表不称为魔术数字。

例3:

year = (new Date()).getYear() - 1911;

例3是用来获取今年之民国纪年的代码。然而将“1911”硬编码在代码里并不尽理想,例如程序不易在其他国家使用等。下面是一种拿掉魔术数字的方式。

function getMinguoYear() { return (new Date()).getYear() - 1911; }year = getMinguoYear();

这个示例则使用函数来包装整段计算民国纪年的逻辑,函数内则直接保留数值1911。这样做的好处是在程序中可借由getMinguoYear()这个函数名称更容易了解程序意图,并对未来若需支持其他国家时保留弹性。例如,需要使用日本历时,可只抽换函数部分而不动到程序所有参考年份运算的地方。

另外,在 一些编程语言中,1与0经常直接作为“真”、“假”的意义(布尔值)使用,有时候也不被认为是魔术数字。(但近年的语言多半建议使用与替代。)

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

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

相关

  • 瓦伦·韦弗瓦伦·韦弗(英语:Warren Weaver,1894年7月17日-1978年11月24日)是一位美国数学家,为机器翻译的早期研究者之一,是美国许多科学研究的推动者。划时代的通讯的数学原理(The Mathematic
  • 戴汝为戴汝为(1932年12月31日-),中国控制论与人工智能专家。生于云南昆明。1955年毕业于北京大学数学力学系。中国科学院自动化研究所研究员。1991当选为中国科学院院士(学部委员)。
  • 北路中山北路是台湾台北市重要的南北干道,南接中山南路。中山北路自中华民国行政院起,往北经双连、圆山过基隆河后,经士林、兰雅至天母,全路分为七段。民权东西路口以南属省道台1甲
  • 三锯拟蝗蛙三锯拟蝗蛙(学名:Pseudacris triseriata)是加拿大及美国的一种树蟾。它们分布在魁北克南部至南达科他州,南至堪萨斯州及奥克拉荷马州。三锯拟蝗蛙体型很小,只有40毫米长。它们呈
  • 高岭石高岭土(英语:Kaolinite),又称观音土、白鳝泥、膨土岩、斑脱石、甘土、皂土、陶土、白泥,是一种含铝的硅酸盐矿物,呈白色软泥状,颗粒细腻,状似面粉。其化学成分相当稳定,被誉为“万能
  • 刘宝莱刘宝莱(1941年-),山东人。中华人民共和国政治人物、外交官。
  • 122毫米榴弹炮M1938 (M-30)122毫米榴弹炮M1938 (M-30)是一种苏联生产的121.92毫米榴弹炮。这种武器是20世纪30年代末期由F.F.彼得罗夫(俄语:Фёдор Фёдорович Петров)所领导的团队设
  • 佐尔福斯普林斯 (佛罗里达州)佐尔福斯普林斯(英语:Zolfo Springs),是美国佛罗里达州下属的一座城市。建立于1904年。面积约 为3.9平方公里(约合1.5平方英里)。根据2010年美国人口普查,该市有人口1,972人。论人
  • 刘敏宽刘敏宽(?-?),字伯功,山西平阳府安邑县人,民籍,明朝政治人物。山西乡试第二名,万历五年(1577年)丁丑科会试第七十八名,登三甲第九十二名进士。曾祖刘芳;祖父刘泽;父刘邦柱。母邵氏。
  • 陈云 (乾隆进士)陈云,字远雯,号起溶,顺天府宛平县人。清朝翰林。陈云于乾隆五十八年(1793年)中式癸丑科一甲第二名进士(榜眼)。授翰林院编修。后改吏部员外郎。官至安徽庐州府知府。