Чи всі магічні числа створені однаковими?

У недавньому проекті мені потрібно було перетворити з байтів на кілобайт кібібайт . Код був досить простим:

var kBval = byteVal / 1024;

Після написання цього запитання я отримав решту функції, яка працювала і продовжувала роботу.

Але згодом я почав замислюватися, чи щойно я вклав у свій код чарівне число . Частина мене каже, що це було добре, оскільки число є постійною константою і його слід легко зрозуміти. Але інша частина мене вважає, що це було б дуже зрозуміло, якби загорнутись у визначену константу на кшталт BYTES_PER_KBYTE.

Тож чи справді загальновідомі константи є чимось магічним чи ні?

Пов’язані запитання:

Коли число є магічним числом? і чи кожне число в коді вважається "магічним числом"? - подібні, але набагато ширші запитання, ніж те, що я задаю. Моє запитання орієнтоване на відомі постійні числа, які не розглядаються в цих питаннях.

Усунення магічних чисел: коли настав час сказати "ні"? також пов'язаний, але орієнтований на рефакторинг на відміну від того, чи є постійне число магічним числом чи ні.

Не всі магічні числа однакові.

Я думаю, що в цьому випадку ця константа в порядку. Проблема з магічними числами полягає в тому, коли вони магічні, тобто незрозуміло, яке їх походження, чому значення є таким, яке воно є, чи правильне значення чи ні.

Сховатись 1024 за BYTES_PER_KBYTE також означає, що ви не бачите миттєво, правильно чи ні.

Я би сподівався, що хтось одразу дізнається, чому це значення 1024. З іншого боку, якби ви перетворювали байти в мегабайти, я визначив би константу BYTES_PER_MBYTE або подібну, оскільки константа 1,048,576 не така очевидна, що її 1024 ^ 2, або що це навіть правильно.

Те саме стосується значень, які диктуються вимогами або стандартами, які використовуються лише в одному місці. Мені здається, що просто поставити постійне право на місце з коментарем до відповідного джерела було легше розібратися, ніж визначити його в іншому місці та змусити переслідувати обидві частини, наприклад:

// Value must be less than 3.5 volts according to spec blah.
SomeTest = DataSample < 3.50

Я вважаю, що краще, ніж

SomeTest = DataSample < SOME_THRESHOLD_VALUE

Лише при SOME_THRESHOLD_VALUEвикористанні в декількох місцях компроміс стає вартим того, щоб визначити константу, на мою думку.

Я задаю два питання, коли мова йде про магічні числа.

Чи має номер ім’я?

Імена корисні, тому що ми можемо прочитати ім’я та зрозуміти призначення числа, яке знаходиться за ним. Іменування констант може збільшити читабельність, якщо ім'я зрозуміти легше, ніж число, яке воно замінює, і постійне ім'я є стислим.

Зрозуміло, що константи, такі як pi, e, та ін. мають значущі імена. Таке значення, як 1024, може бути, BYTES_PER_KBале я б також очікував, що будь-який розробник буде знати, що означає 1024. Цільова аудиторія для вихідного коду - це професійні програмісти, які повинні мати знання про різні повноваження двох та чому вони використовуються.

Чи використовується в декількох місцях?

Хоча назви - одна міцність констант, інша - повторне використання. Якщо значення, ймовірно, зміниться, його можна змінити в одному місці замість того, щоб шукати його в декількох місцях.

Твоє запитання

У випадку вашого запитання я б використовував число як є.

Ім'я: є ім'я для цього номера, але це нічого насправді корисного. Він не представляє математичну константу або значення, вказане в будь-якому документі про вимоги.

Місцеположення: навіть якщо використовуватись у кількох місцях, воно ніколи не зміниться, не зважаючи на цю перевагу.

Ця цитата

Справа не в кількості, це в магії.

як сказав по Йорг W Миттаг відповідає на це питання досить добре.

Деякі цифри просто не магічні в конкретному контексті. У прикладі, наведеному у запитанні, одиниці виміру були визначені назвами змінних, і операція, що проводилася, була досить зрозумілою.

Отже, 1024це не магічно, оскільки в контексті чітко видно, що це конверсія, яка є відповідною, постійною.

Аналогічно, приклад:

var numDays = numHours / 24; 

однаково ясна і не магічна, тому що добре відомо, що в день є 24 години.

Інші плакати згадували, що перетворення відбувається "очевидно", але я не згоден. Первісне питання, на даний момент часу, включає:

кілобайт кібібайт

Тому я вже знаю, що автор є або був розгублений. Сторінка Вікіпедії додає плутанини:

1000 = KB kilobyte (metric)
1024 = kB kilobyte (JEDEC)
1024 = KiB kibibyte (IEC)

