Магическое число (программирование)

Материал из Википедии — свободной энциклопедии
Перейти к: навигация, поиск

Понятие «Магическое число» в программировании имеет два значения:

Сигнатура данных[править | править вики-текст]

Магическое число, или сигнатура — целочисленная константа, используемая для однозначной идентификации ресурса или данных. Такое число само по себе не несёт никакого смысла, и может вызвать недоумение, встретившись в коде программы без соответствующего контекста или комментария, при этом попытка изменить его на другое, даже близкое по значению, может привести к абсолютно непредсказуемым последствиям. По этой причине подобные числа были иронично названы магическими. В настоящее время это название прочно закрепилось как термин. Например, любой откомпилированный класс языка Java начинается с шестнадцатеричного «магического числа» 0xCAFEBABE. Второй широко известный пример — любой исполняемый файл ОС Microsoft Windows с расширением .exe начинается с последовательности байт 0x4D5A. Менее известным примером является неинициализированный указатель в Microsoft Visual С++ (начиная с 2005 версии Microsoft Visual Studio), который в режиме отладки имеет адрес 0xDEADBEEF.

Плохая практика программирования[править | править вики-текст]

Также «магическими числами» называют плохую практику программирования, когда в исходном тексте встречается числовое значение и неочевидно, что оно означает. Например, такой фрагмент будет плохим:

drawSprite(53, 320, 240);

Человеку, который не является автором программы, трудно сказать, что такое 53, 320 или 240. Но если этот код переписать, всё становится на свои места.

final int SCR_WIDTH = 640;
final int SCR_HEIGHT = 480;
final int SCR_X_CENTER = SCR_WIDTH/2;
final int SCR_Y_CENTER = SCR_HEIGHT/2;
final int SPRITE_CROSSHAIR = 53;

...

drawSprite(SPRITE_CROSSHAIR, SCR_X_CENTER, SCR_Y_CENTER);

Теперь понятно: данная строка выводит в центр экрана спрайт — перекрестие прицела. В большинстве языков программирования все значения, используемые для таких констант, будут вычислены ещё на этапе компиляции и подставлены в места использования значений. Поэтому такое изменение исходного текста не ухудшает быстродействие программы.

Кроме того, магические числа - потенциальный источник ошибок в программе:

  • Если одно и то же магическое число используется в программе более одного раза (или потенциально может использоваться), то его изменение потребует правок каждого вхождения (вместо одной правки значения именованной константы). Если будут исправлены не все вхождения, возникнет как минимум одна ошибка.
  • Как минимум в одном из вхождений магическое число может быть написано с ошибкой изначально, и это довольно сложно обнаружить.
  • Магическое число может зависеть от неявного параметра или другого магического числа. Если эти, не выделенные явно, зависимости не будут удовлетворены, возникнет как минимум одна ошибка.
  • При модификации вхождений одного магического числа можно ошибочно изменить другое, магическое число, независимое, но имеющее то же числовое значение.

Магические числа и кроссплатформенность[править | править вики-текст]

Иногда магические числа вредят кроссплатформенности кода[1]. Дело в том, что в Си в 32- и 64-битных ОС гарантируется размер типов char, short и long long, в то время как размер int, long, size_t и ptrdiff_t может меняться (у первых двух — в зависимости от предпочтений разработчиков компилятора, в последних двух — в зависимости от разрядности целевой системы). В старом или неквалифицированно написанном коде могут встречаться «магические числа», означающие размер какого-либо типа — при переходе на машины с другой разрядностью они могут привести к трудноуловимым ошибкам.

Например:

const size_t NUMBER_OF_ELEMENTS = 10;

long a[NUMBER_OF_ELEMENTS];

memset(a, 0, 10 * 4);                                // неправильно - подразумевается, что long равен 4 байтам, используется магическое число элементов
memset(a, 0, NUMBER_OF_ELEMENTS * 4);                // неправильно - подразумевается, что long равен 4 байтам
memset(a, 0, NUMBER_OF_ELEMENTS * sizeof(long));     // не совсем правильно - дублирование имени типа (если мы его поменяем выше, то придется менять и здесь)
memset(a, 0, NUMBER_OF_ELEMENTS * sizeof(a[0]));     // правильно, но в данном случае можно сделать короче
memset(a, 0, sizeof(a));                             // правильно, оптимально

Числа, которые не являются магическими[править | править вики-текст]

Не все числа требуется переносить в константы. Например, код на Delphi:

for i:=0 to Count-1 do ...

Смысл чисел 0 и 1 понятен, и дальнейшего объяснения не требуется.

См. также[править | править вики-текст]

Примечания[править | править вики-текст]