Хардкод: жесткое кодирование данных

Что такое жесткое кодирование

Термин происходит от английского hard code. Это ситуация, когда входные данные или параметры конфигурации становятся неотъемлемой частью исполняемого кода.

• Фиксация. Значения записаны напрямую в теле функции или класса.
• Отсутствие гибкости. Для изменения параметра требуется редактирование кода.
• Компиляция. В некоторых языках требуется перекомпиляция для внесения правок.
• Деплой. Любое изменение требует повторной выгрузки на сервер.

Примеры хардкода в вебе

В работе веб-студии встречаются различные проявления жесткой привязки данных.

• Пути к файлам. Прямое указание абсолютных путей вместо относительных.
• Тексты. Вшивание текстов контента прямо в HTML шаблоны.
• Ключи API. Хранение секретных ключей доступа в открытом коде.
• Настройки. Параметры подключения к базе данных внутри скрипта.

Риски и недостатки

Использование жесткого кодирования несет серьезные последствия для жизненного цикла проекта.

• Сложность поддержки. Трудно найти и изменить разбросанные по коду значения.
• Безопасность. Секретные данные могут попасть в публичный репозиторий.
• Масштабируемость. Сложно перенести сайт на другой домен или сервер.
• Человеческий фактор. Высокий риск внести ошибку при правке кода.

Когда хардкод допустим

Существуют ситуации, когда жесткая фиксация данных является оправданной практикой.

• Константы. Физические или математические константы, не меняющиеся никогда.
• Статика. Данные, которые гарантированно не потребуют изменения.
• Прототипы. Быстрая проверка гипотез на этапе разработки.
• Производительность. В редких случаях для микрооптимизации критических участков.

Как избежать проблем

Существуют стандартные подходы для вынесения настроек из тела программы.

• Конфигурационные файлы. Вынос настроек в отдельные json или yaml файлы.
• Переменные окружения. Использование env переменных для секретов и путей.
• Админ-панель. Возможность редактирования контента через CMS.
• Константы. Объявление неизменяемых значений в одном месте.