Программирование методом копирования-вставки

Программирование методом копирования-вставки встречается и среди опытных разработчиков, имеющих библиотеки хорошо протестированных и готовых к применению сниппетов и общих алгоритмов, настраиваемых для конкретных задач^[2].

Вместо создания множества клонированных вариантов обобщённого алгоритма объектно-ориентированное программирование предлагает абстрагировать алгоритм в инкапсулированный класс для повторного использования. Такой класс предоставляет возможность гибкого расширения посредством наследования и перегрузки, экономя усилия программиста, поскольку работать приходится только с одним исходным кодом^[6]. С расширением функциональности увеличиваются и библиотеки, сохраняя обратную совместимость. При исправлении бага во внедрённом алгоритме все продукты, использующие эту библиотеку, автоматически получают исправление.

Ветвление — стандартная практика работы в больших командах разработчиков, позволяющая вести параллельную разработку и сократить цикл вывода на рынок. Классическое ветвление имеет следующие черты:

• Управляется системой контроля версий, поддерживающей ветвление;
• Ветви объединяются по завершении работ.

Программирование методом копировать-вставить — менее формализованная альтернатива классическому ветвлению, часто применяемая, если предполагается существенное расхождение кода в ветвях со временем, например, при выделении нового программного продукта из существующего.

Как способ выделения нового продукта, копипаста даёт следующие преимущества:

• Нет необходимости в регрессионном тестировании оригинального продукта;
• Экономия времени на обеспечение качества;
• Сокращение времени вывода на рынок;
• Нет риска внедрения новых ошибок в уже существующий продукт (важно для сохранения клиентской базы).

Недостатки:

• Если новый и исходный продукт различаются меньше, чем ожидалось, может возникнуть необходимость поддерживать две базы кода (что удваивает издержки) для по сути схожих продуктов. Это приводит к большому объёму рефакторинга и ручному объединению в будущем;
• Две кодовые базы увеличивают время внесения общих изменений, что способно нивелировать выигранное время. В реальности такой подход часто приводит к убыткам.

Ещё одна альтернатива — модульный подход:

• Общий для нескольких продуктов код изначально выносится в библиотеки/модули;
• Использование библиотеки становится основой для нового продукта;
• Для множества производных продуктов такой подход даёт эффект увеличения темпа разработки после второго продукта^[7].

Особенно вредна C&P-практика, ведущая к появлению дублированного кода, выполняющего одну и ту же задачу с вариациями. Каждый экземпляр — это копия предыдущего с небольшими отличиями. В результате:

• Копипаста приводит к разрастанию методов;
• Каждый экземпляр — это отдельный дубликат с уже описанными выше проблемами, но зачастую в большем масштабе (десятки, а иногда сотни дубликатов). Исправление ошибок усложняется^[8];
• В подобном коде тяжело ориентироваться, различия между копиями сложно выявить, что усложняет внесение изменений;
• Процедурное программирование настоятельно не рекомендует используемый здесь подход. Правильнее выносить повторяющуюся логику в функцию или подпрограмму, вызываемую в цикле. Такой подход называют «хорошо декомпозированным кодом», он проще для понимания и расширения^[9];
• Основное эмпирическое правило: «не повторяйся». Дэвид Парнас сформулировал его так: «Копирование и вставка кода — результат ошибки проектирования»^[10].

Пример корректного использования копипасты — шаблон цикла for:

for (int i=0; i!=n; ++i) {}

а также функция на его основе:

void foo(int n) {
    for (int i=0; i!=n; ++i) {
    }
}

Фрагмент цикла можно генерировать сниппетом, определяя тип переменных:

for ($type $loop_var = 0; $loop_var != $stop; ++$loop_var) {
}

Многие программисты дублируют похожие строки (например, вызов функции для двух объектов с похожими именами), потому что быстрее продублировать строку, чем написать новую. Однако вероятность ошибки — особенно в последней строке — не уменьшается^[11], а часто даже возрастает^[12].

При необходимости нескольких правок в строке-копии ошибки встречаются чаще. Например, ниже после дублирования строки изменено присваиваемое значение, но не исправлен индекс массива:

mArray[12] = "a";
mArray[13] = "b";
mArray[14] = "c";
mArray[14] = "d";

Существуют исследования, оправдывающие копирование-вставку как модель взаимодействия — например, язык программирования Subtext^[13]: в этой модели копипаста — основной способ работы и потому не считается антипаттерном.