Отже, "Кілобайт" може означати як коефіцієнт 1000 і 1024, з єдиною різницею скорочень є капіталізація значення "k". Крім того, 1024 може означати кілобайт (JEDEC) або кібібайт (IEC). Чому б не зруйнувати всю цю плутанину прямо з постійною зі змістовною назвою? До речі, ця нитка часто використовує "BYTES_PER_KBYTE", і це не менш неоднозначно. KBYTE: це KIBIBYTE чи KILOBYTE? Я вважаю за краще ігнорувати JEDEC і мати BYTES_PER_KILOBYTE = 1000і BYTES_PER_KIBIBYTE = 1024. Більше плутанини більше немає.

Причина, через яку такі люди, як я, та багато інших там, мають "войовничі" (щоб цитувати тут коментатора) думки щодо називання магічних чисел - це все в документі того, що ви маєте намір робити, та усуненні двозначності. І ви насправді вибрали одиницю, що призвело до великої плутанини.

Якщо я бачу:

int BYTES_PER_KIBIBYTE = 1024;  
...  
var kibibytes = bytes / BYTES_PER_KIBIBYTE;  

Тоді відразу стає очевидним, що автор мав намір зробити, і немає двозначності. Я можу перевірити константу за лічені секунди (навіть якщо вона знаходиться в іншому файлі), тому, хоча вона не є «миттєвою», вона достатньо близька до миттєвого.

Зрештою, це може бути очевидним, коли ви пишете це, але воно буде менш очевидним, коли ви повернетесь до нього пізніше, а може бути ще менш очевидним, коли хтось ще його редагує. Щоб зробити постійну, потрібно 10 секунд; це може зайняти півгодини або більше, щоб налагодити проблему з одиницями (код не вискочить на вас і скаже вам, що одиниці помиляються, вам доведеться зробити математику самостійно, щоб зрозуміти це, і ви, ймовірно, будете шукати 10 різних проспектів, перш ніж перевірити одиниці).

Визначення імені як посилання на числове значення говорить про те, що щоразу, коли потрібно інше значення в одному місці, яке використовує це ім'я, воно, ймовірно, буде потрібно в усіх. Він також має тенденцію припускати, що зміна числового значення, присвоєного імені, є законним способом зміни значення. Таке значення може бути корисним, коли воно правдивим, і небезпечним, коли хибним.

Той факт, що два різних місця використовують конкретне буквальне значення (наприклад, 1024), слабко підкаже, що зміни, які спонукають програміста змінити одне, напевно, надихнуть програміста захотіти змінити інших, але це означає набагато слабкіше, ніж застосовано якщо програміст призначив ім'я такій постійній.

Основна небезпека, пов'язана з чимось подібним, #define BYTES_PER_KBYTE 1024полягає в тому, що це може запропонувати тому, хто стикається, printf("File size is %1.1fkB",size*(1.0/BYTES_PER_KBYTE));що безпечним способом змусити код використовувати тисячі байтів було б змінити #defineоператор. Однак така зміна може бути катастрофічною, якщо, наприклад, якийсь інший незв'язаний код отримує розмір об'єкта в Кбайт і використовує цю константу при виділенні для цього буфера.

Можливо, було б розумно використовувати #define BYTES_PER_KBYTE_FOR_USAGE_REPORT 1024і #define BYTES_PER_KBYTE_REPORTED_BY_FNOBULATOR 1024, призначаючи інше ім'я для кожної різної мети, що обслуговується постійною 1024, але це призведе до того, що багато ідентифікаторів будуть визначені та використані точно один раз. Крім того, у багатьох випадках найпростіше зрозуміти, що означає значення, якщо бачить код, де він використовується, і найпростіше зрозуміти, де означає код, якщо бачать значення будь-яких констант, які використовуються в ньому. Якщо числовий літерал використовується лише один раз для певної мети, запис літералу в тому місці, де він використовується, часто дає більш зрозумілий код, ніж присвоєння мітки в одному місці та використання його значення десь в іншому місці.

Я б схилявся до використання лише цього числа, проте, думаю, однієї важливої ​​проблеми не було піднято: те саме число може означати різні речі в різних контекстах, і це може ускладнити рефакторинг.

1024 - це також кількість кіБ на МіБ. Припустимо, ми використовуємо 1024, щоб також представити цей розрахунок десь або в декількох місцях, і тепер нам потрібно змінити його для обчислення GiB. Змінювати константу простіше, ніж глобальна пошук / заміна, коли ви можете випадково змінити неправильну в деяких місцях або пропустити її в інших.

Або це може бути навіть трохи маска, яку запровадив лінивий програміст, яку потрібно оновлювати за один день.

Це трохи надуманий приклад, але в деяких кодових базах це може спричинити проблеми під час рефакторингу чи оновлення нових вимог. У цьому конкретному випадку я б не вважав звичайне число дійсно поганою формою, особливо якщо ви можете вкласти обчислення методом повторного використання, я, мабуть, зробив би це сам, але вважаю константу більш «правильною».

Якщо ви використовуєте іменовані константи, як каже суперкада, важливо врахувати, чи має значення і контекст, і якщо вам потрібно кілька імен.