Почему магические строки считаются плохой практикой?

Почему магические строки — это плохая практика?

Магические строки — это строковые литералы, которые используются непосредственно в коде без присвоения имени. Например, if (status === 'active') — это магическая строка. Они считаются плохой практикой, потому что ухудшают читаемость, усложняют поддержку и повышают риск ошибок при изменениях.

Основные проблемы

• Читаемость: Строка 'active' не объясняет, что она означает. Другой разработчик может не понять, какие значения допустимы.
• Поддерживаемость: Если значение нужно изменить, придётся искать все вхождения строки в коде. Легко пропустить одно из них, что приведёт к багам.
• Ошибки: Опечатка в магической строке (например, 'actve') не будет обнаружена компилятором или интерпретатором, пока код не выполнится.

Пример плохого кода

function getStatusMessage(status) {
  if (status === 'active') return 'User is active';
  if (status === 'inactive') return 'User is inactive';
  return 'Unknown status';
}

Как исправить

Вынесите строки в константы или перечисления:

const STATUS = {
  ACTIVE: 'active',
  INACTIVE: 'inactive'
};

function getStatusMessage(status) {
  if (status === STATUS.ACTIVE) return 'User is active';
  if (status === STATUS.INACTIVE) return 'User is inactive';
  return 'Unknown status';
}

Теперь код самодокументируем, а изменение значения требует правки только в одном месте.

Вывод

Используйте константы или перечисления вместо магических строк, чтобы сделать код более читаемым, надёжным и лёгким в поддержке. Это особенно важно в больших проектах, где строки могут повторяться десятки раз.