Сопровождение и доработка ПО

Рефакторинг существующего кода или переписать с нуля

Рефакторинг существующего кода или переписывание с нуля: чем отличаются подходы, как выбрать и что подготовить собственнику к встрече.

Сохраненный кирпичный свод над работающим офисным проходом; под ним аккуратно проложены новые инженерные линии в одном кабельном лотке.

Рефакторинг существующего кода наводит порядок внутри работающей программы и не меняет того, что она делает для пользователя. Переписывание с нуля заменяет систему целиком и требует заново воспроизвести все, что старая версия уже умела. Собственнику проще решать, если взвешивать риск для работающего бизнеса: красота кода в этом расчете стоит на последнем месте.

Чем рефакторинг отличается от переписывания

Рефакторинг кода: набор небольших правок, после каждой из которых программа ведет себя так же, как раньше. Меняется устройство: имена, структура, повторы, связи между частями. Поведение для пользователя остается прежним, поэтому работу можно вести рядом с обычной жизнью компании.

Переписывание с нуля устроено иначе. Команда строит новую систему параллельно со старой, а затем переносит на нее данные и пользователей. Пока новая версия не догнала старую по возможностям, компания работает либо на двух системах сразу, либо на одной недоделанной.

Когда хватает рефакторинга существующего кода

Рефакторинг подходит, когда система в целом решает задачи бизнеса, а страдает скорость изменений. Каждая новая правка занимает больше времени, чем должна, и нередко ломает соседние места. Такая картина говорит о запутанном устройстве, при этом сама идея продукта остается рабочей.

Рефакторинг и улучшение кода хорошо идут вместе с обычной доработкой. Когда команда правит конкретный модуль под новую задачу, она заодно приводит его в порядок и закрывает проверками. Так порядок появляется там, где бизнес действительно меняется, и отдельной остановки работы не требуется.

Когда продукт после наведения порядка остается в работе, дальше начинается сопровождение программного обеспечения, и оно уже идет на более понятной основе.

Когда переписывание с нуля оправдано

Переписывание имеет смысл, когда проблема сидит в самом основании. Например, если система построена на устаревшей базе, которую уже нельзя поддерживать, или если продукт должен получить совсем другое назначение. В таком случае правки старого кода лишь продлевают ему жизнь.

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

Какие вопросы задать себе до решения

Решение лучше принимать по фактам о системе и о бизнесе. Вот вопросы, на которые собственнику нужно ответить до встречи с разработчиками:

Если на первые два вопроса ответ утвердительный, а мешает в основном скорость изменений, чаще всего достаточно рефакторинга. Если систему никто не понимает и доступы потеряны, сначала нужна диагностика состояния.

  • Система сейчас приносит прибыль или обслуживает ежедневную работу компании?
  • Есть ли человек или команда, которые понимают, как она устроена?
  • Что именно мешает: медленные изменения, частые сбои или невозможность подключить новое?
  • Можно ли остановить развитие продукта на время переписывания?
  • Сохранились ли доступы к коду, базе данных и серверам?

Аудит кода как первый шаг

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

Аудит дает заключение для собственника, карту рисков и план восстановления, если проект остался без разработчика. Из такого плана видно, какие части системы можно оставить, а какие заменить. Если вы столкнулись именно с этой ситуацией, посмотрите материал про передачу проекта другому разработчику: там разобран порядок передачи системы новой команде.

Методы рефакторинга и роль автоматики

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

Автоматический рефакторинг кода берет на себя механическую часть, например массовое переименование или перенос фрагментов. Решение о том, как должна быть устроена система, он не принимает. Поэтому результат автоматики проверяют на тестовой среде так же, как правки, сделанные руками.

Отдельная тема: легаси, то есть унаследованный код без описаний и проверок. Рефакторинг легаси кода начинают с того, что фиксируют текущее поведение системы, и только потом меняют устройство. Иначе нечем доказать, что после правки программа работает как раньше.

Из чего складывается стоимость работ

Стоимость зависит от объема системы, от наличия проверок и описаний, от числа интеграций с другими системами. Чем меньше известно о текущем поведении, тем больше времени уходит на его изучение еще до первой правки.

Переписывание добавляет свои расходы: перенос данных, повторное воспроизведение неписаных правил и период, когда работают две системы. Рефакторинг дробится на короткие отрезки, поэтому объем и порядок работ проще согласовать заранее и пересмотреть по ходу.

Как начинается работа

Компания ведет такие задачи в рамках услуги «сопровождение и доработка программного обеспечения». Проект ведет консультант компании и делает его с командой разработчиков. Работа начинается с заявки на сайте, в ней указывают имя, способ связи, услугу и описание задачи. На заявку отвечают в течение рабочего дня. Первая встреча длится шестьдесят минут и проходит онлайн. Затем идет знакомство с продуктом, при котором получают доступ к коду, базе данных и инфраструктуре, и составляется план работ. Дальше порядок такой: согласование объема и порядка работ; доработка короткими отрезками, в конце каждого видно работающий результат; проверка изменений на тестовой среде и аккуратный выкат; поддержка и развитие продукта.

Что подготовить к первой встрече

Для приостановленного проекта нужны репозиторий, доступ к средам, база данных, список интеграций и текущие задачи.

К этому набору полезно добавить собственное описание ситуации. Материалы для встречи удобно собрать заранее:

  • Описание того, что именно мешает бизнесу сейчас.
  • Перечень процессов компании, которые нельзя останавливать.
  • Имя человека внутри компании, который принимает решения по продукту.

Частые вопросы по услуге

Что такое рефакторинг кода понятным языком?

Это изменение внутреннего устройства программы без изменения ее поведения для пользователя. Цель в том, чтобы код стало проще читать, проверять и дорабатывать. Новые возможности при этом не добавляются.

Какие методы рефакторинга кода применяют?

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

Можно ли сделать автоматический рефакторинг кода?

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

С чего начинать рефакторинг легаси кода?

Сначала изучают, как система работает на практике, и фиксируют ее поведение проверками. Затем код меняют небольшими шагами. Если устройство системы никому не известно, работу начинают с аудита.

Что дает аудит программного кода?

Аудит показывает состояние кода и риски. Для приостановленного проекта он выдает заключение, карту рисков и план восстановления. На этой основе выбирают между рефакторингом и переписыванием.

Как сделать рефакторинг кода в рабочей системе?

Сначала оценивают состояние системы и договариваются об объеме работ. Затем код правят короткими отрезками и проверяют результат на тестовой среде. Чтобы обсудить задачу, оставьте заявку.

Другие статьи раздела